List inbound shipments · Bigblue Developers

POST/bigblue.storeapi.v1.PublicAPI/ListInboundShipments

Returns your inbound shipments one page at a time. All filters are optional and can be combined: a shipment must match every filter, and any value within a list filter. To find shipments by date, filter on expected_arrival_time in your code.

Each shipment includes its appointment. public_appointment_url is empty here.

Request body

warehousesstring[]

Only return shipments to these warehouses.

Up to 20 items · No duplicates

line_item_productsstring[]

Only return shipments containing at least one of these products.

Up to 100 items · No duplicates

status_codesstring[]

Only return shipments whose status.code is one of these values: DRAFT, PENDING, TRANSMITTED, ARRIVED, OFFLOADING, COMPLETE or ARCHIVED.

Up to 20 items · No duplicates

supplier_namestring

Only return shipments whose supplier name contains this value. Case-insensitive.

Up to 255 characters

supplier_shipment_idstring

Only return shipments with exactly this supplier shipment ID.

1–255 characters

page_sizeintegerdefault 100

Shipments per page.

page_tokenstring

The next_page_token from the previous response.

Responses

200A page of shipments.

inbound_shipmentsInboundShipment[]

The shipments on this page.

next_page_tokenstring

Token for the next page. Missing on the last page.

POST/bigblue.storeapi.v1.PublicAPI/ListInboundShipments

Request

{
  "warehouses": ["FR-CDG-001"],
  "line_item_products": ["BGBL-ESPSRT-MEDI"],
  "status_codes": ["ARRIVED", "COMPLETE"],
  "supplier_name": "coimbra",
  "supplier_shipment_id": "PO-2026-0412",
  "page_size": 50
}

200

{
  "inbound_shipments": [
    {
      "id": "IB7K2M9XQ4P1C",
      "supplier_shipment_id": "PO-2026-0412",
      "supplier_name": "Coimbra Textiles",
      "warehouse": "FR-CDG-001",
      "expected_arrival_time": "2026-04-02T08:00:00Z",
      "carrier_name": "DB Schenker",
      "status": {
        "code": "COMPLETE",
        "total_expected_count": 1500,
        "total_offloaded_count": 1476,
        "total_damaged_count": 12
      },
      "create_time": "2026-03-14T09:30:00Z"
    }
  ],
  "next_page_token": "ChoKGAoNaW5ib3VuZHMSC0lCN0s"
}