A list of one or more shipments with respective details.

Shipment

Properties

buyerReferenceNumber?: string

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

Shipment

Shipment

A list of the items in this transportation and their associated inner container 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.

Shipment

currentShipmentStatus?:
    | "Created"
    | "Shipped"
    | VendorShipmentsApiModelShipmentCurrentShipmentStatusEnum
    | "TransportationRequested"
    | "CarrierAssigned"

Indicates the current shipment status.

Shipment

currentshipmentStatusDate?: string

Date and time when the last status was updated.

Shipment

Shipment

packageLabelCreateDate?: string

The date and time of the package label created for the shipment by buyer.

Shipment

Indicates the purchase orders involved for the transportation request. This group is an array create 1 for each PO and list their corresponding items. This information is used for deciding the route,truck allocation and storage efficiently. This is a mandatory information for Buyer performing transportation from vendor warehouse (WePay/Collect)

Shipment

Shipment

Shipment

shipmentConfirmDate?: 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.

Shipment

shipmentCreateDate?: string

The date and time of the shipment request created by vendor.

Shipment

shipmentFreightTerm?:
    | "Prepaid"
    | VendorShipmentsApiModelShipmentShipmentFreightTermEnum
    | "Collect"

Indicates if this transportation request is WePay/Collect or TheyPay/Prepaid. This is a mandatory information.

Shipment

Shipment

Indicates the list of current shipment status details and when the last update was received from carrier this is available on shipment Details response.

Shipment

Shipment

transactionDate: string

Date on which the transportation request was submitted.

Shipment

transactionType:
    | "New"
    | VendorShipmentsApiModelShipmentTransactionTypeEnum
    | "Cancel"

Indicates the type of transportation request such as (New,Cancel,Confirm and PackageLabelRequest). Each transactiontype has a unique set of operation and there are corresponding details to be populated for each operation.

Shipment

Shipment

vendorShipmentIdentifier: string

Unique Transportation ID created by Vendor (Should not be used over the last 365 days).

Shipment

MMNEPVFCICPMFPCPTTAAATR