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

ApiKeyAuth

X-API-KeystringRequired

Path parameters

program_membership_idstringRequired

The program membership id

Body

application/x-www-form-urlencoded

toast_restaurant_guidstringRequired

The external toast restaurant guid

check[amount]numberOptional

Total cart amount.

check[selections]arrayOptional

Array of selections

Responses

200

Returns rewards successfully

application/json

500

Could not retrieve rewards for cart.

post

/v2/program-memberships/{program_membership_id}/applicable-rewards

HTTPcURLJavaScriptPython

POST /partner-api/v2/program-memberships/{program_membership_id}/applicable-rewards HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 73

"toast_restaurant_guid='text'&check[amount]=1&check[selections]=[]"

{
  "rewards": [
    "text"
  ]
}