Interface OneClickShipmentRequest

The request schema for the OneClickShipment operation. When the channelType is not Amazon, shipTo is required and when channelType is Amazon shipTo is ignored.

Export

OneClickShipmentRequest

interface OneClickShipmentRequest {
    channelDetails: ChannelDetails;
    destinationAccessPointDetails?: AccessPointDetails;
    labelSpecifications: RequestedDocumentSpecification;
    packages: Package[];
    returnTo?: Address;
    serviceSelection: ServiceSelection;
    shipDate?: string;
    shipFrom: Address;
    shipperInstruction?: ShipperInstruction;
    shipTo?: Address;
    taxDetails?: TaxDetail[];
    valueAddedServicesDetails?: OneClickShipmentValueAddedService[];
}

Properties

channelDetails destinationAccessPointDetails? labelSpecifications packages returnTo? serviceSelection shipDate? shipFrom shipperInstruction? shipTo? taxDetails? valueAddedServicesDetails?

Properties

channelDetails

channelDetails: ChannelDetails

Memberof

OneClickShipmentRequest

OptionaldestinationAccessPointDetails

destinationAccessPointDetails?: AccessPointDetails

Memberof

OneClickShipmentRequest

labelSpecifications

labelSpecifications: RequestedDocumentSpecification

Memberof

OneClickShipmentRequest

packages

packages: Package[]

A list of packages to be shipped through a shipping service offering.

Memberof

OneClickShipmentRequest

OptionalreturnTo

returnTo?: Address

Memberof

OneClickShipmentRequest

serviceSelection

serviceSelection: ServiceSelection

Memberof

OneClickShipmentRequest

OptionalshipDate

shipDate?: string

The ship date and time (the requested pickup). This defaults to the current date and time.

Memberof

OneClickShipmentRequest

shipFrom

shipFrom: Address

Memberof

OneClickShipmentRequest

OptionalshipperInstruction

shipperInstruction?: ShipperInstruction

Memberof

OneClickShipmentRequest

OptionalshipTo

shipTo?: Address

Memberof

OneClickShipmentRequest

OptionaltaxDetails

taxDetails?: TaxDetail[]

A list of tax detail information.

Memberof

OneClickShipmentRequest

OptionalvalueAddedServicesDetails

valueAddedServicesDetails?: OneClickShipmentValueAddedService[]

The value-added services to be added to a shipping service purchase.

Memberof

OneClickShipmentRequest

Settings

Member Visibility

On This Page

Properties