Entities

Product List

Saved product lists used for wishlists, favorites, shopping lists, and requisition lists

A ProductList is a saved, named collection of products. One entity covers wishlists, favorites, shopping lists, and B2B requisition lists; the type field distinguishes their purpose.

Available since v0.26.0 in @laioutr-core/canonical-types

Components

Base

ProductListBase

base
Stable list identity, display details, list type, item count, and custom fields.
name
string

Display name of the list. Optional — some sources (e.g. a single native wishlist) have none.

type
string
description
string

Optional longer description of the list.

itemCount
number

Number of items on the list, for a list-of-lists overview (Adobe items_count).

customFields
Record<string, unknown>

Custom fields are a way for implementations to pass arbitrary data to actions, queries, etc.

Visibility

ProductListVisibility

visibility
Controls whether the list is private, shared within its organization, or public.
visibility
"private" | "shared" | "public"required

The visibility value set — shared with the ecommerce/product-list/* actions so the vocabulary has a single source.

  • ProductListItemsProductListItem multi — Resolves the list's entries.

Actions

Create, update, duplicate, delete, and mutate lists with the product-list actions.

Copyright © 2026 Laioutr GmbH