Applicable rewards

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

post

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

Authorizations

Path parameters

program_membership_idanyrequired

The program membership id

Body

toast_restaurant_guidstringrequired

The external toast restaurant guid

check[amount]numberoptional

Total cart amount.

check[selections]arrayoptional

Array of selections

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v2/program-memberships/{program_membership_id}/applicable-rewards' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'toast_restaurant_guid=text&check[amount]=1&check[selections]='

200

500

200

{
  "rewards": [
    "text"
  ]
}

Returns rewards successfully