In the "Examples" dropdown to the right, you will find predefined sample requests that illustrate which parameters are required for your specific use case.

Below is a list of available parameters, including sample values and an indication of whether they are mandatory. For more detailed information about order state workflows and fulfillment tracking, please refer to the relevant section of the product guide.

Key Order State Operations

Create Order State - Record a new state transition for an order with timestamp and optional location

Order State Workflow

Orders progress through various states during their fulfillment lifecycle:

Forward Flow: new → paid → in_production → in_preparation → shipped → completed

Return Flow: return_on_request → return_shipped → returned

Refund Flow: refund_requested → refunded

Available Order States

Public API States (accessible via API):

new - Order has been created
paid - Payment has been confirmed
in_production - Order is being manufactured or prepared
in_preparation - Order is being packaged for shipment
returned - Order has been returned by the customer
refunded - Payment has been refunded to the customer

Additional Internal States:

warehouse_handover - Order handed over to warehouse
warehouse_new - New order in warehouse system
cancelled - Order has been cancelled

Important Notes

The order_id field refers to your shop order identifier (shop_order_id) and must match an existing order
All three fields (order_id, state, datetime) are required
Date and time fields use ISO 8601 format (e.g., '2024-01-16T10:30:00+01:00')
The location field is optional and can contain city, warehouse name, or facility code
State transitions are recorded in the order's state history for tracking and analytics