In the "Examples" dropdown to the right, you will find predefined sample requests that illustrate which parameters are required for your specific use case, including standard shipments, return parcels, and pickup point deliveries.

Below is a list of available parameters, including sample values and an indication of whether they are mandatory. For more detailed information about shipment workflows, carrier integration, and best practices, please refer to the relevant section of the product guide.

Key Shipment Operations

Create Shipment - Register a new shipment with recipient details, carrier information, and order association
Retrieve Shipment - Get detailed information about a specific shipment including its current status
Update Shipment - Modify shipment details such as recipient address, carrier service, or warehouse information
List Shipments - Query shipments with various filters including date ranges, carriers, and shipment states

Important Notes

All shipments must be associated with a valid order using the order_id field
Recipient address fields (recipient_address, recipient_city, recipient_country, recipient_first_name, recipient_last_name, recipient_zip) are mandatory
Country codes must be provided in ISO 3166-1 alpha-2 format (e.g., 'DE', 'FR', 'AT')
Currency codes follow ISO 4217 format (3-letter codes like 'EUR', 'USD', 'GBP')
Date and time fields use ISO 8601 format (e.g., '2026-01-01T10:30:00Z')