@avvyr/storefront-sdk - v0.19.0
    Preparing search index...

    Class SavedListsResource

    Index
    • Delete a list. The favorites list is emptied instead of removed. Requires manage access.

      Parameters

      • listId: string

      Returns Promise<{ cleared?: boolean; success: boolean }>

    • Copy a list (any access level) into a new personal list.

      Parameters

      • listId: string
      • Optionalname: string

      Returns Promise<SavedList>

    • The customer's favorites list, created on first call. The server-side home for a wishlist: add and remove with addItems / removeItem on its id.

      Returns Promise<SavedList>

    • Get a list with its items.

      Parameters

      • listId: string

      Returns Promise<SavedList>

    • Get a list with each item's product resolved for the current market.

      Parameters

      • listId: string
      • options: { expand: "products" }

      Returns Promise<SavedListExpanded>

    • Which of the customer's lists contain each SKU — one call per page for the "saved" toggles.

      Parameters

      • skus: string[]

      Returns Promise<SavedListMembership>

    • Remove one item. Idempotent. Requires edit access.

      Parameters

      • listId: string
      • sku: string

      Returns Promise<SavedList>

    • Share with a company (companyId) or make personal again (null). Requires manage access.

      Parameters

      • listId: string
      • companyId: string | null

      Returns Promise<SavedList>

    • Change quantity, note, order or options of one item. Requires edit access.

      Parameters

      Returns Promise<SavedList>