@avvyr/storefront-sdk - v0.19.0
    Preparing search index...

    Interface ShippingOption

    interface ShippingOption {
        amountToFreeShipping?: number;
        carrier?: string;
        carrierCode?: string;
        description?: string;
        estimatedDelivery?: string;
        freeShippingThreshold?: number;
        id: string;
        legalReference?: string | null;
        name: string;
        originalPrice?: number;
        originalPriceExVat?: number;
        originalPriceIncVat?: number;
        price: number;
        priceExVat: number;
        priceIncVat: number;
        priority?: number;
        ruleId?: string;
        shippingAgentId?: string;
        shippingAgentName?: string;
        shippingProductId?: string;
        thresholdBasis?: "incVat" | "exVat";
        type?: string;
        vatAmount: number;
        vatGroup?: string;
        vatRate: number;
        vatRateSource?: string | null;
        vatRequiresReview?: boolean;
        vatTreatment?: string | null;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index
    amountToFreeShipping? carrier? carrierCode? description? estimatedDelivery? freeShippingThreshold? id legalReference? name originalPrice? originalPriceExVat? originalPriceIncVat? price priceExVat priceIncVat priority? ruleId? shippingAgentId? shippingAgentName? shippingProductId? thresholdBasis? type? vatAmount vatGroup? vatRate vatRateSource? vatRequiresReview? vatTreatment?
    amountToFreeShipping?: number

    How much more, in the same basis, is needed to reach the threshold. 0 when already free.

    carrier?: string
    carrierCode?: string
    description?: string
    estimatedDelivery?: string
    freeShippingThreshold?: number

    The goods value at which this option becomes free, and which basis that is measured in.

    id: string
    legalReference?: string | null
    name: string
    originalPrice?: number

    What the option cost before a free-shipping threshold or policy zeroed it.

    originalPriceExVat?: number
    originalPriceIncVat?: number
    price: number

    The market's own basis, inc or ex VAT exactly as sellingPrice is on a product. Render this. To WRITE money (a cart, an order, a PSP session), use the explicit pair below.

    priceExVat: number
    priceIncVat: number
    priority?: number
    ruleId?: string
    shippingAgentId?: string
    shippingAgentName?: string
    shippingProductId?: string
    thresholdBasis?: "incVat" | "exVat"
    type?: string
    vatAmount: number
    vatGroup?: string
    vatRate: number
    vatRateSource?: string | null
    vatRequiresReview?: boolean
    vatTreatment?: string | null

    How this supply is treated for VAT. Null while the tenant's tax layer is off.

    Settings
    Member Visibility

    On This Page
    Properties