Delete inbound shipment · Bigblue Developers

POST/bigblue.storeapi.v1.PublicAPI/DeleteInboundShipment

Deletes an inbound shipment. Use it when a delivery is cancelled or was created by mistake.

Once the shipment is ARRIVED or later, it can't be deleted. To change a shipment before it arrives, use update. Deleting and recreating it loses the delivery slot.

Request body

idstringrequired

Bigblue inbound shipment ID.

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

Responses

200The shipment was deleted.

{}

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" }

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

{ "code": "failed_precondition", "msg": "inbound shipment cannot be deleted in status OFFLOADING" }

POST/bigblue.storeapi.v1.PublicAPI/DeleteInboundShipment

Request

{ "id": "IB7K2M9XQ4P1C" }

200

{}