> 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 # ListItems # Package: benefitPrograms # Namespace: ItemService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/benefit-programs/items/list-items.md ## Permission Scopes: SCOPE.BENEFIT_PROGRAMS.READ (PII): SCOPE.BENEFIT_PROGRAMS.READ_LIMITED ## Introduction Retrieves a list of up to 1000 benefit items. --- ## REST API ### Schema ``` Method: listItems Description: Retrieves a list of up to 1000 benefit items. URL: https://www.wixapis.com/benefit-programs/v1/items Method: GET Method parameters: param name: cursorPaging | type: CursorPaging - name: limit | type: integer | description: Maximum number of items to return. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. param name: filter | type: Filter - ONE-OF: - name: byItemSetIdAndReferenceOptions | type: ByItemSetIdAndReference | description: Filter the request by `itemSetId` and item reference. - name: filters | type: array | description: Filter list. - name: itemSetId | type: string | description: GUID set GUID. - name: externalId | type: string | description: External item GUID. - name: category | type: string | description: Item category. - name: providerAppId | type: string | description: *Required**. GUID of the app providing the item. - name: byReferenceOptions | type: ByReference | description: Filter the request item reference. - name: filters | type: array | description: Filter list. - name: externalId | type: string | description: External item GUID. - name: category | type: string | description: Item category. - name: providerAppId | type: string | description: *Required**. GUID of the app providing the item. - name: type | type: Type | description: Filter type. - enum: - BY_ITEM_SET_ID_AND_REFERENCE: Use with `filter.byItemSetIdAndReferenceOptions`. - BY_REFERENCE: Use with `filter.byReferenceOptions`. - name: namespace | type: string | description: Filter by namespace. Return type: ListItemsResponse - name: items | type: array | description: Items. - name: id | type: string | description: Benefit item GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the benefit item is updated. To prevent conflicting changes, the current revision must be passed when updating the benefit item. Ignored when creating a benefit item. - name: createdDate | type: string | description: Date and time the item was created. - name: updatedDate | type: string | description: Date and time the item was updated. - name: externalId | type: string | description: GUID of the item in the app providing it. For example, if the item is a product provided by Wix Stores, the `externalId` would be the Wix Stores `product Id`. - name: category | type: string | description: Benefit item category. - name: itemSetId | type: string | description: Item set GUID of the benefit that this benefit item is a part of. - name: displayName | type: string | description: Benefit item display name. - name: providerAppId | type: string | description: GUID of the [app](https://dev.wix.com/docs/rest/articles/getting-started/apps-created-by-wix.md) that defines and provides the item. For example, if the item is a Wix Stores product, this field's value is `215238eb-22a5-4c36-9e7b-e7c08025e04e`. - name: extendedFields | type: ExtendedFields | description: Custom field data for the benefit item object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: namespace | type: string | description: 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. - name: metadata | type: CursorPagingMetadata | description: Metadata for paginated results. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### ListItems ```curl ~~~cURL curl -X GET \ "https://www.wixapis.com/benefit-programs/v1/items?filter.byReferenceOptions.filters%5B0%5D.externalId=00000000-0000-0000-0000-000000000001&filter.byReferenceOptions.filters%5B0%5D.providerAppId=00000000-0000-0000-0000-000000000000&filter.namespace=benefit_programs_app&filter.type=BY_REFERENCE" -H 'Content-type: application/json' \ -H 'Authorization: ' ~~~ ``` ### ListItems ```curl ~~~cURL curl -X GET \ "https://www.wixapis.com/benefit-programs/v1/items?filter.byItemSetIdAndReferenceOptions.filters%5B0%5D.externalId=00000000-0000-0000-0000-000000000001&filter.byItemSetIdAndReferenceOptions.filters%5B0%5D.itemSetId=201db180-5043-45cf-a501-bd9c06df5ae5&filter.byItemSetIdAndReferenceOptions.filters%5B0%5D.providerAppId=00000000-0000-0000-0000-000000000000&filter.namespace=benefit_programs_app&filter.type=BY_ITEM_SET_ID_AND_REFERENCE" -H 'Content-type: application/json' \ -H 'Authorization: ' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.benefitPrograms.ItemService.listItems(options) Description: Retrieves a list of up to 1000 benefit items. Method parameters: param name: options | type: ListItemsOptions none - name: filter | type: Filter | description: Filter. - ONE-OF: - name: byItemSetIdAndReferenceOptions | type: ByItemSetIdAndReference | description: Filter the request by `itemSetId` and item reference. - name: filters | type: array | description: Filter list. - name: itemSetId | type: string | description: GUID set GUID. - name: externalId | type: string | description: External item GUID. - name: category | type: string | description: Item category. - name: providerAppId | type: string | description: *Required**. GUID of the app providing the item. - name: byReferenceOptions | type: ByReference | description: Filter the request item reference. - name: filters | type: array | description: Filter list. - name: externalId | type: string | description: External item GUID. - name: category | type: string | description: Item category. - name: providerAppId | type: string | description: *Required**. GUID of the app providing the item. - name: type | type: Type | description: Filter type. - enum: - BY_ITEM_SET_ID_AND_REFERENCE: Use with `filter.byItemSetIdAndReferenceOptions`. - BY_REFERENCE: Use with `filter.byReferenceOptions`. - name: namespace | type: string | description: Filter by namespace. - name: cursorPaging | type: CursorPaging | description: Cursor paging - name: limit | type: integer | description: Maximum number of items to return. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. Return type: PROMISE - name: items | type: array | description: Items. - name: _id | type: string | description: Benefit item GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the benefit item is updated. To prevent conflicting changes, the current revision must be passed when updating the benefit item. Ignored when creating a benefit item. - name: _createdDate | type: Date | description: Date and time the item was created. - name: _updatedDate | type: Date | description: Date and time the item was updated. - name: externalId | type: string | description: GUID of the item in the app providing it. For example, if the item is a product provided by Wix Stores, the `externalId` would be the Wix Stores `product Id`. - name: category | type: string | description: Benefit item category. - name: itemSetId | type: string | description: Item set GUID of the benefit that this benefit item is a part of. - name: displayName | type: string | description: Benefit item display name. - name: providerAppId | type: string | description: GUID of the [app](https://dev.wix.com/docs/rest/articles/getting-started/apps-created-by-wix.md) that defines and provides the item. For example, if the item is a Wix Stores product, this field's value is `215238eb-22a5-4c36-9e7b-e7c08025e04e`. - name: extendedFields | type: ExtendedFields | description: Custom field data for the benefit item object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: namespace | type: string | description: 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. - name: metadata | type: CursorPagingMetadata | description: Metadata for paginated results. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### listItems ```javascript import { items } from '@wix/benefit-programs'; async function listItems(options) { const response = await items.listItems(options); }; ``` ### listItems (with elevated permissions) ```javascript import { items } from '@wix/benefit-programs'; import { auth } from '@wix/essentials'; async function myListItemsMethod(options) { const elevatedListItems = auth.elevate(items.listItems); const response = await elevatedListItems(options); } ``` ### listItems (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { items } from '@wix/benefit-programs'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { items }, // Include the auth strategy and host as relevant }); async function listItems(options) { const response = await myWixClient.items.listItems(options); }; ``` ---