Automation > Tasks
Commerce APIAutomationTasks

Tasks

Our system represents all long-running processes through the Tasks API. Functions such as file processing or CSV imports/exports are monitored with tasks. A user interface can intermittently fetch a specific task to verify its status and progress. Tasks have the ability to report error messages and may provide a link to the resultant file.

Endpoints

EndpointDescriptionJSON API
shardedTasksGet sharded tasksGET:sharded_tasks.json
tasksGet shop tasksGET:tasks.json
tasksCreateCreate taskPOST:tasks.json
tasksDeleteDelete taskDELETE:tasks.json
tasksModifyModify taskPOST:tasks.json
tasksResultDownload task resultGET:tasks/result.json

Types

Types
ShardedTaskExpandableItems
Task
TaskCreate
TaskModify
TaskTypeParam