TRtrackstarhq
wms
Inbound Shipments

Get All Inbound Shipments

Changed on

Returns all Inbound Shipments for the WMS connection associated with the provided access token.

get/wms/inbound-shipments

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/wms/inbound-shipments
  • Auth
    none required

Query parameters

page_tokenstring nullable
Example:page_token

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

limitinteger
Example:1000

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

instring[] required

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

{
  "in": [
    "_in"
  ]
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

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"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

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"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

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"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

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"
}
containsstring[]

Comma-separated.

not_containsstring[]

Comma-separated.

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, status) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.

{
  "contains": [
    "contains"
  ],
  "not_contains": [
    "not_contains"
  ]
}
eq'open' | 'in-transit' | 'receiving' | 'received' | 'cancelled' | 'other'
neq'open' | 'in-transit' | 'receiving' | 'received' | 'cancelled' | 'other'
instring[]

Comma-separated.

ninstring[]

Comma-separated.

containsstring
not_containsstring

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

{
  "eq": "open",
  "neq": "cancelled",
  "in": [
    "cancelled"
  ],
  "nin": [
    "cancelled"
  ],
  "contains": "contains",
  "not_contains": "not_contains"
}
eqstring
neqstring
instring[]

Comma-separated.

ninstring[]

Comma-separated.

containsstring
not_containsstring

The ID of the customer associated with the resource This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date, status) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.

{
  "eq": "warehouse_cust_id",
  "neq": "neq",
  "in": [
    "_in"
  ],
  "nin": [
    "nin"
  ],
  "contains": "contains",
  "not_contains": "not_contains"
}
eqstring
neqstring
instring[]

Comma-separated.

ninstring[]

Comma-separated.

containsstring
not_containsstring

Filter by the ID of the warehouse that will be receiving the shipment. This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date, status) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.

{
  "eq": "warehouse_id_1",
  "neq": "neq",
  "in": [
    "_in"
  ],
  "nin": [
    "nin"
  ],
  "contains": "contains",
  "not_contains": "not_contains"
}
eqstring date-time
neqstring date-time
instring[]

Comma-separated.

ninstring[]

Comma-separated.

gtstring date-time
gtestring date-time
ltstring date-time
ltestring date-time

The date the shipment is expected to arrive at the warehouse. This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date, status) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.

{
  "eq": "2022-10-10T01:02:03Z",
  "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"
}
eqstring
neqstring
instring[]

Comma-separated.

ninstring[]

Comma-separated.

containsstring
not_containsstring

The number of the purchase order associated with the inbound shipment. This filter is not indexed. Pair it with an indexed filter (updated_date, created_date, trackstar_updated_date, trackstar_created_date, status) using eq, gt, gte, lt or lte for faster, fuller pages. See filtering docs.

{
  "eq": "PO123",
  "neq": "neq",
  "in": [
    "_in"
  ],
  "nin": [
    "nin"
  ],
  "contains": "contains",
  "not_contains": "not_contains"
}

Headers

x-trackstar-api-keystring required
Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

x-trackstar-access-tokenstring required
Example:<x-trackstar-access-token>

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

Response

Successful response

next_tokenstring nullable required

See pagination for more details.

total_countinteger required

The number of items returned.

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,
              "lot_id": "lot_id",
              "expiration_date": "2022-10-10T01:02:03Z"
            }
          ]
        }
      ],
      "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"
      },
      "trackstar_created_date": "2023-03-15T13:45:30Z",
      "trackstar_updated_date": "2023-03-15T13:45:30Z"
    }
  ],
  "next_token": "next_token",
  "total_count": 1
}

Changes

  • f9f948f2a7b3Revision changes
    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status