Interface version of DomesticRate

Hierarchy (View Summary)

Implements

Properties

__typename: "DomesticRate" = ...

Typename that can be used as an alternative to instanceof for type guards

account_number: null | string

The account number used for the request

actual_rate_class: RateClass

The actual class of rate returned by the carrier

base_price: `${number}`

The base price for this option before extras.

billing_weight: number

The billing weight of the package; either the actual weight or dimensional weight as calculated by the carrier.

Returned in the units requested (LBS by default)

carrier: CarrierName

The carrier requests

carrier_specific: JsonObject

Extra information returned by specific carriers

disclaimers: string[]

A list of disclaimers to be shown to the end-user

estimated_delivery: null | string

When the package is estimated to arrive at its destination.

Note

This field is an ISO date string string. See DomesticRate.getEstimatedDeliveryDate value in other representations

guaranteed_delivery: null | boolean

Whether the carrier has a guarantee regarding the delivery time.

itemized_charges: ItemizedCharge[]

An itemized list of charges for this option

labelgenius_charge: `${number}`

The amount that would be charged to your account if shipping this package with this rate

Important

If paying with a card, use labelgenius_charge_with_card_fee instead

labelgenius_charge_with_card_fee: `${number}`

Same as labelgenius_charge but if the payment is made with a card

rate_id: null | string

An id that can be used to select this rate for a shipment of the same package

Only populated if save_rates was specified in rate request

requested_rate_class: RateClass

The class of rates requests

service_code: string

The service code requested.

total_price: `${number}`

The total price for this option after extras.

warnings: CarrierWarning[]

A list of warnings for details that might affect the final rate

Methods