Interface CartScoreTier

Used when the ShippingRate maps to an abstract Cart categorization expressed by integers (such as shipping scores or weight ranges). Either price or priceFunction is required.

interface CartScoreTier {
    isMatching?: boolean;
    price?: _Money;
    priceFunction?: PriceFunction;
    score: number;
    type: "CartScore";
}

Properties

isMatching? price? priceFunction? score type

Properties

Optional Readonly isMatching

isMatching?: boolean

Appears in response to Get ShippingMethods for a Cart if the shipping rate matches the search query.

Optional Readonly price

price?: _Money

Defines a fixed price for the score.

Optional Readonly priceFunction

priceFunction?: PriceFunction

Dynamically calculates a Price for a range of scores.

Readonly score

score: number

Abstract value for categorizing a Cart. The range starts at 0. The default price covers 0, tiers start at 1. See Using Tiered Shipping Rates for details and examples.

Readonly type

type: "CartScore"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc