Order Actions
This endpoint supports performing actions on multiple orders at once
Request
POST /v1.0/accounts/{account-uuid}/orders/actions
account-uuidis a 22-character identifier for the account
Authorization
Authorization header is required for this endpoint. See Authorization Tokens for details about auth tokens.
Headers
N/A
Query Parameters
| Parameter | Required | More Info |
|---|---|---|
validate-only |
no | Sending this parameter (with no value) will only validate the call |
Body
A JSON object representing a list of order UUIDs, and the action to perform
{
"statusAction": "<action>",
"orderUUIDs": [
"..."
]
}
Warning
All orders specified in the list must be for the specified account UUID in the URL.
Allowed actions:
putOnHold
revertToPending
processManually
cancel
delay
ship
Response
| Response | Status Code | More Information |
|---|---|---|
| Success | 200 |
If the patch operation was successful |
| Not Found | 404 |
Survey or item does not exist with the provided UUID |
| Unauthorized | 401 |
If user is not authorized for the requested survey |
| Internal Server Error | 500 |
Unknown error |
Headers
N/A
Body
N/A
Note
It is recommended that you wait 1000 ms before performing a get request to retrive updated order objects. This is the time it will usually take for Elasticsearch to reflect the update