Interface ShoppingListLineItem

ShoppingListLineItems are Line Items that contain references to ProductVariants in a Product.

In addition to standard [Reference Expansion](/general-concepts#reference-expansion), a ShoppingListLineItem offers expansion on `productSlug` and `variant`, defined with the query parameter `expand`.
interface ShoppingListLineItem {
    addedAt: string;
    custom?: CustomFields;
    deactivatedAt?: string;
    id: string;
    key?: string;
    name: LocalizedString;
    productId: string;
    productSlug?: LocalizedString;
    productType: ProductTypeReference;
    quantity: number;
    variant?: ProductVariant;
    variantId?: number;
}

Properties

addedAt custom? deactivatedAt? id key? name productId productSlug? productType quantity variant? variantId?

Properties

ReadonlyaddedAt

addedAt: string

Date and time (UTC) the ShoppingListLineItem was added to the ShoppingList.

Optional Readonlycustom

custom?: CustomFields

Custom Fields of the ShoppingListLineItem.

Optional ReadonlydeactivatedAt

deactivatedAt?: string

If the Product or Product Variant is deleted, deactivatedAt is the date and time (UTC) of deletion.

This data is updated in an [eventual consistent manner](/general-concepts#eventual-consistency) when the Product Variant cannot be ordered anymore.

Readonlyid

id: string

Unique identifier of the ShoppingListLineItem.

Optional Readonlykey

key?: string

User-defined identifier of the ShoppingListLineItem. It is unique per ShoppingList.

Readonlyname

name: LocalizedString

Name of the Product.

This data is updated in an [eventual consistent manner](/general-concepts#eventual-consistency) when the Product's name changes.

ReadonlyproductId

productId: string

Unique identifier of a Product.

Optional ReadonlyproductSlug

productSlug?: LocalizedString

Slug of the current ProductData.

Returned when expanded using `expand=lineItems[*].productSlug`. You cannot expand only a single element of the array.

ReadonlyproductType

productType: ProductTypeReference

The Product Type defining the Attributes of the Product.

Readonlyquantity

quantity: number

Number of Products in the ShoppingListLineItem.

Optional Readonlyvariant

variant?: ProductVariant

Data of the ProductVariant.

Returned when expanded using `expand=lineItems[*].variant`. You cannot expand only a single element of the array.

Optional ReadonlyvariantId

variantId?: number

id of the ProductVariant the ShoppingListLineItem refers to. If not set, the ShoppingListLineItem refers to the Master Variant.

Settings

Member Visibility

On This Page

Properties