Update inbound shipment · Bigblue Developers

POST/bigblue.storeapi.v1.PublicAPI/UpdateInboundShipment

Updates an inbound shipment. List the fields to change in update_mask. Other fields aren't changed.

Fields you can update

supplier_shipment_id: Shipment reference.
supplier_name: Who is sending the goods.
warehouse: Destination warehouse.
expected_arrival_time: Expected arrival, RFC 3339 UTC.
expected_load: How the goods are packed.
carrier_name: The carrier.
line_items: All lines. Replaces the existing lines, so send every line.

update_mask value	Meaning
`supplier_shipment_id`	Shipment reference.
`supplier_name`	Who is sending the goods.
`warehouse`	Destination warehouse.
`expected_arrival_time`	Expected arrival, RFC 3339 UTC.
`expected_load`	How the goods are packed.
`carrier_name`	The carrier.
`line_items`	All lines. Replaces the existing lines, so send every line.

You can't update id, currency, status, create_time, receive_to_order or the deprecated counts. To change the receiving mode, delete the shipment and create it again.

Once the shipment is ARRIVED or later, updates fail with failed_precondition.

Request body

inbound_shipmentInboundShipmentFormrequired

The shipment, with id set. Only fields in update_mask are read.

update_maskstring[]required

Fields to update. At least one, with no duplicates.

At least 1 item · No duplicates

Responses

200The shipment was updated.

inbound_shipmentInboundShipment

The updated shipment, with public_appointment_url. Doesn't include appointment.

400The mask is empty, has duplicates or an unknown field, or a value is invalid.

{
  "code": "invalid_argument",
  "msg": "update_mask value must contain at least 1 item(s)",
  "meta": { "argument": "update_mask" }
}

404No shipment with this ID exists.

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

412The shipment has arrived and can't be changed.

{ "code": "failed_precondition", "msg": "inbound shipment cannot be updated in status ARRIVED" }

POST/bigblue.storeapi.v1.PublicAPI/UpdateInboundShipment

Request: change the arrival date

{
  "inbound_shipment": {
    "id": "IB7K2M9XQ4P1C",
    "expected_arrival_time": "2026-04-09T08:00:00Z"
  },
  "update_mask": ["expected_arrival_time"]
}

Request: replace the lines

{
  "inbound_shipment": {
    "id": "IB7K2M9XQ4P1C",
    "line_items": [
      { "product": "BGBL-ESPSRT-SMAL", "quantity": 540 },
      { "product": "BGBL-ESPSRT-MEDI", "quantity": 900 },
      { "product": "BGBL-ESPSRT-LARG", "quantity": 300 }
    ]
  },
  "update_mask": ["line_items"]
}

The shipment now has exactly these three lines.