Bulk Order Actions
Get Bulk Order Response
API Documentation
Order
- Background
- Order Address Validation (Geocoding)
- POSTCreate Order
- POSTCreate Orders
- POSTCreate or update order by external identifier
- PATCHUpdate order
- GETGet order
- POSTCreate Quote
- GETGet Order Documents
- POSTSelect Quote
- POSTRefresh order quotes
- POSTAutodispatch Order
- POSTAdd Custom Event to Order
- DELArchive order
- Bulk Order Actions
- Delivery Windows & Capacity
Dispatch Strategies
Notifications
Store Locations & Zones
- POSTCreate store location
- PATCHUpdate Store Location
- GETGet Store Location
- GETGet Store Locations
- GETGet store location by external identifier
- DELDelete store location
- GETGet store locations that cover specified location (latitude & longitude, city_zipcode)
- POSTCreate a zone
- PATCHUpdate a zone
- GETGet zone
- GETGet zones
- GETGet zone by external identifier
- GETGet zones that cover specified location (latitude & longitude, city_zipcode)
Jobs
- Background
- Package Requirements
- POSTCreate Job
- POSTCreate or Update Job by External Identifier
- PATCHUpdate Job
- GETGet Job
- GETGet Job by External Identifier
- POSTSelect Quote
- POSTReassign a Task in a Job
- POSTRefresh Quotes
- POSTAutodispatch Job
- POSTAutodispatch Job by External Identifier
- POSTCancel Job
- POSTCancel Job by External Identifier
- POSTCreate Delivery Incident
- GETGet Refund Requests
- GETGet Refund Request
Batch Jobs
Providers
Miscellaneous
Bulk Order Actions
Get Bulk Order Response
Get the response from an asynchronous bulk order operation.
GET
/
v1
/
orders
/
bulk
/
{id}
curl --request GET \
--url https://api.sandbox.usenash.com/v1/orders/bulk/{id}
{
"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"
}
]
}
Path Parameters
The ID of the bulk operation
Response
200
application/json
OK
Bulk Operation Response for Orders.
The status of the bulk operation
Available options:
QUEUED
, IN_PROGRESS
, SUCCESS
, FAILED
, CANCELLED
, SKIPPED
, SCHEDULED
The summary of the bulk operation
The results of the bulk operation
The ID of the order.
The status of the bulk operation
Available options:
success
, error
The action of the bulk operation
Available options:
create
, upsert
, update
, delete
The error message of the bulk operation (will be populated with error message if the operation failed)
curl --request GET \
--url https://api.sandbox.usenash.com/v1/orders/bulk/{id}
{
"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"
}
]
}