Interface VendorShipmentsApiModelShipmentInformation

Shipment Information details for Label request.

Export

ShipmentInformation

interface VendorShipmentsApiModelShipmentInformation {
    buyerReferenceNumber?: string;
    masterTrackingId?: string;
    shipFromParty?: VendorShipmentsApiModelPartyIdentification;
    shipMode?:
        | "LTL"
        | "SmallParcel"
        | VendorShipmentsApiModelShipmentInformationShipModeEnum;
    shipToParty?: VendorShipmentsApiModelPartyIdentification;
    totalLabelCount?: number;
    vendorDetails?: VendorShipmentsApiModelVendorDetails;
    warehouseId?: string;
}

Properties

buyerReferenceNumber? masterTrackingId? shipFromParty? shipMode? shipToParty? totalLabelCount? vendorDetails? warehouseId?

Properties

OptionalbuyerReferenceNumber

buyerReferenceNumber?: string

The buyer reference number is a unique identifier generated by the buyer for all Collect and WePay shipments.

Memberof

ShipmentInformation

OptionalmasterTrackingId

masterTrackingId?: string

Unique Id with which the shipment can be tracked for Small Parcels.

Memberof

ShipmentInformation

OptionalshipFromParty

shipFromParty?: VendorShipmentsApiModelPartyIdentification

Memberof

ShipmentInformation

OptionalshipMode

shipMode?:
    | "LTL"
    | "SmallParcel"
    | VendorShipmentsApiModelShipmentInformationShipModeEnum

Type of shipment whether it is Small Parcel

Memberof

ShipmentInformation

OptionalshipToParty

shipToParty?: VendorShipmentsApiModelPartyIdentification

Memberof

ShipmentInformation

OptionaltotalLabelCount

totalLabelCount?: number

Number of Labels that are created as part of this shipment.

Memberof

ShipmentInformation

OptionalvendorDetails

vendorDetails?: VendorShipmentsApiModelVendorDetails

Memberof

ShipmentInformation

OptionalwarehouseId

warehouseId?: string

Vendor Warehouse ID from where the shipment is scheduled to be picked up by buyer / Carrier.

Memberof

ShipmentInformation

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR