Interface ShoppingList

interface ShoppingList {
    anonymousId?: string;
    createdAt: string;
    createdBy?: CreatedBy;
    custom?: CustomFields;
    customer?: CustomerReference;
    deleteDaysAfterLastModification?: number;
    description?: LocalizedString;
    id: string;
    key?: string;
    lastModifiedAt: string;
    lastModifiedBy?: LastModifiedBy;
    lineItems: ShoppingListLineItem[];
    name: LocalizedString;
    slug?: LocalizedString;
    store?: StoreKeyReference;
    textLineItems: TextLineItem[];
    version: number;
}

Hierarchy (View Summary)

Properties

anonymousId? createdAt createdBy? custom? customer? deleteDaysAfterLastModification? description? id key? lastModifiedAt lastModifiedBy? lineItems name slug? store? textLineItems version

Properties

Optional ReadonlyanonymousId

anonymousId?: string

Identifies ShoppingLists belonging to an anonymous session.

ReadonlycreatedAt

createdAt: string

Date and time (UTC) the ShoppingList was initially created.

Optional ReadonlycreatedBy

createdBy?: CreatedBy

IDs and references that created the ShoppingList.

Optional Readonlycustom

custom?: CustomFields

Custom Fields defined for the ShoppingList.

Optional Readonlycustomer

customer?: CustomerReference

Reference to a Customer associated with the ShoppingList.

Optional ReadonlydeleteDaysAfterLastModification

deleteDaysAfterLastModification?: number

Number of days after which the ShoppingList will be automatically deleted if it has not been modified.

Optional Readonlydescription

description?: LocalizedString

Description of the ShoppingList.

Readonlyid

id: string

Unique identifier of the ShoppingList.

Optional Readonlykey

key?: string

User-defined unique identifier of the ShoppingList.

ReadonlylastModifiedAt

lastModifiedAt: string

Date and time (UTC) the ShoppingList was last updated.

Optional ReadonlylastModifiedBy

lastModifiedBy?: LastModifiedBy

IDs and references that last modified the ShoppingList.

ReadonlylineItems

lineItems: ShoppingListLineItem[]

Line Items (containing Products) of the ShoppingList.

Readonlyname

name: LocalizedString

Name of the ShoppingList.

Optional Readonlyslug

slug?: LocalizedString

Human-readable identifiers usually used as deep-link URL to the related ShoppingList. Each slug is unique across a Project, but a ShoppingList can have the same slug for different languages. The slug must match the pattern [a-zA-Z0-9_-]{2,256}. For good performance, indexes are provided for the first 15 languages set on the Project.

Optional Readonlystore

store?: StoreKeyReference

Store to which the ShoppingList is assigned.

ReadonlytextLineItems

textLineItems: TextLineItem[]

Line Items (containing text values) of the ShoppingList.

Readonlyversion

version: number

Current version of the ShoppingList.

Settings

Member Visibility

On This Page

Properties