Authenticated Product Potential Points

Calculates the potential points an authenticated customer can earn for a product and its variants. Requires customer authentication headers. Includes customer-specific multipliers (e.g. VIP tiers) and respects segment restrictions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Storefront endpoint with customer authentication

This endpoint is on https://storefront.yotpo.com/loyalty, not developers.yotpo.com. Instead of an access token, it takes the shopper's email, store account ID and an X-Customer-Token: the SHA-256 of the email followed by the merchant's Loyalty API key. Your app's access token doesn't give you that API key, so the merchant has to provide it, and you must compute the token on your server. For points that don't depend on the shopper, use Retrieve Product Potential Points, which needs no authentication.

Path Params
string
required

The unique identifier of the store.

Body Params
product_potential_points
object
required

The product to calculate points for.

Headers
string
required

Customer's email address.

string
required

SHA-256 hex digest of the customer's email followed by your Loyalty API key, with no separator: sha256(email + api_key). Generate it on your server so the API key never reaches the browser.

string
required

Customer's store account ID (e.g. Shopify customer ID).

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json