A pool item represents a specific catalog item that a beneficiary can access as part of a benefit in their pool. Pool items are created automatically when items become available to a beneficiary, and they're removed when the items are revoked.
Each pool item links a beneficiary's pool to a single catalog item, surfacing pricing, display details, and references to the underlying pool, program, pool definition, and program definition.
Beneficiary of the pool — the member, contact, or visitor who holds this pool item.
Pricing and display information for the associated benefit, including credit price, name, and description.
Returned only when BENEFIT is included in the fields request parameter.
Unique identifier for the benefit that grants access to this item.
Item category. Groups benefit items together for organization and management. For example, classes, posts, or groups.
Date and time the pool item was created.
External item ID assigned by the provider of the items.
For example, if the items are products, this ID corresponds to the specific product ID in the provider's system.
External program definition ID assigned by the provider.
External program ID assigned by the provider.
Pool item ID. Generated deterministically from poolId and itemId.
Item ID.
Display name for the catalog item.
Returned only when ITEM is included in the fields request parameter.
Pre-computed search key for the item reference, built by concatenating providerAppId, category, and externalId separated by /. Use this field for efficient single-field filtering instead of composing three separate conditions.
Internal grouping identifier for this benefit's item set. Use poolId together with benefitKey to identify a benefit — itemSetId is an implementation detail.
Namespace for your app or site's benefit programs. Namespaces let you distinguish between entities that you created and entities that other apps created.
Pool details, including display name and description.
Returned only when POOL is included in the fields request parameter.
ID of the pool definition that's the template for this pool item's pool.
ID of the pool that contains this item. A pool is the runtime container of benefits and items provisioned for a beneficiary.
Program details — id, externalId, and displayName.
Returned only when PROGRAM is included in the fields request parameter.
Program definition that includes this item as an accessible benefit.
Returned only when PROGRAM_DEFINITION is included in the fields request parameter.
ID of the program definition that's the template for this pool item's program.
ID of the program that contains this pool item. The program is the runtime instance of a program definition for a specific beneficiary.
ID of the application that provides the benefit items. Each item's externalId is unique within its provider application.
Indicates whether this pool item has been removed
Revision number, which increments by 1 each time the pool item is updated.
Date and time the pool item was updated.