API Reference

Get rewards

Returns rewards available for a merchant, for display purposes.
Some rewards may be specific to certain customers, while others may be specific to certain stores.

To retrieve rewards that a customer can purchase, use the customer query parameter along with the current store_slug parameter.
You can also filter by points range.

Required scopes:

  • reward.read

🚧

Important

The GET Rewards without customerID can be used to display all the merchant's rewards on a welcome page.

However, you must pass the customer ID parameter when a customer is identified on your platform in order to display the right rewards regarding the customer context.

HeyPongo offer the possibility to segment customers such as studentor ambassadorsand attribute specific rewards to those segments.

Without the customerinformation, all the merchant's rewards will be displayed and therefore might not be correct and could lead to errors.

Language
Credentials
Bearer
Click Try It! to start a request and see the response here!