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

    Interface ShoppingListDraft

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

    Properties

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

    Properties

    anonymousId?: string

    Identifies ShoppingLists belonging to an anonymous session.

    businessUnit?: BusinessUnitResourceIdentifier

    ResourceIdentifier of the Business Unit the Shopping List should belong to. When the customer of the Shopping List is set, the Customer must be an Associate of the Business Unit. Only available for B2B-enabled Projects.

    custom?: CustomFieldsDraft

    Custom Fields defined for the ShoppingList.

    customer?: CustomerResourceIdentifier

    The Customer the ShoppingList should be associated to.

    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.

    key?: string

    User-defined unique identifier for the ShoppingList.

    lineItems?: ShoppingListLineItemDraft[]

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

    store?: StoreResourceIdentifier

    Assigns the new ShoppingList to the Store.

    textLineItems?: TextLineItemDraft[]

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

    Settings

    Member Visibility

    On This Page

    Properties