Interface CarrierServiceLabelInput

The service to use to ship the package.

Tip

If rate_id is specified, the other fields become optional and will only be used to verify that the expected rate was selected, returned an error if the selected rate does not match the specified options.

If rate_id is not specified, the other fields must be specified.

interface CarrierServiceLabelInput {
    account_number?: null | string;
    carrier?: null | CarrierName;
    carrier_service?: null | string;
    rate_id?: null | string;
    [field_name: string]: undefined | JsonValue;
}

Hierarchy (View Summary)

Indexable

Properties

account_number? carrier? carrier_service? rate_id?

Properties

Optionalaccount_number

account_number?: null | string

The carrier account to ship the package with.

If left null, a Shipgenius-provided account will be used if available.

Optionalcarrier

carrier?: null | CarrierName

The carrier that will ship the package.

Required if rate_id is not specified.

Optionalcarrier_service

carrier_service?: null | string

The service to ship the package through.

See getSupportedServices for a list of options.

Required if rate_id is not specified.

Optionalrate_id

rate_id?: null | string

Use a value returned from DomesticRate.rate_id to use the quoted rate.

This rate will be used for this package, assuming everything else matches.

If for some reason, the carrier charges more for the shipment than was quoted for this rate, the request will be rejected and no money will be charged.

Settings

Member Visibility

On This Page

Properties