v60

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01361201.5 MB
Orders

Start handling order

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

Expect a status 204 response with no content in case of a successful request. The store must validate this response to retry the call if the response differs from the 204 code, making this flow the store's responsibility. This endpoint can also respond with status 500.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
OMSOMS accessChange order workflow status

You can create a custom role with that resource or use one of the following predefined roles:

RoleResource
OMS - Full accessChange order workflow status
IntegrationProfile - Fulfillment OmsChange order workflow status

❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys. To learn more about machine authentication at VTEX, see Authentication overview.

post/api/oms/pvt/orders/{orderId}/start-handling

Path parameters

orderIdstring required
Example:1172452900788-01

Order ID is a unique code that identifies an order.

Headers

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Content-Typestring required

Type of the content being sent.

Response

No Content