Orders
Simulate a status change on a test order
Test environment only. Moves a test order, created with a sk_test_ key, to the requested status and sends the same webhooks as in production (order.updated, plus order.shipped or order.delivered). Without a printer, this is how you see an order go through its life cycle. Real orders are refused with a 404. A test order is processed within a few seconds of its creation: until then (statuses creating, draft, in_queue) this endpoint answers 409 TEST_ORDER_NOT_READY, retry shortly.
Request
Authorization
Bearer token
Send your API key in the Authorization header: Authorization: Bearer sk_test_…. A sk_test_ key creates and sees test orders only. Keys and test mode.
Path parameters
accountIdstringrequiredUnique identifier of the account. You can also use the alias@me.orderIdstringrequiredUnique identifier of the test order
Body application/json
statusstringrequiredAny status of the order life cycle, seeGET /orders/statuses.
Responses
200Status changed, webhooks sent
successbooleanorderobjectThe order in its new status
400Missing or unknown status
Type: Error
401Unauthorized, authentication required, or an OAuth access token unknown, expired or revoked (INVALID_TOKEN)
Type: Error
403The API key is inactive or revoked (INACTIVE_API_KEY), or targets another account (ACCOUNT_ACCESS_DENIED, refused once the account guard is enforced); with an OAuth access token: a token of scope mcp (INSUFFICIENT_SCOPE), a path naming another account or a person no longer a member of it (ACCOUNT_ACCESS_DENIED), a real token on the sandbox host (SANDBOX_REQUIRES_TEST_KEY)
Type: Error
404Test order not found. Only orders created with a sk_test_ key can be simulated.
Type: Error
409The test order is still being processed (TEST_ORDER_NOT_READY), retry in a few seconds
Type: Error
429
500Internal server error
Type: Error