Interface Shipment

The details of a shipment, including the shipment status.

Export

Shipment

interface Shipment {
    AmazonOrderId: string;
    CreatedDate: string;
    Insurance: CurrencyAmount;
    ItemList: Item[];
    Label: Label;
    LastUpdatedDate?: string;
    PackageDimensions: PackageDimensions;
    SellerOrderId?: string;
    ShipFromAddress: Address;
    ShipToAddress: Address;
    ShipmentId: string;
    ShippingService: ShippingService;
    Status: ShipmentStatus;
    TrackingId?: string;
    Weight: Weight;
}

Properties

AmazonOrderId CreatedDate Insurance ItemList Label LastUpdatedDate? PackageDimensions SellerOrderId? ShipFromAddress ShipToAddress ShipmentId ShippingService Status TrackingId? Weight

Properties

AmazonOrderId

AmazonOrderId: string

An Amazon-defined order identifier, in 3-7-7 format.

Memberof

Shipment

CreatedDate

CreatedDate: string

Memberof

Shipment

Insurance

Insurance: CurrencyAmount

Memberof

Shipment

ItemList

ItemList: Item[]

The list of items to be included in a shipment.

Memberof

Shipment

Label

Label: Label

Memberof

Shipment

Optional LastUpdatedDate

LastUpdatedDate?: string

Memberof

Shipment

PackageDimensions

PackageDimensions: PackageDimensions

Memberof

Shipment

Optional SellerOrderId

SellerOrderId?: string

A seller-defined order identifier.

Memberof

Shipment

ShipFromAddress

ShipFromAddress: Address

Memberof

Shipment

ShipToAddress

ShipToAddress: Address

Memberof

Shipment

ShipmentId

ShipmentId: string

An Amazon-defined shipment identifier.

Memberof

Shipment

ShippingService

ShippingService: ShippingService

Memberof

Shipment

Status

Status: ShipmentStatus

Memberof

Shipment

Optional TrackingId

TrackingId?: string

The shipment tracking identifier provided by the carrier.

Memberof

Shipment

Weight

Weight: Weight

Memberof

Shipment

Settings

Member Visibility

Theme

On This Page

AmazonOrderIdCreatedDateInsuranceItemListLabelLastUpdatedDatePackageDimensionsSellerOrderIdShipFromAddressShipToAddressShipmentIdShippingServiceStatusTrackingIdWeight