Get inbound shipment · Bigblue Developers

POST/bigblue.storeapi.v1.PublicAPI/GetInboundShipment

Returns one inbound shipment, including status.line_progresses with the units received per line.

appointment shows the delivery slot and whether the warehouse approved it. See Delivery appointments.

public_appointment_url is empty here. Only create and update return it.

Request body

idstringrequired

Bigblue inbound shipment ID.

Pattern^[A-Za-z0-9]{13}$

Responses

200The shipment.

inbound_shipmentInboundShipment

The shipment with its status and line progress.

400The ID isn't 13 letters or digits.

{
  "code": "invalid_argument",
  "msg": "id value does not match regex pattern `^[[:alnum:]]{13}$`",
  "meta": { "argument": "id" }
}

404No shipment with this ID exists.

{ "code": "not_found", "msg": "inbound shipment not found" }

POST/bigblue.storeapi.v1.PublicAPI/GetInboundShipment

Request

{ "id": "IB7K2M9XQ4P1C" }

200: reception complete

{
  "inbound_shipment": {
    "id": "IB7K2M9XQ4P1C",
    "supplier_shipment_id": "PO-2026-0412",
    "warehouse": "FR-CDG-001",
    "appointment": {
      "status": "APPROVED",
      "time_slot_start_time": "2026-04-02T10:30:00Z",
      "time_slot_end_time": "2026-04-02T11:30:00Z",
      "warehouse_approval_note": "Dock 4. Driver must bring the delivery note.",
      "update_time": "2026-03-16T14:05:00Z"
    },
    "status": {
      "code": "COMPLETE",
      "update_time": "2026-04-02T15:12:00Z",
      "total_expected_count": 1500,
      "total_offloaded_count": 1476,
      "total_damaged_count": 12,
      "comments": [
        "12 units water damaged",
        "12 units missing"
      ],
      "line_progresses": [
        {
          "product": "BGBL-ESPSRT-SMAL",
          "expected_count": 600,
          "offloaded_count": 588,
          "damaged_count": 12
        },
        {
          "product": "BGBL-ESPSRT-MEDI",
          "expected_count": 900,
          "offloaded_count": 888
        }
      ]
    },
    "delivery_note_url": "https://docs.bigblue.co/dn/IB7K2M9XQ4P1C.pdf"
  }
}

The second line is 12 units short. The comments explain why.