GET
/
wms
/
inbound-shipments
Header
Query
curl --request GET \
  --url https://production.trackstarhq.com/wms/inbound-shipments \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'
{
  "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",
      "status": "open",
      "supplier": "supplier",
      "expected_arrival_date": "2022-10-10T01:02:03Z",
      "warehouse_id": "warehouse_id123",
      "line_items": [],
      "ship_from_address": {
        "address1": "123 Main St",
        "address2": "Apt 2",
        "address3": "Floor 3",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country": "United States"
      }
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}

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. (Format: %Y-%m-%dT%H:%M:%SZ)

created_date[eq]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

created_date[neq]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

created_date[gt]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

created_date[gte]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

created_date[lt]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

created_date[lte]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

created_date[in]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

created_date[nin]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

updated_date
string

Same syntax as created_date. (Format: %Y-%m-%dT%H:%M:%SZ)

updated_date[eq]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

updated_date[neq]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

updated_date[gt]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

updated_date[gte]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

updated_date[lt]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

updated_date[lte]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

updated_date[in]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

updated_date[nin]
string

(Format: %Y-%m-%dT%H:%M:%SZ)

limit
integer

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

status
enum<string>

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

Available options:
open,
received,
cancelled
status[eq]
enum<string>
Available options:
open,
received,
cancelled
status[neq]
enum<string>
Available options:
open,
received,
cancelled
status[in]
enum<string>
Available options:
open,
received,
cancelled
status[nin]
enum<string>
Available options:
open,
received,
cancelled
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
warehouse_customer_id[nin]
string
warehouse_id
string

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

Response

200 - application/json
data
object[]
next_token
string | null

See pagination for more details.

total_count
integer

The number of items returned.

Inbound ShipmentsGet Inbound Shipment