Interface ShoppingListDraft

interface ShoppingListDraft {
    anonymousId?: string;
    custom?: CustomFieldsDraft;
    customer?: CustomerResourceIdentifier;
    deleteDaysAfterLastModification?: number;
    description?: LocalizedString;
    key?: string;
    lineItems?: ShoppingListLineItemDraft[];
    name: LocalizedString;
    slug?: LocalizedString;
    store?: StoreResourceIdentifier;
    textLineItems?: TextLineItemDraft[];
}

Properties

anonymousId? custom? customer? deleteDaysAfterLastModification? description? key? lineItems? name slug? store? textLineItems?

Properties

Optional ReadonlyanonymousId

anonymousId?: string

Identifies ShoppingLists belonging to an anonymous session.

Optional Readonlycustom

custom?: CustomFieldsDraft

Custom Fields defined for the ShoppingList.

Optional Readonlycustomer

customer?: CustomerResourceIdentifier

The Customer the ShoppingList should be associated to.

Optional ReadonlydeleteDaysAfterLastModification

deleteDaysAfterLastModification?: number

Number of days after which the ShoppingList will be automatically deleted if it has not been modified. If not set, the default value configured in the Project is used.

Optional Readonlydescription

description?: LocalizedString

Description of the ShoppingList.

Optional Readonlykey

key?: string

User-defined unique identifier for the ShoppingList.

Optional ReadonlylineItems

lineItems?: ShoppingListLineItemDraft[]

Line Items (containing Products) to add to 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}.

Optional Readonlystore

store?: StoreResourceIdentifier

Assigns the new ShoppingList to the Store.

Optional ReadonlytextLineItems

textLineItems?: TextLineItemDraft[]

Line Items (containing text values) to add to the ShoppingList.

Settings

Member Visibility

On This Page

Properties