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.

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

Index

Properties

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

Properties

channelDetails

channelDetails: ChannelDetails

`Optional`destinationAccessPointDetails

destinationAccessPointDetails?: AccessPointDetails

`Optional`goodsOwner

goodsOwner?: GoodsOwner

labelSpecifications

labelSpecifications: RequestedDocumentSpecification

packages

packages: Package[]

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

`Optional`returnTo

returnTo?: Address

serviceSelection

serviceSelection: ServiceSelection

`Optional`shipDate

shipDate?: string

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

shipFrom

shipFrom: Address

`Optional`shipperInstruction

shipperInstruction?: ShipperInstruction

`Optional`shipTo

shipTo?: Address

`Optional`taxDetails

taxDetails?: TaxDetail[]

A list of tax detail information.

`Optional`valueAddedServicesDetails

valueAddedServicesDetails?: OneClickShipmentValueAddedService[]

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