Lightspeed Commerce OAuth Scopes
Lightspeed Commerce publishes 90 OAuth 2.0 scopes via the authorizationCode flow. Scopes are the fine-grained permissions an application requests at authorization time to act against the Lightspeed Commerce API on a user’s behalf.
Tokens are issued from /oauth/token.
This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.
OAuth endpoints
/oauth/authorize https://secure.retail.lightspeed.app/connect
/oauth/token https://{domain_prefix}.retail.lightspeed.app/api/1.0/token
authorizationCode
Scopes (90)
| Scope | Description | Flows |
|---|---|---|
| audit:read | Read audit and security events | |
| billing:partner_subscription:read | Read Billing Partner Subscription. | |
| billing:partner_subscription:write | Write Billing Partner Subscription. | |
| business_rules:read | Read business rules. | |
| business_rules:write | Create and delete business rules. | |
| channels:read | Read e-commerce channel information. | |
| consignments:read | Read in-progress inventory counts and historical stock consignments. | |
| consignments:write:inventory_count | Perform Inventory Counts. | |
| consignments:write:stock_order | Process stock orders and stock returns. | |
| consignments:write:stock_transfer | Create, send and receive stock transfers between outlets. | |
| customers:read | Read customers and customer groups. | |
| customers:write | Create, update and delete customers and customer groups. | |
| custom_fields:read | Read custom fields. | |
| custom_fields:write | Create, update and delete custom fields. | |
| fulfillments:read | Read sale order fulfillments | |
| fulfillments:write | Create and update sale order fulfillments. | |
| gift_cards:read | Read gift cards and gift card transactions. | |
| gift_cards:write:issue | Issue a gift card to a customer. | |
| gift_cards:write:redeem | Redeem or reload an amount against a customers gift card. | |
| inventory:read | Read current and historical product inventory levels. | |
| inventory:write | Set reorder points, create custom inventory adjustment reasons, and record stock adjustments. | |
| outlets:read | Read outlets. | |
| payments:read | Read Payments. | |
| payment_types:read | Read payment types, excluding internal payment types. | |
| products:read | Read products, product types, product images, brands and tags, excluding product costs. | |
| products:read:price_books | Read product price books. | |
| products:write | Create and update products (excluding product costs), delete products, upload product images and create product types. | |
| products:write:price_books | Write Products Price Books. | |
| promotions:read | Read promotions, get products a specific promotion can be used on and find the best promotion for a sale and determine the discount. | |
| promotions:write | Create, update and archive any promotion. | |
| register:close | Close a register and reconcile payments. | |
| register:open | Open a register to create sales and payments. | |
| registers:read | Read registers. | |
| remote_rules:read | Read remote rules. | |
| remote_rules:write | Create and delete remote rules. | |
| retailer:read | Read all your account configuration. E.g. your loyalty ratio, timezone, country and currency. | |
| sales:read | Read all sales and payments in your account. | |
| sales:write | Create sales and payments, and adjust, void or return sales. | |
| serial_numbers:read | Read serial numbers. | |
| serial_numbers:write | Add and delete serial numbers. | |
| services:read | Read services | |
| services:write | Create, edit services. | |
| store_credits:read | Read store credit transactions, overall and for customers. | |
| store_credits:write:issue | Issue store credits to a customer for a return. | |
| suppliers:read | Read suppliers. | |
| suppliers:write | Create, update and delete suppliers. | |
| taxes:read | If tax inclusive: Read tax rates and tax rules. If tax exclusive: Read tax rates, tax rules and tax groups. | |
| taxes:write | Create, update and delete taxes. | |
| users:read | Read user information (except user passwords). | |
| users:write | Create, update and delete users and customise groups. | |
| webhooks | Manage webhooks created by the application. | |
| employee:all | Grants full read and write access to the account. This grant will automatically assume all access rights that the authorizing user possesses | |
| employee:admin | View, create, update, and archive administrative records. | |
| employee:admin_employees | View, create, update, and archive employees. | |
| employee:admin_inventory | View, create, update, and archive vendors and manufacturers. | |
| employee:admin_purchases | View, create, update, and archive payment types, discounts, and taxes. | |
| employee:admin_shops | View, create, update, and archive shops. | |
| employee:admin_void_sale | Void sales. | |
| employee:categories | View, create, update, and archive product categories. | |
| employee:customers | View, create, update, and archive customers. | |
| employee:customers_read | View customer accounts. | |
| employee:customers_view_gift_card_numbers | View the code field unmasked in the response payloads of the credit account endpoints. | |
| employee:inventory | View, create, update, and archive items and inventory. | |
| employee:inventory_counts | View, create, update inventory counts. | |
| employee:inventory_counts_reconcile | Reconcile inventory counts. | |
| employee:inventory_read | View items and inventory. | |
| employee:manufacturers | View, create, update, and archive manufacturers. | |
| employee:product_cost | View and edit product cost values | |
| employee:product_edit | create, update, and archive products | |
| employee:purchase_orders | View, create, and update purchase orders | |
| employee:register | Create new sales and read sales history. | |
| employee:register_layaway | Create layaway sales. | |
| employee:register_read | Read sales history. | |
| employee:register_refund | Create refund sales. | |
| employee:reports | View reports. | |
| employee:special_orders | View, create and update special orders. | |
| employee:tags | View, create, update, and archive product tags. | |
| employee:transfers | View, create, update, and archive transfers. | |
| employee:vendors | View, create, update and archive vendors. | |
| employee:vendor_returns | View vendor returns. | |
| employee:workbench | View, create, update, and archive work orders. | |
| financial-api | Read financial data | authorizationCode |
| id-cards | Create and manage ID card batches and cards. | authorizationCode |
| items | Read and write items | authorizationCode |
| orders-api | Read business information, floors, menus, discounts, and production instructions. Read and write orders and payments. Read [Rich Item](https://api-docs.lsk.lightspeed.app/prod/group/endpoint-rich-item) data. | authorizationCode |
| propertymanagement | Read and write Property Management System configurations. | authorizationCode |
| reservation-*** | Platform reservations scope. The `***` will be replaced by the [platform-code](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-servicesetbyplatformcode#operation-reservation-servicesetbyplatformcode-platform-code) of the reservation platform. | authorizationCode |
| reservations-api | Configure *legacy* reservation integrations. **Note:** This API will eventually be deprecated in favour of the new [Reservations for Platforms](https://api-docs.lsk.lightspeed.app/group/endpoint-reservations-for-platforms) API. More information on the new reservations workflows can be found in the [Integration Guide](https://api-portal.lsk.lightspeed.app/category/reservations). | authorizationCode |
| staff-api | Read shift information, read and write user information. | authorizationCode |
| user-token-by-authorization-code | Referenced in the security[] block of the Reservations for Platforms operations but NOT declared in the OAuth2 authorizationCode scopes map. An undeclared scope: a client cannot request it from the scope reference, only discover it by reading the operation. |
📄 Provider scope reference: https://x-series-api.lightspeedhq.com/docs/scopeshttps://developers.lightspeedhq.com/retail/authentication/scopes/https://api-portal.lsk.lightspeed.app/quick-start/authentication/authorization-overview
Source
OAuth Scopes
Work with this as data
Every scope set here is available over the APIs.io API and to AI agents over MCP.