Get a discount

Returns a Discount object containing information about a price deduction configured for a restaurant.

Securityoauth2

Request

path Parameters

• guid required:
  string

  The Toast POS GUID of the discount.

header Parameters

• Toast-Restaurant-External-ID required:
  string

  The Toast POS GUID of the restaurant that the configuration applies to.

Responses

200

Returns a Discount object.

get /discounts/{guid}

Request samples

curl -i -X GET \
  'https://toast-api-server/config/v2/discounts/{guid}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string'

Response samples

application/json

{
  "guid": "string",
  "entityType": "string",
  "name": "string",
  "active": true,
  "type": "PERCENT",
  "percentage": 0,
  "amount": 0,
  "selectionType": "CHECK",
  "nonExclusive": true,
  "itemPickingPriority": "FIRST",
  "fixedTotal": 0
}