@gradientedge/commercetools-utils
    Preparing search index...

    Interface ShoppingList

    interface ShoppingList {
        anonymousId?: string;
        businessUnit?: BusinessUnitKeyReference;
        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)

    Index

    Properties

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

    Properties

    anonymousId?: string

    Identifies ShoppingLists belonging to an anonymous session.

    businessUnit?: BusinessUnitKeyReference

    Reference to the Business Unit the Shopping List belongs to. Only available for B2B-enabled Projects.

    createdAt: string

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

    createdBy?: CreatedBy

    IDs and references that created the ShoppingList.

    custom?: CustomFields

    Custom Fields defined for the ShoppingList.

    customer?: CustomerReference

    Reference to a Customer associated with the ShoppingList.

    deleteDaysAfterLastModification?: number

    Number of days after the last modification before a ShoppingList is deleted. If not set, the default value configured in the Project is used.

    description?: LocalizedString

    Description of the ShoppingList.

    id: string

    Unique identifier of the ShoppingList.

    key?: string

    User-defined unique identifier of the ShoppingList.

    lastModifiedAt: string

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

    lastModifiedBy?: LastModifiedBy

    IDs and references that last modified the ShoppingList.

    lineItems: ShoppingListLineItem[]

    Line Items (containing Products) of the ShoppingList.

    name: LocalizedString

    Name of the ShoppingList.

    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.

    store?: StoreKeyReference

    Store to which the ShoppingList is assigned.

    textLineItems: TextLineItem[]

    Line Items (containing text values) of the ShoppingList.

    version: number

    Current version of the ShoppingList.

    Settings

    Member Visibility

    On This Page

    Properties