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

    Interface InboundShipment

    Represents an AWD inbound shipment.

    interface InboundShipment {
        carrierCode?: CarrierCode;
        createdAt?: string;
        destinationAddress: Address;
        destinationRegion?: string;
        externalReferenceId?: string;
        orderId: string;
        originAddress: Address;
        receivedQuantity?: InventoryQuantity[];
        shipBy?: string;
        shipmentContainerQuantities: DistributionPackageQuantity[];
        shipmentId: string;
        shipmentSkuQuantities?: SkuQuantity[];
        shipmentStatus: InboundShipmentStatus;
        trackingId?: string;
        updatedAt?: string;
        warehouseReferenceId?: string;
    }
    Index

    Properties

    carrierCode? createdAt? destinationAddress destinationRegion? externalReferenceId? orderId originAddress receivedQuantity? shipBy? shipmentContainerQuantities shipmentId shipmentSkuQuantities? shipmentStatus trackingId? updatedAt? warehouseReferenceId?

    Properties

    carrierCode?: CarrierCode
    createdAt?: string

    Timestamp when the shipment was created. The date is returned in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601 format.

    destinationAddress: Address
    destinationRegion?: string

    Assigned region where the order will be shipped. This can differ from what was passed as preference. AWD currently supports following region IDs: [us-west, us-east, us-southcentral, us-southeast]

    externalReferenceId?: string

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

    orderId: string

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

    originAddress: Address
    receivedQuantity?: InventoryQuantity[]

    Quantity received (at the receiving end) as part of this shipment.

    shipBy?: string

    Timestamp when the shipment will be shipped.

    shipmentContainerQuantities: DistributionPackageQuantity[]

    Packages that are part of this shipment.

    shipmentId: string

    Unique shipment ID.

    shipmentSkuQuantities?: SkuQuantity[]

    Quantity details at SKU level for the shipment. This attribute will only appear if the skuQuantities parameter in the request is set to SHOW.

    shipmentStatus: InboundShipmentStatus
    trackingId?: string

    Carrier-unique tracking ID for this shipment.

    updatedAt?: string

    Timestamp when the shipment was updated. The date is returned in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601 format.

    warehouseReferenceId?: string

    An AWD-provided reference ID that you can use to interact with the warehouse. For example, a carrier appointment booking.

    Settings

    Member Visibility

    On This Page

    Properties