Skip to main content
GET
/
v1
/
orders
/
bulk
/
{id}
Get response from asynchronous bulk order operation
curl --request GET \
  --url https://api.sandbox.usenash.com/v1/orders/bulk/{id} \
  --header 'Authorization: Bearer <token>'
{
  "status": "SUCCESS",
  "summary": {
    "failedOperations": 1,
    "successfulOperations": 4,
    "totalOperations": 5
  },
  "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"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The ID of the bulk operation

Example:

"act_1234567890"

Response

OK

Bulk Operation Response for Orders.

​
status
enum<string>
required

The status of the bulk operation

Available options:
QUEUED,
IN_PROGRESS,
SUCCESS,
FAILED,
CANCELLED,
SKIPPED,
SCHEDULED
Example:

"SUCCESS"

​
summary
BulkOperationSummary · object
required

The summary of the bulk operation

Example:
{
  "failedOperations": 1,
  "successfulOperations": 4,
  "totalOperations": 5
}
​
results
BulkOperationResult · object[]
required

The results of the bulk operation

Example:
[
  {
    "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"
  }
]