Applicable rewards

Retrieve the rewards, if any, for a given program membership id.

Invoke this endpoint to return an array of rewards that are applicable for a given cart selection.

POST/partner-api/v2/program-memberships/{program_membership_id}/applicable-rewards

Path parameters

program_membership_id*string

The program membership id

Body

multipart/form-data

toast_restaurant_guid*string

The external toast restaurant guid

check[amount]number

Total cart amount.

check[selections]array of string

Array of selections

Response

200500

Returns rewards successfully

Body

*/*

rewards*array of string

List of applicable rewards.

Request

JavaScriptCurlPython

const response = await fetch('/partner-api/v2/program-memberships/{program_membership_id}/applicable-rewards', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "toast_restaurant_guid": "text"
    }),
});
const data = await response.json();

Response

200

{
  "rewards": [
    "text"
  ]
}