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

    Interface CartLineItem

    interface CartLineItem {
        _id?: string;
        appliedDiscounts?: {
            amountExVat: number;
            amountIncVat: number;
            code?: string;
            percentage?: number;
            type: "coupon" | "campaign" | "manual";
        }[];
        assets?: StorefrontAsset[];
        charge?: LineCharge;
        configuration?: | {
            configuredSku?: string
            | null;
            dimensions?: Record<string, string> | null;
            priceClassCode?: string | null;
            priceGroupCode?: string | null;
            selections?: OptionSelectionSnapshot[] | null;
        }
        | null;
        giftCardRecipients?: GiftCardRecipient[];
        id?: string;
        image?: | {
            alt?: string
            | null;
            assetId?: string | null;
            path?: string | null;
        }
        | null;
        imageUrl?: string;
        isBundleComponent?: boolean;
        isBundleParent?: boolean;
        isGiftCard?: boolean;
        isReturn?: boolean;
        itemType?: "product"
        | "service";
        legalReference?: string | null;
        lineAmountExVat: number;
        lineAmountIncVat: number;
        lineNumber: number;
        lineType?:
            | "shipping"
            | "standard"
            | "fee"
            | "discount"
            | "return"
            | "charge";
        lineVatAmount: number;
        name: string;
        optionGroup?: LineOptionGroup;
        optionGroupId?: string
        | null;
        originalPricePerQtyExVat?: number;
        originalPricePerQtyIncVat?: number;
        pricePerQtyExVat: number;
        pricePerQtyIncVat: number;
        productId: string;
        quantity: number;
        set?: LineSet | null;
        sku: string;
        totalAppliedDiscountExVat?: number;
        totalAppliedDiscountIncVat?: number;
        vatRate: number;
        vatRateSource?: VatRateSource | null;
        vatRequiresReview?: boolean;
        vatTreatment?: VatTreatment | null;
    }
    Index
    _id? appliedDiscounts? assets? charge? configuration? giftCardRecipients? id? image? imageUrl? isBundleComponent? isBundleParent? isGiftCard? isReturn? itemType? legalReference? lineAmountExVat lineAmountIncVat lineNumber lineType? lineVatAmount name optionGroup? optionGroupId? originalPricePerQtyExVat? originalPricePerQtyIncVat? pricePerQtyExVat pricePerQtyIncVat productId quantity set? sku totalAppliedDiscountExVat? totalAppliedDiscountIncVat? vatRate vatRateSource? vatRequiresReview? vatTreatment?

    Optional_id

    _id?: string
    appliedDiscounts?: {
        amountExVat: number;
        amountIncVat: number;
        code?: string;
        percentage?: number;
        type: "coupon" | "campaign" | "manual";
    }[]
    assets?: StorefrontAsset[]
    charge?: LineCharge

    On a charge line: what it charges for.

    configuration?:
        | {
            configuredSku?: string
            | null;
            dimensions?: Record<string, string> | null;
            priceClassCode?: string | null;
            priceGroupCode?: string | null;
            selections?: OptionSelectionSnapshot[] | null;
        }
        | null

    On a matrix-priced goods line: the class key it was priced with and the choices that made it.

    giftCardRecipients?: GiftCardRecipient[]

    Who the gift cards on the line go to, one per card. Set with cart.setGiftCardRecipients.

    id?: string
    image?:
        | { alt?: string
        | null; assetId?: string | null; path?: string | null }
        | null

    The product's primary image when the line was added (CDN-relative path; build the URL with your CDN base and size params).

    imageUrl?: string
    isBundleComponent?: boolean
    isBundleParent?: boolean
    isGiftCard?: boolean

    A gift card (the product is marked as one): cannot be paid with a gift card, earns no loyalty points.

    isReturn?: boolean
    itemType?: "product" | "service"

    "service" for charge lines and service products.

    legalReference?: string | null
    lineAmountExVat: number
    lineAmountIncVat: number
    lineNumber: number
    lineType?: "shipping" | "standard" | "fee" | "discount" | "return" | "charge"

    "charge": an option-group charge (print run, setup, legs). Its quantity follows its group.

    lineVatAmount: number
    name: string
    optionGroup?: LineOptionGroup

    On a goods line of an option group: the profile and every choice made.

    optionGroupId?: string | null

    Shared by every line of one configured product (goods and charges). See groupCartLines.

    originalPricePerQtyExVat?: number
    originalPricePerQtyIncVat?: number
    pricePerQtyExVat: number
    pricePerQtyIncVat: number
    productId: string
    quantity: number
    set?: LineSet | null

    The set (serie-grupp) the line belongs to: same id on every line of it. See options.groupCartLinesBySet.

    sku: string
    totalAppliedDiscountExVat?: number
    totalAppliedDiscountIncVat?: number
    vatRate: number
    vatRateSource?: VatRateSource | null
    vatRequiresReview?: boolean
    vatTreatment?: VatTreatment | null

    Settings
    Member Visibility

    On This Page
    Properties