Sign in

v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB
Order

Get response from asynchronous bulk order operation

Retrieve the results of a previously submitted bulk order operation. Returns the status and individual results for each order in the batch.

get/v1/orders/bulk/{id}

Path parameters

idstring required

The ID of the bulk operation

Example:act_1234567890

The ID of the bulk operation

Response

OK

status'QUEUED' | 'IN_PROGRESS' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'SKIPPED' | 'SCHEDULED' required

Status of an activity.

Example response

{
  "summary": {
    "totalOperations": 5,
    "successfulOperations": 4,
    "failedOperations": 1
  },
  "results": [
    {
      "action": "upsert",
      "errorMessage": null,
      "id": "ord_1234567890",
      "status": "success"
    },
    {
      "action": "delete",
      "errorMessage": null,
      "id": "ord_0987654321",
      "status": "success"
    },
    {
      "action": "delete",
      "errorMessage": "order with id or external_id 'ord_fake_does_not_exist' does not exist, error_code=MISSING_RESOURCE",
      "id": "ord_fake_does_not_exist",
      "status": "error"
    }
  ]
}