Get All Inbound Shipments

GET

wms

inbound-shipments

page_token

string

created_date

string

created_date[eq]

string

created_date[neq]

string

created_date[gt]

string

created_date[gte]

string

created_date[lt]

string

created_date[lte]

string

created_date[in]

array

created_date[nin]

array

updated_date

string

updated_date[eq]

string

updated_date[neq]

string

updated_date[gt]

string

updated_date[gte]

string

updated_date[lt]

string

updated_date[lte]

string

updated_date[in]

array

updated_date[nin]

array

limit

integer

ids

string

ids[in]

array

status

enum<string>

status[eq]

enum<string>

status[neq]

enum<string>

status[in]

array

status[nin]

array

warehouse_customer_id

string

warehouse_customer_id[eq]

string

warehouse_customer_id[neq]

string

warehouse_customer_id[in]

array

warehouse_customer_id[nin]

array

warehouse_id

string

expected_arrival_date

string

expected_arrival_date[eq]

string

expected_arrival_date[neq]

string

expected_arrival_date[gt]

string

expected_arrival_date[gte]

string

expected_arrival_date[lt]

string

expected_arrival_date[lte]

string

purchase_order_number

string

purchase_order_number[eq]

string

purchase_order_number[neq]

string

purchase_order_number[in]

array

purchase_order_number[nin]

array

Headers

x-trackstar-api-key

string

required

Your organization-level Trackstar API key.

x-trackstar-access-token

string

required

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Query Parameters

page_token

string | null

The page token to use to retrieve the next page of results. If this field is omitted, there are no subsequent pages.

created_date

string

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[gt]=2023-03-10T00:00:00Z&created_date[lt]=2023-03-22T00:00:00Z. See the filtering docs for more. The date format must always be YYYY-MM-DDTHH:MM:SSZ.

created_date[eq]

string

created_date[neq]

string

created_date[gt]

string

created_date[gte]

string

created_date[lt]

string

created_date[lte]

string

created_date[in]

string[]

Comma-separated.

created_date[nin]

string[]

Comma-separated.

updated_date

string

Same syntax as created_date.

updated_date[eq]

string

updated_date[neq]

string

updated_date[gt]

string

updated_date[gte]

string

updated_date[lt]

string

updated_date[lte]

string

updated_date[in]

string[]

Comma-separated.

updated_date[nin]

string[]

Comma-separated.

limit

integer

The maximum number of items to return. The default is 1000.

ids

string

A comma separated list of resource Ids. If provided, all other query params are ignored.

ids[in]

string[]

Comma-separated.

status

enum<string>

The status of the inbound shipment. See the inbound shipment information for more details.

Available options:

open,

in-transit,

receiving,

received,

cancelled,

other

status[eq]

enum<string>

Available options:

open,

in-transit,

receiving,

received,

cancelled,

other

status[neq]

enum<string>

Available options:

open,

in-transit,

receiving,

received,

cancelled,

other

status[in]

enum<string>[]

Comma-separated.

Available options:

open,

in-transit,

receiving,

received,

cancelled,

other

status[nin]

enum<string>[]

Comma-separated.

Available options:

open,

in-transit,

receiving,

received,

cancelled,

other

warehouse_customer_id

string

The ID of the customer associated with the resource

warehouse_customer_id[eq]

string

warehouse_customer_id[neq]

string

warehouse_customer_id[in]

string[]

Comma-separated.

warehouse_customer_id[nin]

string[]

Comma-separated.

warehouse_id

string

The ID of the warehouse that will be receiving the shipment.

expected_arrival_date

string

The date the shipment is expected to arrive at the warehouse.

expected_arrival_date[eq]

string

expected_arrival_date[neq]

string

expected_arrival_date[gt]

string

expected_arrival_date[gte]

string

expected_arrival_date[lt]

string

expected_arrival_date[lte]

string

purchase_order_number

string

The number of the purchase order associated with the inbound shipment.

purchase_order_number[eq]

string

purchase_order_number[neq]

string

purchase_order_number[in]

string[]

Comma-separated.

purchase_order_number[nin]

string[]

Comma-separated.

Response

200 - application/json

data

object[]

data.id

string

The unique ID of the inbound shipment.

data.warehouse_customer_id

string | null

The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the Warehouse Customer endpoint for more details.

data.created_date

string

The date the inbound shipment was created.

data.updated_date

string

The date the inbound shipment was last updated.

data.purchase_order_number

string | null

The number of the purchase order associated with the inbound shipment.

data.status

enum<string>

The status of the inbound shipment. See the inbound shipment information for more details.

Available options:

open,

in-transit,

receiving,

received,

cancelled,

other

data.raw_status

string | null

The raw status (if available) returned directly from the WMS.

data.supplier

string | null

Deprecated in favor of supplier_object

data.supplier_object

object | null

data.expected_arrival_date

string | null

Date the shipment is expected to reach the warehouse.

data.warehouse_id

string | null

ID of the warehouse that will be receiving the shipment. Can be passed into the Warehouse endpoint for more details.

data.line_items

object[]

List of line items included in the shipment.

data.receipts

object[]

List of receiving events associated with the inbound shipment.

data.ship_from_address

object

data.tracking_numbers

string[]

List of tracking numbers associated with the inbound shipment.

data.notes

string[]

List of notes associated with the inbound shipment.

data.external_system_url

string | null

URL link to the inbound shipment in the external system (WMS/Freight etc).

data.trackstar_tags

any[] | null

A list of custom tags associated with the inbound shipment. A tag can be either a string or a dictionary with one key-value pair. e.g. ['tag1', 'tag2', {'key1': 'value1'}]

next_token

string | null

See pagination for more details.

total_count

integer

The number of items returned.

Inbound Shipments Get Inbound Shipment

API Documentation

Headers

Query Parameters

Response