A pool definition item represents the assignment of an item to a benefit in a pool definition. Pool definition items are created automatically when an item is added to a benefit or a benefit is added to a pool definition, and they're removed when the item is removed from the benefit, the benefit is removed from the pool definition, or the pool definition is deleted.
Each pool definition item links a pool definition's benefit to a single item. It includes references to the item, pool definition, and program definitions, and optionally display and pricing details.
Benefit details, including credit price, display name, and description.
Returned only when BENEFIT is included in the fields request parameter.
Key of the benefit that the item is assigned to. Unique within the pool definition.
Item category. Groups benefit items together for organization and management. For example, classes, posts, or groups.
Date and time the pool definition 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.
Pool definition item ID.
The ID is derived from poolDefinitionId and itemId, so it stays the same for a given pool definition and item.
ID of the item that's assigned to the benefit.
Catalog item details, including display name.
Returned only when ITEM is included in the fields request parameter.
Pre-computed search key for the 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 definition item's benefit.
To identify a benefit, use poolDefinitionId together with benefitKey instead of itemSetId.
Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
Inherited from the benefit's configuration in the pool definition.
Pool definition details, including display name, description, and credit configuration.
Returned only when POOL_DEFINITION is included in the fields request parameter.
ID of the pool definition that contains the benefit this item is assigned to.
Program definitions that include this pool definition item's pool definition.
Each program definition's id and externalId are always returned. displayName and description are returned only when PROGRAM_DEFINITION is included in the fields request parameter.
ID of the app that provides the item. Each item's externalId is unique within its provider app.
Inherited from the benefit's configuration in the pool definition.
Whether the pool definition item was removed.
Query Pool Definition Items doesn't return removed pool definition items, so this field is always false or absent in query results.
Revision number, which increments by 1 each time the pool definition item is updated.
Date and time the pool definition item was updated.