Summary information about a shipment.

ShipmentSummary

interface ShipmentSummary {
    shipmentId: string;
    status: string;
}

Properties

Properties

shipmentId: string

Identifier of a shipment. A shipment contains the boxes and units being inbounded.

ShipmentSummary

status: string

The status of a shipment. The state of the shipment will typically start as UNCONFIRMED, then transition to WORKING after a placement option has been confirmed, and then to READY_TO_SHIP once labels are generated. Possible values: ABANDONED, CANCELLED, CHECKED_IN, CLOSED, DELETED, DELIVERED, IN_TRANSIT, MIXED, READY_TO_SHIP, RECEIVING, SHIPPED, UNCONFIRMED, WORKING

ShipmentSummary