Request structure
The core of the Shippit order placement functionality is the /orders endpoint. To create an order, send a POST request to this endpoint with a JSON payload containing the order details.
The /orders payload is a nested JSON object with these main sections:
The top level object is order, which contains this order information:
delivery_address: The recipient’s address (required).items: An array of items in the order (optional, but recommended for better tracking and reporting).parcels: An array of parcel specifications (required).user_attributes: Information about the customer (required).courier_typeorcourier_allocation: Specifies the service level or the specific courier (one of these is required).- Various other optional fields, depending on the order type and courier.
Additional request headers
When you use Shippit APIs, we require you to provide additional information in your request headers. This table shows the additional headers that you need to provide:
| Request Header | Purpose | Example | Type and limits | Mandatory? |
|---|---|---|---|---|
user-agent | A string to help identify technical information about the integration. Useful information includes software library names, release versions, and dates. | Shippit_Shipping for Magento2 v1.5.3 | 200 chars | Recommended |
x-shippit-partner | A string to identify the entity developing and maintaining the integration. This could be a business name for self-maintained integrations, or the name of a technical partner maintaining the integration. | Shopify, Wallymart | 200 chars | Optional |
x-shippit-platform | A string identifying the platform or software making the calls. This helps us identify when all integrations on the same platform require action, or who to contact about known issues with a platform type. | Magento v2, CustomShop2000 | 200 chars | Recommended |
Providing this additional information allows Shippit to better support your integration. Information like this allows us to identify which systems are making API requests, and who to contact with important information about specific integrations or platforms.