Surcharges

GET /locations/:locationId/surcharges

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

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

Retrieves all POS surcharges for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a JSON array of surcharge 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 surcharge.	Yes
locationId	string	The unique ID for the location.
name	string	The name of the surcharge.	Yes
deleted	boolean	True if the surcharge has been marked as deleted.	Yes
enabled	boolean	True if the surcharge 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": "qpreo42x3rho5aeulle2vrb0nq",
        "locationId": "LocationX",
        "name": "Taxable Surcharge Test",
        "deleted": false,
        "enabled": true
    }
]

Headers
x-api-key	Your API Key

Path Variables
locationId	The unique ID for the location

GET /locations/:locationId/surcharges/:surchargeId

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

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

Retrieves a single POS surcharge for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a single JSON surcharge 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
surchargeId	The unique ID for the surcharge