Selling Partner API SDK for JavaScript
    Preparing search index...

    Interface Shipment

    Contains information pertaining to a shipment in an inbound plan.

    interface Shipment {
        amazonReferenceId?: string;
        contactInformation?: ContactInformation;
        dates?: Dates;
        destination: ShipmentDestination;
        freightInformation?: FreightInformation;
        name?: string;
        placementOptionId: string;
        selectedDeliveryWindow?: SelectedDeliveryWindow;
        selectedTransportationOptionId?: string;
        selfShipAppointmentDetails?: SelfShipAppointmentDetails[];
        shipmentConfirmationId?: string;
        shipmentId: string;
        source: ShipmentSource;
        status?: string;
        trackingDetails?: TrackingDetails;
    }
    Index

    Properties

    amazonReferenceId? contactInformation? dates? destination freightInformation? name? placementOptionId selectedDeliveryWindow? selectedTransportationOptionId? selfShipAppointmentDetails? shipmentConfirmationId? shipmentId source status? trackingDetails?

    Properties

    amazonReferenceId?: string

    A unique identifier created by Amazon that identifies this Amazon-partnered, Less Than Truckload/Full Truckload (LTL/FTL) shipment.

    contactInformation?: ContactInformation
    dates?: Dates
    destination: ShipmentDestination
    freightInformation?: FreightInformation
    name?: string

    The name of the shipment.

    placementOptionId: string

    The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.

    selectedDeliveryWindow?: SelectedDeliveryWindow
    selectedTransportationOptionId?: string

    Identifier of a transportation option. A transportation option represent one option for how to send a shipment.

    selfShipAppointmentDetails?: SelfShipAppointmentDetails[]

    List of self ship appointment details.

    shipmentConfirmationId?: string

    The confirmed shipment ID which shows up on labels (for example, FBA1234ABCD).

    shipmentId: string

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

    source: ShipmentSource
    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

    trackingDetails?: TrackingDetails

    Settings

    Member Visibility

    On This Page

    Properties