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 a pool is provisioned or when an item is added to a benefit, and they're removed when the pool ends or is deleted, the benefit is removed from the pool, or the item is deleted.
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.
Credit balance of the pool that contains this item.
Returned only when BALANCE is included in the fields request parameter.
Beneficiary of the pool. The member, contact, or visitor who can access 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.
Key of the benefit that grants access to this item. Unique within the pool.
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 app.
For example, if the items are products, this ID corresponds to the specific product ID in the provider app'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.
ID of the catalog item that this pool item gives access to.
Display name for the catalog item.
Returned only when ITEM is included in the fields request parameter.
Pre-computed search key for the catalog item, built by joining providerAppId, category, and externalId with /. For example, a1c7e2f4-3b5d-4e8a-9c6f-2d4b8e1a7c35/classes/7f3e9b21-4c8a-4d6e-b5f2-9a1c3e7d8b40.
Filtering by itemSearchKey is more efficient than filtering by providerAppId, category, and externalId in 3 separate conditions.
ID of the item set that groups the items of this pool item's benefit.
To identify a benefit, use poolId together with benefitKey instead of itemSetId.
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, including the program's ID, display name, and external ID, if set.
Returned only when PROGRAM is included in the fields request parameter.
Program definition details, including the program definition's ID, display name, description, and external ID, if set.
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.
Whether the pool item was removed.
Query Pool Items doesn't return removed pool items, so this field is always false or absent in query results.
Revision number, which increments by 1 each time the pool item is updated.
Date and time the pool item was updated.