# Scopes

Scopes constrain the endpoints to which a client has access, and whether a client has read or write access to an endpoint.

An application can request one or more scopes, this information is then presented to the user in the consent screen, and the access token issued to the application will be limited to the scopes granted.

Example:

In order to access the endpoint GET API/customers, your access token must have the scope customers.list. If your app token doesn't have this scope, you will get an authorization error

Scopes are configured based on the app/integration scopes to ensure access is only to endpoints needed to achive the integration goals

Your app scopes will be defined by Ristecho team based on the integration scopes

# List of scopes

Entity List Get Create Update Delete Restore
Branches general.read general.read admin.write admin.write ✖ ✖
Branch Business Days operations.read operations.read operations.write ✖ ✖ ✖
Categories general.read general.read menu.write menu.write menu.write menu.write
Charges general.read general.read admin.write admin.write admin.write admin.write
Combos general.read general.read menu.write menu.write menu.write menu.write
Consumption from Order inventory.transactions.read inventory.transactions.read ✖ ✖ ✖ ✖
Consumption from Production inventory.transactions.read inventory.transactions.read ✖ ✖ ✖ ✖
Cost Adjustment inventory.transactions.read inventory.transactions.read inventory.transactions.write inventory.transactions.write inventory.transactions.write ✖
Coupons coupons.read coupons.read coupons.write coupons.write coupons.write ✖
Customers customers.list customers.get customers.write customers.write admin.write admin.write
customers.restore
Delivery Zones general.read general.read admin.write admin.write admin.write admin.write
Devices general.read general.read admin.write admin.write ✖ ✖
Discounts general.read general.read admin.write admin.write admin.write admin.write
Drawer Operations operations.read operations.read operations.write ✖ ✖ ✖
Gift Cards orders.gift_cards.read orders.gift_cards.read ✖ ✖ ✖ ✖
Gift Cards Products general.read general.read admin.write admin.write admin.write admin.write
Gift Cards Transactions orders.gift_cards.read orders.gift_cards.read orders.gift_cards.write ✖ ✖ ✖
Groups general.read general.read menu.write menu.write menu.write
House Accounts customers.accounts.read customers.accounts.read customers.accounts.write ✖ ✖ ✖
Ingrediants menu.ingredients.read menu.ingredients.read menu.ingredients.write menu.ingredients.write menu.ingredients.write ✖
Inventory Categories inventory.settings.read inventory.settings.read inventory.settings.write inventory.settings.write inventory.settings.write inventory.settings.write
Inventory Counts inventory.transactions.read inventory.transactions.read inventory.transactions.write inventory.transactions.write inventory.transactions.write ✖
Inventory End Day ✖ ✖ inventory.settings.write ✖ ✖ ✖
Inventory Ingrediants inventory.settings.read inventory.settings.read inventory.settings.write inventory.settings.write inventory.ingrediants.write ✖
Inventory Items inventory.settings.read inventory.settings.read inventory.settings.write inventory.settings.write inventory.settings.write inventory.settings.write
Inventory Levels inventory.transactions.read inventory.transactions.read ✖ ✖ ✖ ✖
Loyalty customers.loyalty.read customers.loyalty.read customers.loyalty.write ✖ ✖ ✖
Menu Display general.read general.read ✖ ✖ ✖ ✖
Modifiers general.read general.read menu.write menu.write menu.write menu.write
Orders orders.list
orders.limited.read
orders.get
orders.limited.read
orders.write
orders.limited.create
orders.limited.pay
orders.write
orders.limited.deliver
orders.limited.decline
✖ ✖
Payment Methods general.read general.read admin.write
orders.limited.pay
admin.write
orders.limited.pay
admin.write admin.write
Production inventory.transactions.read inventory.transactions.read inventory.transactions.write inventory.transactions.write inventory.transactions.write ✖
Products general.read general.read menu.write menu.write menu.write menu.write
Promotions general.read general.read admin.write admin.write admin.write admin.write
Purchase Orders inventory.transactions.read inventory.transactions.read inventory.transactions.write inventory.transactions.write inventory.transactions.write ✖
Purchasing inventory.transactions.read inventory.transactions.read inventory.transactions.write inventory.transactions.write inventory.transactions.write ✖
Quantity Adjustment inventory.transactions.read inventory.transactions.read inventory.transactions.write inventory.transactions.write inventory.transactions.write ✖
Reasons general.read general.read admin.write admin.write admin.write admin.write
Return from Order inventory.transactions.read inventory.transactions.read ✖ ✖ ✖ ✖
Return to Supplier inventory.transactions.read inventory.transactions.read inventory.transactions.write inventory.transactions.write inventory.transactions.write ✖
Roles users.read users.read users.write users.write users.write users.write
Sections general.read general.read tables.write tables.write tables.write admin.write
Settings general.read ✖ ✖ admin.write ✖ ✖
Shifts operations.read operations.read operations.write ✖ ✖ ✖
Snapshot inventory.transactions.read inventory.transactions.read ✖ ✖ ✖ ✖
Suppliers inventory.settings.read inventory.settings.read inventory.settings.write inventory.settings.write inventory.settings.write inventory.settings.write
Tables general.read general.read tables.write tables.write tables.write admin.write
Tags general.read general.read admin.write admin.write admin.write admin.write
Tax Groups general.read general.read admin.write admin.write admin.write admin.write
Taxes general.read general.read admin.write admin.write admin.write admin.write
Tills operations.read operations.read operations.write ✖ ✖ ✖
Timed Events general.read general.read admin.write admin.write admin.write admin.write
Transfer Orders inventory.transactions.read inventory.transactions.read inventory.transactions.write inventory.transactions.write inventory.transactions.write ✖
Transfer Receiving inventory.transactions.read inventory.transactions.read ✖ inventory.transactions.write ✖ ✖
Transfer Sending inventory.transactions.read inventory.transactions.read inventory.transactions.write inventory.transactions.write inventory.transactions.write ✖
Users users.read users.read users.write users.write users.write users.write
Warehouses general.read general.read admin.write admin.write ✖ ✖
Waste from Order inventory.transactions.read inventory.transactions.read ✖ ✖ ✖ ✖
Last Updated: 22/9/2023, 2:14:04 AM