Interface ShipmentConfirmation

A list of one or more shipment confirmations.

Export

ShipmentConfirmation

interface ShipmentConfirmation {
    amazonReferenceNumber?: string;
    cartons?: Carton[];
    estimatedDeliveryDate?: string;
    importDetails?: ImportDetails;
    pallets?: Pallet[];
    sellingParty: PartyIdentification;
    shipFromParty: PartyIdentification;
    shipToParty: PartyIdentification;
    shipmentConfirmationDate: string;
    shipmentConfirmationType: ShipmentConfirmationShipmentConfirmationTypeEnum;
    shipmentIdentifier: string;
    shipmentMeasurements?: ShipmentMeasurements;
    shipmentStructure?: ShipmentConfirmationShipmentStructureEnum;
    shipmentType?: ShipmentConfirmationShipmentTypeEnum;
    shippedDate?: string;
    shippedItems: Item[];
    transportationDetails?: TransportationDetailsForShipmentConfirmation;
}

Properties

amazonReferenceNumber? cartons? estimatedDeliveryDate? importDetails? pallets? sellingParty shipFromParty shipToParty shipmentConfirmationDate shipmentConfirmationType shipmentIdentifier shipmentMeasurements? shipmentStructure? shipmentType? shippedDate? shippedItems transportationDetails?

Properties

Optional amazonReferenceNumber

amazonReferenceNumber?: string

The Amazon Reference Number is a unique identifier generated by Amazon for all Collect/WePay shipments when you submit a routing request. This field is mandatory for Collect/WePay shipments.

Memberof

ShipmentConfirmation

Optional cartons

cartons?: Carton[]

A list of the cartons in this shipment.

Memberof

ShipmentConfirmation

Optional estimatedDeliveryDate

estimatedDeliveryDate?: string

The date and time on which the shipment is estimated to reach buyer's warehouse. It needs to be an estimate based on the average transit time between ship from location and the destination. The exact appointment time will be provided by the buyer and is potentially not known when creating the shipment confirmation.

Memberof

ShipmentConfirmation

Optional importDetails

importDetails?: ImportDetails

Memberof

ShipmentConfirmation

Optional pallets

pallets?: Pallet[]

A list of the pallets in this shipment.

Memberof

ShipmentConfirmation

sellingParty

sellingParty: PartyIdentification

Memberof

ShipmentConfirmation

shipFromParty

shipFromParty: PartyIdentification

Memberof

ShipmentConfirmation

shipToParty

shipToParty: PartyIdentification

Memberof

ShipmentConfirmation

shipmentConfirmationDate

shipmentConfirmationDate: string

Date on which the shipment confirmation was submitted.

Memberof

ShipmentConfirmation

shipmentConfirmationType

shipmentConfirmationType: ShipmentConfirmationShipmentConfirmationTypeEnum

Indicates if this shipment confirmation is the initial confirmation, or intended to replace an already posted shipment confirmation. If replacing an existing shipment confirmation, be sure to provide the identical shipmentIdentifier and sellingParty information as in the previous confirmation.

Memberof

ShipmentConfirmation

shipmentIdentifier

shipmentIdentifier: string

Unique shipment ID (not used over the last 365 days).

Memberof

ShipmentConfirmation

Optional shipmentMeasurements

shipmentMeasurements?: ShipmentMeasurements

Memberof

ShipmentConfirmation

Optional shipmentStructure

shipmentStructure?: ShipmentConfirmationShipmentStructureEnum

Shipment hierarchical structure.

Memberof

ShipmentConfirmation

Optional shipmentType

shipmentType?: ShipmentConfirmationShipmentTypeEnum

The type of shipment.

Memberof

ShipmentConfirmation

Optional shippedDate

shippedDate?: string

The date and time of the departure of the shipment from the vendor's location. Vendors are requested to send ASNs within 30 minutes of departure from their warehouse/distribution center or at least 6 hours prior to the appointment time at the buyer destination warehouse, whichever is sooner. Shipped date mentioned in the shipment confirmation should not be in the future.

Memberof

ShipmentConfirmation

shippedItems

shippedItems: Item[]

A list of the items in this shipment and their associated details. If any of the item detail fields are common at a carton or a pallet level, provide them at the corresponding carton or pallet level.

Memberof

ShipmentConfirmation

Optional transportationDetails

transportationDetails?: TransportationDetailsForShipmentConfirmation

Memberof

ShipmentConfirmation

Settings

Member Visibility

Theme

On This Page

amazonReferenceNumbercartonsestimatedDeliveryDateimportDetailspalletssellingPartyshipFromPartyshipToPartyshipmentConfirmationDateshipmentConfirmationTypeshipmentIdentifiershipmentMeasurementsshipmentStructureshipmentTypeshippedDateshippedItemstransportationDetails