Interface ShippingApiModelV2GetRatesRequest

The request schema for the getRates operation. When the channelType is Amazon, the shipTo address is not required and will be ignored.

Export

GetRatesRequest

interface ShippingApiModelV2GetRatesRequest {
    channelDetails: ShippingApiModelV2ChannelDetails;
    clientReferenceDetails?: ShippingApiModelV2ClientReferenceDetail[];
    destinationAccessPointDetails?: ShippingApiModelV2AccessPointDetails;
    packages: ShippingApiModelV2Package[];
    returnTo?: ShippingApiModelV2Address;
    shipDate?: string;
    shipFrom: ShippingApiModelV2Address;
    shipmentType?: ShippingApiModelV2ShipmentType | "FORWARD" | "RETURNS";
    shipperInstruction?: ShippingApiModelV2ShipperInstruction;
    shipTo?: ShippingApiModelV2Address;
    taxDetails?: ShippingApiModelV2TaxDetail[];
    valueAddedServices?: ShippingApiModelV2ValueAddedServiceDetails;
}

Properties

channelDetails clientReferenceDetails? destinationAccessPointDetails? packages returnTo? shipDate? shipFrom shipmentType? shipperInstruction? shipTo? taxDetails? valueAddedServices?

Properties

channelDetails

channelDetails: ShippingApiModelV2ChannelDetails

Memberof

GetRatesRequest

OptionalclientReferenceDetails

clientReferenceDetails?: ShippingApiModelV2ClientReferenceDetail[]

Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail

Memberof

GetRatesRequest

OptionaldestinationAccessPointDetails

destinationAccessPointDetails?: ShippingApiModelV2AccessPointDetails

Memberof

GetRatesRequest

packages

packages: ShippingApiModelV2Package[]

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

Memberof

GetRatesRequest

OptionalreturnTo

returnTo?: ShippingApiModelV2Address

Memberof

GetRatesRequest

OptionalshipDate

shipDate?: string

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

Memberof

GetRatesRequest

shipFrom

shipFrom: ShippingApiModelV2Address

Memberof

GetRatesRequest

OptionalshipmentType

shipmentType?: ShippingApiModelV2ShipmentType | "FORWARD" | "RETURNS"

Memberof

GetRatesRequest

OptionalshipperInstruction

shipperInstruction?: ShippingApiModelV2ShipperInstruction

Memberof

GetRatesRequest

OptionalshipTo

shipTo?: ShippingApiModelV2Address

Memberof

GetRatesRequest

OptionaltaxDetails

taxDetails?: ShippingApiModelV2TaxDetail[]

A list of tax detail information.

Memberof

GetRatesRequest

OptionalvalueAddedServices

valueAddedServices?: ShippingApiModelV2ValueAddedServiceDetails

Memberof

GetRatesRequest

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR