Orders

Simulate Order Status

Simulate order status progression for test orders. This endpoint is only available when using a Test API key. It allows you to manually progress a test order through fulfillment statuses, triggering real webhooks at each stage. Mock shipping labels are created at 'Packaged' status and mock transactions at 'Shipped' status.

put/v1/orders/{orderId}/simulate

Request

  • Base URL: https://api.roastify.app
  • URL: https://api.roastify.app/v1/orders/{orderId}/simulate
  • Auth: API key in header x-api-key

Path parameters

orderIdstring required

The Id of the order

Example:1ef87e47-266e-466f-ab06-a64994aefbb0

Request body

targetStatus'Picked' | 'Printed' | 'Packaged' | 'Shipped' | 'Canceled' required

The target status to transition the order to

Example request

{
  "targetStatus": "Picked"
}

Response

Order status simulated successfully

orderIdstring required
previousStatusstring required
newStatusstring required
messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.