Interface ShippingApiModelV2OneClickShipmentRequest

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 ShippingApiModelV2OneClickShipmentRequest {
    channelDetails: ShippingApiModelV2ChannelDetails;
    destinationAccessPointDetails?: ShippingApiModelV2AccessPointDetails;
    labelSpecifications: ShippingApiModelV2RequestedDocumentSpecification;
    packages: ShippingApiModelV2Package[];
    returnTo?: ShippingApiModelV2Address;
    serviceSelection: ShippingApiModelV2ServiceSelection;
    shipDate?: string;
    shipFrom: ShippingApiModelV2Address;
    shipperInstruction?: ShippingApiModelV2ShipperInstruction;
    shipTo?: ShippingApiModelV2Address;
    taxDetails?: ShippingApiModelV2TaxDetail[];
    valueAddedServicesDetails?: ShippingApiModelV2OneClickShipmentValueAddedService[];
}

Properties

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

Properties

channelDetails

channelDetails: ShippingApiModelV2ChannelDetails

Memberof

OneClickShipmentRequest

OptionaldestinationAccessPointDetails

destinationAccessPointDetails?: ShippingApiModelV2AccessPointDetails

Memberof

OneClickShipmentRequest

labelSpecifications

labelSpecifications: ShippingApiModelV2RequestedDocumentSpecification

Memberof

OneClickShipmentRequest

packages

packages: ShippingApiModelV2Package[]

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

Memberof

OneClickShipmentRequest

OptionalreturnTo

returnTo?: ShippingApiModelV2Address

Memberof

OneClickShipmentRequest

serviceSelection

serviceSelection: ShippingApiModelV2ServiceSelection

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: ShippingApiModelV2Address

Memberof

OneClickShipmentRequest

OptionalshipperInstruction

shipperInstruction?: ShippingApiModelV2ShipperInstruction

Memberof

OneClickShipmentRequest

OptionalshipTo

shipTo?: ShippingApiModelV2Address

Memberof

OneClickShipmentRequest

OptionaltaxDetails

taxDetails?: ShippingApiModelV2TaxDetail[]

A list of tax detail information.

Memberof

OneClickShipmentRequest

OptionalvalueAddedServicesDetails

valueAddedServicesDetails?: ShippingApiModelV2OneClickShipmentValueAddedService[]

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

Memberof

OneClickShipmentRequest

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR