Item Object


A benefit item is a reference to a product, service, or reward hosted by another app which beneficiaries can redeem as part of a benefit.

Properties
idstringRead-onlyformat GUIDimmutable

Benefit item ID.


revisionstringRead-onlyformat int64

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.


createdDatestringRead-onlyformat date-time

Date and time the item was created.


updatedDatestringRead-onlyformat date-time

Date and time the item was updated.


externalIdstringRead-onlyformat GUIDimmutable

ID 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.


categorystringRead-onlymaxLength 20immutable

Benefit item category.


itemSetIdstringRead-onlyformat GUIDimmutable

Item set ID of the benefit that this benefit item is a part of.


displayNamestringmaxLength 64

Benefit item display name.


providerAppIdstringRead-onlyformat GUIDimmutable

ID of the app (SDK | REST) 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.


extendedFieldsExtendedFields

Custom field data for the benefit item object. Extended fields must be configured in the app dashboard before they can be accessed with API calls.


namespacestringRead-onlyminLength 1maxLength 20immutable

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.

Did this help?