Start handling order

Change the status of an order to indicate that is is in handling.

Expect a status 204 response with no content in case of a successful request.

The Change order workflow status resource is needed to use this API request. This is included in OMS - Full access and IntegrationProfile - Fulfillment Oms, among other default roles available in the Admin. Learn more about the License manager roles and resources.


orderIdstringOrder ID

Request body example

curl --location --request POST 'https://{{accountName}}.{{environment}}{{orderId}}/start-handling' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-VTEX-API-AppToken: {{X-VTEX-API-AppToken}}' \
--header 'X-VTEX-API-AppKey: {{X-VTEX-API-AppKey}}'

Response codes

204 - No content

429 - Too many requests

403 - The credentials are not enabled to access the service

404 - Not found

Click Try It! to start a request and see the response here!