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

    Interface ShipmentOptions

    interface ShipmentOptions {
        canSplit: boolean;
        charge:
            | {
                amountIncVat: number
                | null;
                mode: "fixed" | "same-as-order" | "free";
            }
            | null;
        complete: { shipments: ShipmentOptionShipment[] }
        | null;
        enabled: boolean;
        preference: ShipmentPreference | null;
        split: { shipments: ShipmentOptionShipment[] } | null;
    }
    Index
    canSplit charge complete enabled preference split
    canSplit: boolean

    Something is missing and the cart can be split. When false, everything ships together.

    charge:
        | {
            amountIncVat: number
            | null;
            mode: "fixed" | "same-as-order" | "free";
        }
        | null

    What the backorder shipment costs. Free shipping is always judged on the whole order, for every shipment. fixed: amountIncVat, even when the order ships free. same-as-order: the shipping method's price, free when the order ships free. free: nothing. The first shipment always costs what its shipping method costs.

    complete: { shipments: ShipmentOptionShipment[] } | null
    enabled: boolean

    The store offers the choice (Settings → Order routing). When false, show nothing.

    preference: ShipmentPreference | null
    split: { shipments: ShipmentOptionShipment[] } | null

    Settings
    Member Visibility

    On This Page
    Properties