---
title: "Get All Inbound Shipments"
method: GET
path: "/wms/inbound-shipments"
tags: ["wms", "Inbound Shipments"]
---

# Get All Inbound Shipments

`GET /wms/inbound-shipments`

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

## Query parameters

- `page_token` string, nullable
- `limit` integer
- `ids` WmsInboundShipmentIdsQueryParam
  - `in` string[], required — A comma-separated list of resource IDs. If provided, all other query params are ignored.
- `created_date` WmsInboundShipmentCreatedDateQueryParam
  - `eq` string, date-time
  - `neq` string, date-time
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `gt` string, date-time
  - `gte` string, date-time
  - `lt` string, date-time
  - `lte` string, date-time
- `updated_date` WmsInboundShipmentUpdatedDateQueryParam
  - `eq` string, date-time
  - `neq` string, date-time
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `gt` string, date-time
  - `gte` string, date-time
  - `lt` string, date-time
  - `lte` string, date-time
- `trackstar_created_date` WmsInboundShipmentTrackstarCreatedDateQueryParam
  - `eq` string, date-time
  - `neq` string, date-time
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `gt` string, date-time
  - `gte` string, date-time
  - `lt` string, date-time
  - `lte` string, date-time
- `trackstar_updated_date` WmsInboundShipmentTrackstarUpdatedDateQueryParam
  - `eq` string, date-time
  - `neq` string, date-time
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `gt` string, date-time
  - `gte` string, date-time
  - `lt` string, date-time
  - `lte` string, date-time
- `trackstar_tags` WmsInboundShipmentTrackstarTagsFlatQueryParam
  - `contains` string[] — Comma-separated.
  - `not_contains` string[] — Comma-separated.
- `status` WmsInboundShipmentStatusQueryParam
  - `eq` 'open' | 'in-transit' | 'receiving' | 'received' | 'cancelled' | 'other'
  - `neq` 'open' | 'in-transit' | 'receiving' | 'received' | 'cancelled' | 'other'
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `contains` string
  - `not_contains` string
- `warehouse_customer_id` WmsInboundShipmentWarehouseCustomerIdQueryParam
  - `eq` string
  - `neq` string
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `contains` string
  - `not_contains` string
- `warehouse_id` WmsInboundShipmentWarehouseIdQueryParam
  - `eq` string
  - `neq` string
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `contains` string
  - `not_contains` string
- `expected_arrival_date` WmsInboundShipmentExpectedArrivalDateQueryParam
  - `eq` string, date-time
  - `neq` string, date-time
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `gt` string, date-time
  - `gte` string, date-time
  - `lt` string, date-time
  - `lte` string, date-time
- `purchase_order_number` WmsInboundShipmentPurchaseOrderNumberQueryParam
  - `eq` string
  - `neq` string
  - `in` string[] — Comma-separated.
  - `nin` string[] — Comma-separated.
  - `contains` string
  - `not_contains` string

## Headers

- `x-trackstar-api-key` string, required
- `x-trackstar-access-token` string, required

## Response `200`

Successful response

- WmsInboundShipmentsListEndpoint
  - `data` WmsInboundShipmentApiItemSchema[], required
    - `id` string, required — The unique ID of the inbound shipment.
    - `warehouse_customer_id` string, nullable, required — The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.
    - `created_date` string, date-time, required — The date the inbound shipment was created.
    - `updated_date` string, date-time, required — The date the inbound shipment was last updated.
    - `purchase_order_number` string, nullable, required — The number of the purchase order associated with the inbound shipment.
    - `status` 'open' | 'in-transit' | 'receiving' | 'received' | 'cancelled' | 'other', required — The status of the inbound shipment. See the [inbound shipment information](info) for more details.
    - `raw_status` string, nullable, required — The raw status (if available) returned directly from the WMS.
    - `supplier_object` InboundShipmentSupplier, required
      - `supplier_id` string, required — The ID of the supplier.
      - `supplier_name` string, nullable, required — The name of the supplier.
    - `expected_arrival_date` string, date-time, nullable, required — Date the shipment is expected to reach the warehouse.
    - `warehouse_id` string, nullable, required — ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.
    - `line_items` WmsInboundShipmentLineItem[], required — List of line items included in the shipment.
      - `inventory_item_id` string, required — Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.
      - `sku` string, nullable, required
      - `expected_quantity` integer, required — Total quantity of the item expected to be received.
      - `received_quantity` integer, required — Total quantity of the item that has been received.
      - `unit_cost` number, nullable, required — The cost per product that is charged by the manufacturer.
      - `external_id` string, nullable, required — An identifier from an external system. e.g. vendor sku, external id, reference number, etc..
    - `receipts` InboundReceipt[], required — List of receiving events associated with the inbound shipment.
      - `id` string, required — The unique ID of the receiving event.
      - `arrived_date` string, date-time, required — Date the items arrived.
      - `line_items` InboundReceiptLineItem[], required — List of line items included in the receiving event.
        - `inventory_item_id` string, required — Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.
        - `sku` string, nullable, required
        - `quantity` integer, required — Total quantity of the item that has been received.
    - `ship_from_address` ShipFromAddress, required
      - `address1` string, nullable, required
      - `address2` string, nullable, required
      - `address3` string, nullable, required
      - `city` string, nullable, required
      - `state` string, nullable, required
      - `postal_code` string, nullable, required
      - `country` string, nullable, required
    - `tracking_numbers` string[], required — List of tracking numbers associated with the inbound shipment.
    - `notes` string[], required — List of notes associated with the inbound shipment.
    - `external_system_url` string, nullable, required — URL link to the inbound shipment in the external system (WMS/Freight etc).
    - `trackstar_tags` unknown[], nullable, required — A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.
      - unknown
    - `additional_fields` object, required — Integration-specific fields
    - `trackstar_created_date` string, date-time, required
    - `trackstar_updated_date` string, date-time, required
  - `next_token` string, nullable, required — See [pagination](/how-to-guides/about-the-api#pagination) for more details.
  - `total_count` integer, required — The number of items returned.

## Other responses

- `422` — Validation error

---

[API](https://skmtc.net/trackstarhq/apis/trackstar-api.md) · [All operations](https://skmtc.net/trackstarhq/apis/trackstar-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/trackstarhq/trackstar-api/revisions/4bc5c6e1a8bf/schema)