Interface CarrierServiceRateInput

A specification of a carrier service to rate with

interface CarrierServiceRateInput {
    account_number?: null | string;
    carrier: CarrierName;
    rate_class: RateClass;
    service_code: string;
    [field_name: string]: undefined | JsonValue;
}

Hierarchy (View Summary)

JsonObject
- CarrierServiceRateInput

Indexable

[field_name: string]: undefined | JsonValue

Index

Properties

account_number? carrier rate_class service_code

Properties

`Optional`account_number

account_number?: null | string

The account number for the account to use for rating.

Must be an account you set up in the Shipgenius Carrier Portal.

Leave off or set to null to use the default shipgenius-provided account, if avalable.

carrier

carrier: CarrierName

The carrier to ship the package through

rate_class

rate_class: RateClass

Which rates to retrieve

service_code

service_code: string

The carrier service to ship the package with

See getSupportedServices and CarrierService.code for a list of available options.