Interface ShippingApiModelV2Rate

The details of a shipping service offering.

Export

Rate

interface ShippingApiModelV2Rate {
    availableValueAddedServiceGroups?: ShippingApiModelV2AvailableValueAddedServiceGroup[];
    benefits?: ShippingApiModelV2Benefits;
    billedWeight?: ShippingApiModelV2Weight;
    carrierId: string;
    carrierName: string;
    paymentType?:
        | "PAY_THROUGH_AMAZON"
        | "PAY_DIRECT_TO_CARRIER"
        | ShippingApiModelV2PaymentType;
    promise: ShippingApiModelV2ModelPromise;
    rateId: string;
    rateItemList?: ShippingApiModelV2RateItem[];
    requiresAdditionalInputs: boolean;
    serviceId: string;
    serviceName: string;
    supportedDocumentSpecifications: ShippingApiModelV2SupportedDocumentSpecification[];
    totalCharge: ShippingApiModelV2Currency;
}

Properties

availableValueAddedServiceGroups? benefits? billedWeight? carrierId carrierName paymentType? promise rateId rateItemList? requiresAdditionalInputs serviceId serviceName supportedDocumentSpecifications totalCharge

Properties

OptionalavailableValueAddedServiceGroups

availableValueAddedServiceGroups?: ShippingApiModelV2AvailableValueAddedServiceGroup[]

A list of value-added services available for a shipping service offering.

Memberof

Rate

Optionalbenefits

benefits?: ShippingApiModelV2Benefits

Memberof

Rate

OptionalbilledWeight

billedWeight?: ShippingApiModelV2Weight

Memberof

Rate

carrierId

carrierId: string

The carrier identifier for the offering, provided by the carrier.

Memberof

Rate

carrierName

carrierName: string

The carrier name for the offering.

Memberof

Rate

OptionalpaymentType

paymentType?:
    | "PAY_THROUGH_AMAZON"
    | "PAY_DIRECT_TO_CARRIER"
    | ShippingApiModelV2PaymentType

Memberof

Rate

promise

promise: ShippingApiModelV2ModelPromise

Memberof

Rate

rateId

rateId: string

An identifier for the rate (shipment offering) provided by a shipping service provider.

Memberof

Rate

OptionalrateItemList

rateItemList?: ShippingApiModelV2RateItem[]

A list of RateItem

Memberof

Rate

requiresAdditionalInputs

requiresAdditionalInputs: boolean

When true, indicates that additional inputs are required to purchase this shipment service. You must then call the getAdditionalInputs operation to return the JSON schema to use when providing the additional inputs to the purchaseShipment operation.

Memberof

Rate

serviceId

serviceId: string

An identifier for the shipping service.

Memberof

Rate

serviceName

serviceName: string

The name of the shipping service.

Memberof

Rate

supportedDocumentSpecifications

supportedDocumentSpecifications: ShippingApiModelV2SupportedDocumentSpecification[]

A list of the document specifications supported for a shipment service offering.

Memberof

Rate

totalCharge

totalCharge: ShippingApiModelV2Currency

Memberof

Rate

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR