Interface DomesticRateInterfaceInternal

Interface version of DomesticRate

interface DomesticRateInterface {
    __typename: "DomesticRate";
    account_number: null | string;
    actual_rate_class: RateClass;
    base_price: `${number}`;
    billing_weight: number;
    carrier: CarrierName;
    carrier_specific: JsonObject;
    disclaimers: string[];
    estimated_delivery: null | string;
    guaranteed_delivery: null | boolean;
    itemized_charges: ItemizedChargeInterface[];
    labelgenius_charge: `${number}`;
    labelgenius_charge_with_card_fee: `${number}`;
    rate_id: null | string;
    requested_rate_class: RateClass;
    service_code: string;
    total_price: `${number}`;
    warnings: CarrierWarningInterface[];
}

Hierarchy (View Summary)

Implemented by

Properties

__typename account_number actual_rate_class base_price billing_weight carrier carrier_specific disclaimers estimated_delivery guaranteed_delivery itemized_charges labelgenius_charge labelgenius_charge_with_card_fee rate_id requested_rate_class service_code total_price warnings

Properties

Readonly__typename

__typename: "DomesticRate"

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

Readonlyaccount_number

account_number: null | string

The account number used for the request

Readonlyactual_rate_class

actual_rate_class: RateClass

The actual class of rate returned by the carrier

Readonlybase_price

base_price: `${number}`

The base price for this option before extras.

Readonlybilling_weight

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)

Readonlycarrier

carrier: CarrierName

The carrier requests

Readonlycarrier_specific

carrier_specific: JsonObject

Extra information returned by specific carriers

Readonlydisclaimers

disclaimers: string[]

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

Readonlyestimated_delivery

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

Readonlyguaranteed_delivery

guaranteed_delivery: null | boolean

Whether the carrier has a guarantee regarding the delivery time.

Readonlyitemized_charges

itemized_charges: ItemizedChargeInterface[]

An itemized list of charges for this option

Readonlylabelgenius_charge

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

Readonlylabelgenius_charge_with_card_fee

labelgenius_charge_with_card_fee: `${number}`

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

Readonlyrate_id

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

Readonlyrequested_rate_class

requested_rate_class: RateClass

The class of rates requests

Readonlyservice_code

service_code: string

The service code requested.

Readonlytotal_price

total_price: `${number}`

The total price for this option after extras.

Readonlywarnings

warnings: CarrierWarningInterface[]

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

Settings

Member Visibility

On This Page

Properties