Interface GetRatesRequest

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 GetRatesRequest {
    channelDetails: ChannelDetails;
    clientReferenceDetails?: ClientReferenceDetail[];
    destinationAccessPointDetails?: AccessPointDetails;
    packages: Package[];
    returnTo?: Address;
    shipDate?: string;
    shipFrom: Address;
    shipmentType?: ShipmentType;
    shipperInstruction?: ShipperInstruction;
    shipTo?: Address;
    taxDetails?: TaxDetail[];
    valueAddedServices?: ValueAddedServiceDetails;
}

Properties

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

Properties

channelDetails

channelDetails: ChannelDetails

Memberof

GetRatesRequest

OptionalclientReferenceDetails

clientReferenceDetails?: ClientReferenceDetail[]

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

Memberof

GetRatesRequest

OptionaldestinationAccessPointDetails

destinationAccessPointDetails?: AccessPointDetails

Memberof

GetRatesRequest

packages

packages: Package[]

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

Memberof

GetRatesRequest

OptionalreturnTo

returnTo?: Address

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

Memberof

GetRatesRequest

OptionalshipmentType

shipmentType?: ShipmentType

Memberof

GetRatesRequest

OptionalshipperInstruction

shipperInstruction?: ShipperInstruction

Memberof

GetRatesRequest

OptionalshipTo

shipTo?: Address

Memberof

GetRatesRequest

OptionaltaxDetails

taxDetails?: TaxDetail[]

A list of tax detail information.

Memberof

GetRatesRequest

OptionalvalueAddedServices

valueAddedServices?: ValueAddedServiceDetails

Memberof

GetRatesRequest

Settings

Member Visibility

On This Page

Properties