v1

latestOpenAPI 3.1.02026-07-134488210.8 KB

Inbound Shipments

List Inbound Shipments

List inbound shipments, representing inventory in transit or received at a location. Sorted by most recently updated first. Requires the inbound_shipments_read scope.

get/stores/{storeId}/inbound-shipments

Query parameters

status'PENDING' | 'IN_TRANSIT' | 'PARTIALLY_RECEIVED' | 'RECEIVED'

Filter by shipment status

location_idstring

Filter by location ID (e.g. loc_...)

created_at_minstring date-time

Minimum created time, inclusive

created_at_maxstring date-time

Maximum created time, exclusive

Headers

X-Page-Continuestring

Page marker, from X-Page-Next header

X-Page-Sizeinteger

Page size, defaults to 20

Response

Success

Example response

{
  "inbound_shipments": [
    {
      "id": "inb_7a3f9c2e1b",
      "shipment_id": "SHIP-2026-0042",
      "status": "IN_TRANSIT",
      "location": {
        "id": "loc_4d8e1a2b3c",
        "name": "East Coast Warehouse"
      },
      "carrier": "FedEx Freight",
      "tracking_number": "794644790132",
      "tracking_url": "https://www.fedex.com/fedextrack/?trknbr=794644790132",
      "estimated_arrival_date": "2026-04-15",
      "freight_type": "LTL",
      "payment_terms": "NET30",
      "freight_cost": {
        "amount": "1250.00",
        "currency": "USD"
      },
      "duty_cost": {
        "amount": "1250.00",
        "currency": "USD"
      },
      "items": [
        {
          "id": "isp_8b2c3d4e5f",
          "product": {
            "id": "prd_1a2b3c4d5e",
            "title": "Classic Cotton T-Shirt - Black / M",
            "sku": "TSH-BLK-M",
            "image_url": "https://cdn.example.com/tshirt-blk-m.jpg"
          },
          "quantity": 500
        }
      ],
      "sku_count": 2,
      "item_count": 800,
      "created_at": "2026-03-28T14:30:00Z",
      "updated_at": "2026-03-29T09:15:00Z"
    }
  ]
}