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

    Interface Shipment

    Information about a shipment.

    interface Shipment {
        charges: Charge[];
        creationDateTime: string;
        earliestPackDateTime?: string;
        id: string;
        invoiceInfo?: InvoiceInfo;
        lastUpdatedDateTime: string;
        lineItems: ShipmentLineItem[];
        locationId: string;
        marketplaceAttributes: MarketplaceAttributes;
        packages?: Package[];
        partyInfoList?: PartyIdentificationInfo[];
        reason?: string;
        shipmentInfo: ShipmentInfo;
        shipmentRequirements: ShipmentRequirements;
        shippingInfo: ShippingInfo;
        status: ShipmentStatusEnum;
        subStatus?: ShipmentSubStatusEnum;
    }
    Index

    Properties

    charges creationDateTime earliestPackDateTime? id invoiceInfo? lastUpdatedDateTime lineItems locationId marketplaceAttributes packages? partyInfoList? reason? shipmentInfo shipmentRequirements shippingInfo status subStatus?

    Properties

    charges: Charge[]

    The charges associated with the shipment.

    creationDateTime: string

    A date and time in ISO 8601 format.

    earliestPackDateTime?: string

    A date and time in ISO 8601 format.

    id: string

    The shipment's ID.

    invoiceInfo?: InvoiceInfo
    lastUpdatedDateTime: string

    A date and time in ISO 8601 format.

    lineItems: ShipmentLineItem[]

    The line items in the shipment.

    locationId: string

    The location identifier of the seller's location in the marketplace channel to which the shipment has been created for fulfillment.

    marketplaceAttributes: MarketplaceAttributes
    packages?: Package[]

    The list of packages in the shipment.

    partyInfoList?: PartyIdentificationInfo[]

    All involved party identification and metadata for the vendor, buyer, and seller. Applicable for direct-fulfillment sellers.

    reason?: string

    The reason for the sub-status.

    shipmentInfo: ShipmentInfo
    shipmentRequirements: ShipmentRequirements
    shippingInfo: ShippingInfo
    status: ShipmentStatusEnum

    The current status of the shipment.

    subStatus?: ShipmentSubStatusEnum

    The sub status of the shipment.

    Settings

    Member Visibility

    On This Page

    Properties