Interface VendorShipmentsApiModelShipmentConfirmation

A list of one or more shipment confirmations.

ShipmentConfirmation

interface VendorShipmentsApiModelShipmentConfirmation {
    amazonReferenceNumber?: string;
    cartons?: VendorShipmentsApiModelCarton[];
    estimatedDeliveryDate?: string;
    importDetails?: VendorShipmentsApiModelImportDetails;
    pallets?: VendorShipmentsApiModelPallet[];
    sellingParty: VendorShipmentsApiModelPartyIdentification;
    shipFromParty: VendorShipmentsApiModelPartyIdentification;
    shipmentConfirmationDate: string;
    shipmentConfirmationType:
        | VendorShipmentsApiModelShipmentConfirmationShipmentConfirmationTypeEnum
        | "Original"
        | "Replace";
    shipmentIdentifier: string;
    shipmentMeasurements?: VendorShipmentsApiModelShipmentMeasurements;
    shipmentStructure?: | VendorShipmentsApiModelShipmentConfirmationShipmentStructureEnum
    | "PalletizedAssortmentCase"
    | "LooseAssortmentCase"
    | "PalletOfItems"
    | "PalletizedStandardCase"
    | "LooseStandardCase"
    | "MasterPallet"
    | "MasterCase";
    shipmentType?: | VendorShipmentsApiModelShipmentConfirmationShipmentTypeEnum
    | "TruckLoad"
    | "LessThanTruckLoad"
    | "SmallParcel";
    shippedDate?: string;
    shippedItems: VendorShipmentsApiModelItem[];
    shipToParty: VendorShipmentsApiModelPartyIdentification;
    transportationDetails?: VendorShipmentsApiModelTransportationDetailsForShipmentConfirmation;
}

Properties

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.

ShipmentConfirmation

A list of the cartons in this shipment.

ShipmentConfirmation

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.

ShipmentConfirmation

ShipmentConfirmation

A list of the pallets in this shipment.

ShipmentConfirmation

ShipmentConfirmation

ShipmentConfirmation

shipmentConfirmationDate: string

Date on which the shipment confirmation was submitted.

ShipmentConfirmation

shipmentConfirmationType:
    | VendorShipmentsApiModelShipmentConfirmationShipmentConfirmationTypeEnum
    | "Original"
    | "Replace"

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.

ShipmentConfirmation

shipmentIdentifier: string

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

ShipmentConfirmation

ShipmentConfirmation

shipmentStructure?:
    | VendorShipmentsApiModelShipmentConfirmationShipmentStructureEnum
    | "PalletizedAssortmentCase"
    | "LooseAssortmentCase"
    | "PalletOfItems"
    | "PalletizedStandardCase"
    | "LooseStandardCase"
    | "MasterPallet"
    | "MasterCase"

Shipment hierarchical structure.

ShipmentConfirmation

shipmentType?:
    | VendorShipmentsApiModelShipmentConfirmationShipmentTypeEnum
    | "TruckLoad"
    | "LessThanTruckLoad"
    | "SmallParcel"

The type of shipment.

ShipmentConfirmation

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.

ShipmentConfirmation

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.

ShipmentConfirmation

ShipmentConfirmation

ShipmentConfirmation

MMNEPVFCICPMFPCPTTAAATR