Summary for an AWD inbound shipment containing the shipment ID, which can be used to retrieve the actual shipment.

InboundShipmentSummary

interface InboundShipmentSummary {
    createdAt?: string;
    externalReferenceId?: string;
    orderId: string;
    shipmentId: string;
    shipmentStatus: InboundShipmentStatus;
    updatedAt?: string;
}

Properties

createdAt?: string

Timestamp when the shipment was created.

InboundShipmentSummary

externalReferenceId?: string

Optional client-provided reference ID that can be used to correlate this shipment with client resources. For example, to map this shipment to an internal bookkeeping order record.

InboundShipmentSummary

orderId: string

The AWD inbound order ID that this inbound shipment belongs to.

InboundShipmentSummary

shipmentId: string

A unique shipment ID.

InboundShipmentSummary

shipmentStatus: InboundShipmentStatus

InboundShipmentSummary

updatedAt?: string

Timestamp when the shipment was updated.

InboundShipmentSummary