The Shipping API lets brands CRUD shipment information for their orders into JOOR and gives their retail partners a clear, real-time view of delivery status across orders. The Shipping API is a paid add-on.
| Field Name | Description | Type | Required |
|---|---|---|---|
| id | JOOR-generated unique identifier for the shipment record. | String | Read-only |
| external_id | Your own identifier for the shipment, such as an ERP reference. Used together with line_item_id to uniquely identify a shipment. | String, max 255 chars | Yes |
| line_item_id | The order line item this shipment applies to. | Numeric (digits only) | Yes |
| expected_delivery_date | Date the goods are expected to be delivered. | ISO 8601 date | Yes |
| requested_delivery_date | Date delivery was requested for. | ISO 8601 date | Yes |
| shipping_date | Date the goods actually shipped. | ISO 8601 date | Optional |
| requested_units | Number of units requested. | Integer ≥ 0 | Optional |
| confirmed_units | Number of units confirmed. | Integer ≥ 0 | Optional |
| shipped_units | Number of units shipped. | Integer ≥ 0 | Optional |
| open_units | Units still outstanding, not yet shipped. | Integer — returned by JOOR | Read-only |
| shipment_status | Current status of the shipment. | One of the following values: APPROVED CONFIRMED NOT_CONFIRMED CANCELLED IN_PREPARATION SHIPPED INVOICED PARTIALLY_INVOICED | Yes |
| tracking_number | Parcel tracking number or bill of lading. | String, max 255 chars | Optional |
| carrier | Shipping carrier or method, for example UPS or DHL. | String, max 255 chars | Optional |
| tracking_url | Direct link to track the parcel. | Valid URL, max 255 chars | Optional |
- Maximum items per write request is 1000 items
- Maximum records returned per page is 1000
- The Shipping API is a paid add-on that also includes access to the web shipping report