Interface GetRatesRequest

The payload schema for the getRates operation.

interface GetRatesRequest {
    containerSpecifications: ContainerSpecification[];
    serviceTypes: ServiceType[];
    shipDate?: string;
    shipFrom: Address;
    shipTo: Address;
}

Index

Properties

containerSpecifications serviceTypes shipDate? shipFrom shipTo

Properties

containerSpecifications

containerSpecifications: ContainerSpecification[]

A list of container specifications.

serviceTypes

serviceTypes: ServiceType[]

A list of service types that can be used to send the shipment.

`Optional`shipDate

shipDate?: string

The start date and time. This defaults to the current date and time.

shipFrom

shipFrom: Address

shipTo

shipTo: Address