The payload schema for the purchaseShipment operation.

PurchaseShipmentRequest

interface PurchaseShipmentRequest {
    clientReferenceId: string;
    containers: Container[];
    labelSpecification: LabelSpecification;
    serviceType: ServiceType;
    shipDate?: string;
    shipFrom: Address;
    shipTo: Address;
}

Properties

clientReferenceId: string

Client reference id.

PurchaseShipmentRequest

containers: Container[]

A list of container.

PurchaseShipmentRequest

labelSpecification: LabelSpecification

PurchaseShipmentRequest

serviceType: ServiceType

PurchaseShipmentRequest

shipDate?: string

The start date and time. This defaults to the current date and time.

PurchaseShipmentRequest

shipFrom: Address

PurchaseShipmentRequest

shipTo: Address

PurchaseShipmentRequest