> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # Resource: Pool Items # Type: Pool Item Object # Link: https://dev.wix.com/docs/api-reference/business-solutions/benefit-programs/pool-items/pool-item-object.md ## Description: 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. ## Schema: ```json Type: Pool Item Object | type: PoolItem Description: 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. - name: id | type: string | description: Pool item ID. Generated deterministically from `poolId` and `itemId`. - name: revision | type: string | description: Revision number, which increments by 1 each time the pool item is updated. - name: value | type: string | description: - name: createdDate | type: string | description: Date and time the pool item was created. - name: seconds | type: string | description: - name: nanos | type: number | description: - name: updatedDate | type: string | description: Date and time the pool item was updated. - name: externalId | type: string | description: 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. - name: category | type: string | description: Item category. Groups benefit items together for organization and management. For example, `classes`, `posts`, or `groups`. - name: providerAppId | type: string | description: ID of the application that provides the benefit items. Each item's `externalId` is unique within its provider application. - name: namespace | type: string | description: Namespace for your app or site's benefit programs. Namespaces let you distinguish between entities that you created and entities that other apps created. - name: poolId | type: string | description: ID of the pool that contains this item. A pool is the runtime container of benefits and items provisioned for a beneficiary. - name: programId | type: string | description: ID of the program that contains this pool item. The program is the runtime instance of a program definition for a specific beneficiary. - name: value | type: string | description: - name: externalProgramId | type: string | description: External program ID assigned by the provider. - name: programDefinitionId | type: string | description: ID of the program definition that's the template for this pool item's program. - name: externalProgramDefinitionId | type: string | description: External program definition ID assigned by the provider. - name: poolDefinitionId | type: string | description: ID of the pool definition that's the template for this pool item's pool. - name: itemSetId | type: string | description: Internal grouping identifier for this benefit's item set. Use `poolId` together with `benefitKey` to identify a benefit — `itemSetId` is an implementation detail. - name: beneficiary | type: IdentificationData | description: Beneficiary of the pool — the member, contact, or visitor who holds this pool item. - name: pool | type: PoolInfo | description: Pool details, including display name and description. Returned only when `POOL` is included in the `fields` request parameter. - name: displayName | type: string | description: Pool's display name. Often matches the name on the associated pool definition. - name: description | type: string | description: Pool description. - name: program | type: ProgramInfo | description: Program details — `id`, `externalId`, and `displayName`. Returned only when `PROGRAM` is included in the `fields` request parameter. - name: id | type: string | description: Program ID. - name: externalId | type: string | description: External program ID assigned by the provider. - name: displayName | type: string | description: Program's display name. - name: programDefinition | type: ProgramDefinitionInfo | description: Program definition that includes this item as an accessible benefit. Returned only when `PROGRAM_DEFINITION` is included in the `fields` request parameter. - name: id | type: string | description: Program definition ID. - name: externalId | type: string | description: External program definition ID assigned by the provider. - name: displayName | type: string | description: Program definition's display name. - name: description | type: string | description: Program definition description. - name: itemId | type: string | description: Item ID. - name: itemInfo | type: ItemInfo | description: Display name for the catalog item. Returned only when `ITEM` is included in the `fields` request parameter. - name: displayName | type: string | description: Item's display name. - name: benefitInfo | type: BenefitInfo | description: 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. - name: price | type: string | description: Cost of the benefit in credits. The cost is the same for all items in this benefit. Credits are a configurable unit defined on the parent pool definition. The unit type is set in the pool definition's credit configuration. Absent when no credit-based pricing is configured for this benefit. - name: benefitKey | type: string | description: Unique identifier for this benefit. Same value as `poolItem.benefitKey`. - name: displayName | type: string | description: Benefit's display name. - name: description | type: string | description: Benefit description. - name: benefitKey | type: string | description: Unique identifier for the benefit that grants access to this item. - name: itemSearchKey | type: string | description: 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. - name: removed | type: boolean | description: Indicates whether this pool item has been removed - name: value | type: boolean | description: ```