Export shipments
The export shipments API can be used to export shipments into another system
caution
If you have not already read the Introduction to Export APIs then it's recommended to start there to understand how to use the export APIs. The Export APIs is designed to keep track of what has already been exported. If you are looking for a normal API, refer to the Core Shipments API instead.
Get shipments that have not been exported
Endpoint: GET /v10/shipments/export
You can add a date+time to the query string using the parameter not_exported_since in shipment to re-export shipments that
have already been exported
Available properties for filtering: created_at, updated_at (NOTE: These filters have to be added using our Filters Syntax, however system_id and not_export_since should be added as a normal query string parameter)
Available nested resources for including: lines
The endpoint will fetch all shipments that have not been exported yet
Available query parameters
| Parameter | Data type | Required | Default | Description |
|---|---|---|---|---|
system_id | string | Yes | A string identifying the system the shipments should be exported to. This is used so shipments can be exported to multiple systems. | |
not_exported_since | datetime (UTC) | Current time | Add this to re-export shipments that have already been exported. Note the timezone should be UTC | |
include_cancelled | integer | 0 | Export cancelled shipments. 0 = only export non-cancelled shipments. 1 = also include cancelled shipments in export | |
include_completed | integer | 0 | Export completed shipments. 0 = only export non-completed shipments. 1 = also include completed shipments in export | |
filter_groups | Array<Filters> | Optional filters to add. See which filters are available above |
Data of response
| Parameter | Required | Default | Description |
|---|---|---|---|
shipments.* | Yes | An array of object shipment |
Mark shipments as exported
Endpoint: POST /v10/shipments/mark-as-exported
| Parameter | Data type | Required | Default | Description |
|---|---|---|---|---|
shipments | Array<Shipments that have been exported> | Yes | Shipments that have been exported. You can at a max mark 10 shipments at a time |
Shipments that have been exported
| Parameter | Data type | Required | Default | Description |
|---|---|---|---|---|
shipment_id | int | Yes | The ID of the shipment that has been exported | |
system_id | string | Yes | A string identifying the system the shipments should be exported to. This is used so shipments can be exported to multiple systems. | |
note | string | Any notes regarding the sync you want to add. These will be displayed in the timeline of the shipment |