Discounts

GET /locations/:locationId/discounts

https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/discounts

curl --location --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations//discounts' \
--header 'x-api-key;'

Retrieves all discounts for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a JSON array of discount objects. Each object in the array will be structured as follows:

Field Name	Field Type	Field Description	Org Level Attribute*
id	string	The unique ID for the discount.	Yes
locationId	string	The unique ID for the location.
name	string	The name of the discount.	Yes
deleted	boolean	True if the discount has been marked as deleted.	Yes
enabled	boolean	True if the discount is enabled at the location.

📘

Note that the values of fields marked as "Org Level Attribute" are shared amongst all locations that reside in the same POS organization.

Example Response

[
    {
        "id": "abc123",
        "locationId": "LocationX",
        "name": "Total Comp",
        "deleted": false,
        "enabled": true
    }
]

Headers
x-api-key	Your API Key

Path Variables
locationId	The unique ID for the location

GET /locations/:locationId/discounts/:discountId

https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/discounts/:discountId

curl --location --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations//discounts/' \
--header 'x-api-key;'

Retrieves a single discount for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a single JSON discount object. See the parent route's documentation for more details.

Headers
x-api-key	Your API Key

Path Variables
locationId	The unique ID for the location
discountId	The unique ID for the discount