Get All ERP Sales Order Shipments
Changed onReturns all Sales Order Shipments for the ERP connection associated with the provided access token. Shipments are fulfillment events recorded against a parent sales order; the parent is linked via sales_order_id.
Request
- Base URLhttps://production.trackstarhq.com
- URLhttps://production.trackstarhq.com/erp/sales-order-shipments
- Authnone required
Query parameters
The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.
The maximum number of items to return. The default is 1000.
{
"in": [
"_in"
]
}Use this parameter to retrieve items filtered to a specific date range. For example, to get all items between 2023-03-10 and 2023-03-22, you would send created_date[gte]=2023-03-10T00:00:00Z&created_date[lte]=2023-03-22T00:00:00Z. See the filtering docs for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ. Note: it is much more efficient to use a combination of gte/lte than it is to use gt/lt.
{
"eq": "2023-03-15T13:45:30Z",
"neq": "2023-03-15T13:45:30Z",
"in": [
"2023-03-15T13:45:30Z"
],
"nin": [
"2023-03-15T13:45:30Z"
],
"gt": "2023-03-15T13:45:30Z",
"gte": "2023-03-15T13:45:30Z",
"lt": "2023-03-15T13:45:30Z",
"lte": "2023-03-15T13:45:30Z"
}Same syntax as created_date.
{
"eq": "2023-03-15T13:45:30Z",
"neq": "2023-03-15T13:45:30Z",
"in": [
"2023-03-15T13:45:30Z"
],
"nin": [
"2023-03-15T13:45:30Z"
],
"gt": "2023-03-15T13:45:30Z",
"gte": "2023-03-15T13:45:30Z",
"lt": "2023-03-15T13:45:30Z",
"lte": "2023-03-15T13:45:30Z"
}Same syntax as created_date.
{
"eq": "2023-03-15T13:45:30Z",
"neq": "2023-03-15T13:45:30Z",
"in": [
"2023-03-15T13:45:30Z"
],
"nin": [
"2023-03-15T13:45:30Z"
],
"gt": "2023-03-15T13:45:30Z",
"gte": "2023-03-15T13:45:30Z",
"lt": "2023-03-15T13:45:30Z",
"lte": "2023-03-15T13:45:30Z"
}Same syntax as created_date.
{
"eq": "2023-03-15T13:45:30Z",
"neq": "2023-03-15T13:45:30Z",
"in": [
"2023-03-15T13:45:30Z"
],
"nin": [
"2023-03-15T13:45:30Z"
],
"gt": "2023-03-15T13:45:30Z",
"gte": "2023-03-15T13:45:30Z",
"lt": "2023-03-15T13:45:30Z",
"lte": "2023-03-15T13:45:30Z"
}Filter by trackstar tags. Dict-shaped tags should be queried as "key:value" strings. This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date, sales_order_id, shipment_number) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.
{
"contains": [
"contains"
],
"not_contains": [
"not_contains"
]
}ID of the parent sales order.
{
"eq": "so_id",
"neq": "neq",
"in": [
"_in"
],
"nin": [
"nin"
]
}A user-facing identifier for the shipment.
{
"eq": "IF1001",
"neq": "neq",
"in": [
"_in"
],
"nin": [
"nin"
],
"contains": "contains",
"not_contains": "not_contains"
}The date the shipment was sent. Same syntax as created_date/updated_date. This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date, sales_order_id, shipment_number) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.
{
"eq": "2024-05-04T00:00:00Z",
"neq": "2023-03-15T13:45:30Z",
"in": [
"2023-03-15T13:45:30Z"
],
"nin": [
"2023-03-15T13:45:30Z"
],
"gt": "2023-03-15T13:45:30Z",
"gte": "2023-03-15T13:45:30Z",
"lt": "2023-03-15T13:45:30Z",
"lte": "2023-03-15T13:45:30Z"
}Headers
Your organization-level Trackstar API key.
Your user's access token for a specific integration (ShipHero, Extensiv, etc).
Response
Successful response
Example response
{
"data": [
{
"id": "ship_1",
"sales_order_id": "so_id",
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z",
"shipment_number": "IF1001",
"shipped_date": "2024-05-04T00:00:00Z",
"location_id": "loc_1",
"notes": [
"First wave"
],
"packages": [
{
"package_id": "ship_1-1",
"tracking_number": "1Z999AA10123456784",
"measurements": {
"length": 12,
"width": 9,
"height": 4,
"unit": "in",
"weight": 2.5,
"weight_unit": "lb"
}
}
],
"line_items": [
{
"shipment_line_item_id": "shipment_line_item_id",
"line_item_id": "line_item_id",
"item_id": "item_id",
"sku": "sku",
"quantity": 0,
"is_kit": false,
"kit_components": [
{
"line_item_id": "1002",
"item_id": "610",
"sku": "10000",
"quantity": 4,
"lots": [
{
"lot_id": "78524",
"lot_name": "051326",
"bin_id": null,
"bin_name": null,
"quantity": 4
}
]
}
],
"lot_id": "lot_id",
"lot_name": "lot_name",
"expiration_date": "2023-03-15T13:45:30Z",
"bin_id": "bin_id",
"bin_name": "bin_name"
}
],
"custom_fields": {
"custom_field_example": {
"value": "example_value",
"type": "string",
"title": "Example Field"
}
},
"external_system_url": "https://example.com/salesordershipment/123",
"trackstar_tags": [
"tag1",
"tag2",
{
"tag3": "value3"
}
],
"additional_fields": {
"key": "value"
},
"trackstar_created_date": "2023-03-15T13:45:30Z",
"trackstar_updated_date": "2023-03-15T13:45:30Z"
}
],
"next_token": "next_token",
"total_count": 1
}Changes
- info
endpoint added
- info