v1
latestOpenAPI 3.1.02026-07-22802,2441.7 MBGet All Inbound Shipments
Returns all Inbound Shipments for the WMS connection associated with the provided access token.
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.
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"
}Same syntax as created_date.
{
"eq": "2023-03-15T13:45:30Z"
}Same syntax as created_date.
{
"eq": "2023-03-15T13:45:30Z"
}Same syntax as created_date.
{
"eq": "2023-03-15T13:45:30Z"
}Filter by trackstar tags. Dict-shaped tags should be queried as "key:value" strings.
The status of the inbound shipment. See the inbound shipment information for more details.
{
"eq": "open"
}The ID of the customer associated with the resource
{
"eq": "warehouse_cust_id"
}Filter by the ID of the warehouse that will be receiving the shipment.
{
"eq": "warehouse_id_1"
}The date the shipment is expected to arrive at the warehouse.
{
"eq": "2022-10-10T01:02:03Z"
}The number of the purchase order associated with the inbound shipment.
{
"eq": "PO123"
}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": "inbound_id",
"warehouse_customer_id": "warehouse_customer_id",
"created_date": "2022-01-01T00:00:00Z",
"updated_date": "2022-01-02T05:05:05Z",
"purchase_order_number": "po_number_123",
"status": "open",
"raw_status": "raw_status",
"supplier_object": {
"supplier_id": "supplier_id",
"supplier_name": "supplier_name"
},
"expected_arrival_date": "2022-10-10T01:02:03Z",
"warehouse_id": "warehouse_id123",
"line_items": [
{
"inventory_item_id": "item_id",
"sku": "sku",
"expected_quantity": 2,
"received_quantity": 1,
"unit_cost": 1,
"external_id": "external_sku"
}
],
"receipts": [
{
"id": "receipt_id",
"arrived_date": "2022-10-10T01:02:03Z",
"line_items": [
{
"inventory_item_id": "item_id",
"sku": "sku",
"quantity": 1
}
]
}
],
"ship_from_address": {
"address1": "123 Main St",
"address2": "Apt 2",
"address3": "Floor 3",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "United States"
},
"tracking_numbers": [
"tracking_number_1",
"tracking_number_2"
],
"notes": [
"note_1",
"note_2"
],
"external_system_url": "https://example.com/inboundshipment/123",
"trackstar_tags": [
"tag1",
"tag2",
{
"tag3": "value3"
}
],
"additional_fields": {
"key": "value"
}
}
],
"next_token": "next_token",
"total_count": 1
}