Selling Partner API SDK for JavaScript
    Preparing search index...

    Interface Rate

    The details of a shipping service offering.

    interface Rate {
        availableValueAddedServiceGroups?: AvailableValueAddedServiceGroup[];
        benefits?: Benefits;
        billedWeight?: Weight;
        carrierId: string;
        carrierName: string;
        paymentType?: PaymentType;
        promise: Promise;
        rateId: string;
        rateItemList?: RateItem[];
        requiresAdditionalInputs: boolean;
        serviceId: string;
        serviceName: string;
        supportedDocumentSpecifications: SupportedDocumentSpecification[];
        totalCharge: Currency;
    }
    Index

    Properties

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

    Properties

    availableValueAddedServiceGroups?: AvailableValueAddedServiceGroup[]

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

    benefits?: Benefits
    billedWeight?: Weight
    carrierId: string

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

    carrierName: string

    The carrier name for the offering.

    paymentType?: PaymentType
    promise: Promise
    rateId: string

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

    rateItemList?: RateItem[]

    A list of RateItem

    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.

    serviceId: string

    An identifier for the shipping service.

    serviceName: string

    The name of the shipping service.

    supportedDocumentSpecifications: SupportedDocumentSpecification[]

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

    totalCharge: Currency

    Settings

    Member Visibility

    On This Page

    Properties