Interface ShippingApiModelPurchaseShipmentRequest

The payload schema for the purchaseShipment operation.

Export

PurchaseShipmentRequest

interface ShippingApiModelPurchaseShipmentRequest {
    clientReferenceId: string;
    containers: ShippingApiModelContainer[];
    labelSpecification: ShippingApiModelLabelSpecification;
    serviceType:
        | ShippingApiModelServiceType
        | "Amazon Shipping Ground"
        | "Amazon Shipping Standard"
        | "Amazon Shipping Premium";
    shipDate?: string;
    shipFrom: ShippingApiModelAddress;
    shipTo: ShippingApiModelAddress;
}

Properties

clientReferenceId containers labelSpecification serviceType shipDate? shipFrom shipTo

Properties

clientReferenceId

clientReferenceId: string

Client reference id.

Memberof

PurchaseShipmentRequest

containers

containers: ShippingApiModelContainer[]

A list of container.

Memberof

PurchaseShipmentRequest

labelSpecification

labelSpecification: ShippingApiModelLabelSpecification

Memberof

PurchaseShipmentRequest

serviceType

serviceType:
    | ShippingApiModelServiceType
    | "Amazon Shipping Ground"
    | "Amazon Shipping Standard"
    | "Amazon Shipping Premium"

Memberof

PurchaseShipmentRequest

OptionalshipDate

shipDate?: string

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

Memberof

PurchaseShipmentRequest

shipFrom

shipFrom: ShippingApiModelAddress

Memberof

PurchaseShipmentRequest

shipTo

shipTo: ShippingApiModelAddress

Memberof

PurchaseShipmentRequest

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR