Interface DomesticRateInput

Information about a shipment to be rated

interface DomesticRateInput {
    additional?: null | AdditionalDomesticInfoInput;
    carrier_specific?: null | LabelCarrierInput;
    override_services?: null | GraphqlList<CarrierServiceRateInput>;
    package: DomesticPackageRateInput;
    request_id?: null | string;
    [field_name: string]: undefined | JsonValue;
}

Hierarchy (View Summary)

Indexable

Properties

additional? carrier_specific? override_services? package request_id?

Properties

Optionaladditional

additional?: null | AdditionalDomesticInfoInput

Additional information about the shipment.

Values here are usually optional, but may be required depending on the carrier, service, and extras.

Optionalcarrier_specific

carrier_specific?: null | LabelCarrierInput

Information required by the specified carrier

Optionaloverride_services

override_services?: null | GraphqlList<CarrierServiceRateInput>

A list of services you want to rate the shipment with, overriding the services passed to getDomesticRate's services parameter.

package

package: DomesticPackageRateInput

The package to be rated

Optionalrequest_id

request_id?: null | string

Optional id that will be echoed in BulkDomesticRateResponse.request_id to help matching rates to requests

Settings

Member Visibility

On This Page

Properties