Task API

The Task API provides a standardized way to manage and track long-running or background operations in the Marketplace Platform.

A task represents an operation that may take some time, has progress, task logs, and a result. With this API, you can:

• Create a new task, for example, to start a buyer transfer.

• Update progress, ETA, and parameters within a task. Only the owner service or extension can update a task.

• Get task results, which may include a JSON result or redirect to a resource if the result is a file.

• Transition the task status to queued, processing, completed, rescheduled, or failed.

• Get detailed logs containing additional information regarding task execution.

Core Concepts

The Task API is built around the following core resources:

• Task - Represents the state of an asynchronous, usually long-running operation.

• Task log - Represents additional information regarding the execution of the task.

Collections

The API is organized into collections. Refer to the following capability matrix to see which roles are authorized to perform specific operations within each collection:

Tasks

Capability	Service	Client	Vendor	Operations
List tasks	✅	✅	✅	✅
Get a specific task	✅	✅	✅	✅
Create task	✅	❌	❌	❌
Get a task result	✅	✅	✅	✅

Task log

Capability	Services	Client	Vendor	Operations
List tasks	✅	❌	❌	✅