getEligibleBenefits( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves benefits that can be redeemed for a specific benefit item.

Each benefit item can only be linked to 1 benefit in 1 pool definition. However, each pool created from that pool definition contains the same benefits. This method checks each pool containing a benefit with this benefit item, and returns the benefits that can be redeemed.

Method Declaration
Copy
Method Parameters
itemReferenceItemReferenceRequired

Item reference.


optionsGetEligibleBenefitsOptions
Returns
Return Type:Promise<GetEligibleBenefitsResponse>
Errors
400Invalid Argument

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?