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 management and workflows, please refer to the relevant section of the product guide.

Key Order Operations

Create Order - Register a new order with your unique order identifier and optional metadata
Retrieve Order - Get detailed information about a specific order including its current state and history
Update Order - Modify order details such as promised delivery date, language, or order URL
List Orders - Query orders with various filters including date ranges, states, and language
Delete Orders - Remove orders by filter criteria within a specified date range

Important Notes

The order_id field is your unique shop order identifier and is mandatory for all operations
Set boarding_complete to true when all shipments have been added to the order
Orders serve as parent entities for shipments and order items
Language codes must be provided in ISO 639-1 format (2-letter codes like 'en', 'de', 'fr')
Date and time fields use ISO 8601 format (e.g., '2024-01-15T10:30:00Z')
Order tags support custom key-value pairs with a maximum depth of 2 levels