Transition test order
Warehouses and payment move a real order, none of which you can trigger, so a test order is driven from here instead. Each transition updates what `GET /v1/orders/{orderId}` returns and delivers the matching webhook for real, signed and logged, with `testMode: true` in the payload. Only `test_` orders can be transitioned.
Warehouses and payment move a real order, none of which you can trigger, so a test order is driven from here instead. Each transition updates what GET /v1/orders/{orderId} returns and delivers the matching webhook for real, signed and logged, with testMode: true in the payload. Only test_ orders can be transitioned.
Authorization
apiKey An API connection key, sent as Authorization: Bearer <key>. The x-api-key header is accepted as an alternative.
In: header
Path Parameters
The test_-prefixed id returned when you created it.
1 <= length <= 200Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/test/orders/string/transitions" \ -H "Content-Type: application/json" \ -d '{ "transition": "process" }'{ "order": { "id": "string", "testMode": true, "externalOrderId": "string", "status": "NEW", "onHold": true, "onHoldReasons": [ "out_of_stock" ], "createdAt": "2019-08-24T14:15:22Z", "shippingAddress": { "name": "string", "firstName": "string", "lastName": "string", "company": "string", "phone": "string", "address1": "string", "address2": "string", "city": "string", "stateCode": "string", "zip": "string", "countryCode": "string" }, "lines": [ { "id": "string", "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113", "quantity": 0, "shipmentId": "string" } ], "shipments": [ { "id": "string", "status": "pending", "trackingNumber": "string", "trackingUrl": "http://example.com", "createdAt": "2019-08-24T14:15:22Z", "lineIds": [ "string" ] } ] }, "event": "string", "deliveries": 0}