Lightspeed Commerce · OAuth Scopes

Lightspeed Commerce OAuth Scopes

OAuth 2.0 searched

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.

CommercePoint-of-SaleRetailRestaurantInventoryLoyaltyPaymentsE-CommerceOmnichannel
Scopes: 90 Flows: authorizationCode Method: searched

OAuth endpoints

Authorization URL
/oauth/authorize https://secure.retail.lightspeed.app/connect
Token URL
/oauth/token https://{domain_prefix}.retail.lightspeed.app/api/1.0/token
Flows
authorizationCode

Scopes (90)

ScopeDescriptionFlows
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.

Source

OAuth Scopes

Raw ↑
generated: '2026-08-27'
method: searched
source: https://x-series-api.lightspeedhq.com/docs/scopes.md, https://developers.lightspeedhq.com/retail/authentication/scopes/,
  openapi/lightspeed-k-series-openapi.json
schemes:
- name: OAuth2
  source: openapi/lightspeed-k-series-openapi.json
  flows:
  - flow: authorizationCode
    authorizationUrl: /oauth/authorize
    tokenUrl: /oauth/token
  description: 'The Lightspeed Restaurant K-Series APIs support OAuth2 authentication using the [authorization
    code grant flow](https://www.oauth.com/oauth2-servers/server-side-apps/authorization-code/).

    See our [Authorization Quick Start Guide](https://api-portal.lsk.lightspeed.app/quick-start/authentication/authorization-overview)
    for more details on how to authenticate.'
- name: X-Series OAuth 2.0
  product: X-Series
  source: https://x-series-api.lightspeedhq.com/docs/authorization
  flows:
  - flow: authorizationCode
    authorizationUrl: https://secure.retail.lightspeed.app/connect
    tokenUrl: https://{domain_prefix}.retail.lightspeed.app/api/1.0/token
  note: The token response echoes the scopes actually GRANTED in a `scope` field; the access token can
    only call endpoints whose required scopes are a subset of that list. Refresh responses echo them too
    and they do not change unless the app re-authorizes.
- name: R-Series OAuth 2.0
  product: R-Series
  source: https://developers.lightspeedhq.com/retail/authentication/scopes/
  flows:
  - flow: authorizationCode
  note: Scopes mirror in-app employee permissions rather than API resources; employee:all is a full-access
    grant.
scopes:
- scope: audit:read
  description: Read audit and security events
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: billing:partner_subscription:read
  description: Read Billing Partner Subscription.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: billing:partner_subscription:write
  description: Write Billing Partner Subscription.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: business_rules:read
  description: Read business rules.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: business_rules:write
  description: Create and delete business rules.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: channels:read
  description: Read e-commerce channel information.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: consignments:read
  description: Read in-progress inventory counts and historical stock consignments.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: consignments:write:inventory_count
  description: Perform Inventory Counts.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: consignments:write:stock_order
  description: Process stock orders and stock returns.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: consignments:write:stock_transfer
  description: Create, send and receive stock transfers between outlets.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: customers:read
  description: Read customers and customer groups.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: customers:write
  description: Create, update and delete customers and customer groups.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: custom_fields:read
  description: Read custom fields.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: custom_fields:write
  description: Create, update and delete custom fields.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: fulfillments:read
  description: Read sale order fulfillments
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: fulfillments:write
  description: Create and update sale order fulfillments.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: gift_cards:read
  description: Read gift cards and gift card transactions.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: gift_cards:write:issue
  description: Issue a gift card to a customer.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: gift_cards:write:redeem
  description: Redeem or reload an amount against a customers gift card.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: inventory:read
  description: Read current and historical product inventory levels.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: inventory:write
  description: Set reorder points, create custom inventory adjustment reasons, and record stock adjustments.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: outlets:read
  description: Read outlets.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: payments:read
  description: Read Payments.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: payment_types:read
  description: Read payment types, excluding internal payment types.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: products:read
  description: Read products, product types, product images, brands and tags, excluding product costs.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: products:read:price_books
  description: Read product price books.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: products:write
  description: Create and update products (excluding product costs), delete products, upload product images
    and create product types.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: products:write:price_books
  description: Write Products Price Books.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: promotions:read
  description: Read promotions, get products a specific promotion can be used on and find the best promotion
    for a sale and determine the discount.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: promotions:write
  description: Create, update and archive any promotion.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: register:close
  description: Close a register and reconcile payments.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: register:open
  description: Open a register to create sales and payments.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: registers:read
  description: Read registers.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: remote_rules:read
  description: Read remote rules.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: remote_rules:write
  description: Create and delete remote rules.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: retailer:read
  description: Read all your account configuration. E.g. your loyalty ratio, timezone, country and currency.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: sales:read
  description: Read all sales and payments in your account.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: sales:write
  description: Create sales and payments, and adjust, void or return sales.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: serial_numbers:read
  description: Read serial numbers.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: serial_numbers:write
  description: Add and delete serial numbers.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: services:read
  description: Read services
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: services:write
  description: Create, edit services.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: store_credits:read
  description: Read store credit transactions, overall and for customers.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: store_credits:write:issue
  description: Issue store credits to a customer for a return.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: suppliers:read
  description: Read suppliers.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: suppliers:write
  description: Create, update and delete suppliers.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: taxes:read
  description: 'If tax inclusive: Read tax rates and tax rules. If tax exclusive: Read tax rates, tax
    rules and tax groups.'
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: taxes:write
  description: Create, update and delete taxes.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: users:read
  description: Read user information (except user passwords).
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: users:write
  description: Create, update and delete users and customise groups.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: webhooks
  description: Manage webhooks created by the application.
  product: X-Series
  request_style: space-delimited scope parameter
  sources:
  - https://x-series-api.lightspeedhq.com/docs/scopes
- scope: employee:all
  description: Grants full read and write access to the account. This grant will automatically assume
    all access rights that the authorizing user possesses
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:admin
  description: View, create, update, and archive administrative records.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:admin_employees
  description: View, create, update, and archive employees.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:admin_inventory
  description: View, create, update, and archive vendors and manufacturers.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:admin_purchases
  description: View, create, update, and archive payment types, discounts, and taxes.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:admin_shops
  description: View, create, update, and archive shops.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:admin_void_sale
  description: Void sales.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:categories
  description: View, create, update, and archive product categories.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:customers
  description: View, create, update, and archive customers.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:customers_read
  description: View customer accounts.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:customers_view_gift_card_numbers
  description: View the code field unmasked in the response payloads of the credit account endpoints.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:inventory
  description: View, create, update, and archive items and inventory.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:inventory_counts
  description: View, create, update inventory counts.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:inventory_counts_reconcile
  description: Reconcile inventory counts.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:inventory_read
  description: View items and inventory.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:manufacturers
  description: View, create, update, and archive manufacturers.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:product_cost
  description: View and edit product cost values
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:product_edit
  description: create, update, and archive products
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:purchase_orders
  description: View, create, and update purchase orders
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:register
  description: Create new sales and read sales history.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:register_layaway
  description: Create layaway sales.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:register_read
  description: Read sales history.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:register_refund
  description: Create refund sales.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:reports
  description: View reports.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:special_orders
  description: View, create and update special orders.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:tags
  description: View, create, update, and archive product tags.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:transfers
  description: View, create, update, and archive transfers.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:vendors
  description: View, create, update and archive vendors.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:vendor_returns
  description: View vendor returns.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: employee:workbench
  description: View, create, update, and archive work orders.
  product: R-Series
  request_style: space-delimited scope parameter
  sources:
  - https://developers.lightspeedhq.com/retail/authentication/scopes/
- scope: financial-api
  description: Read financial data
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-k-series-openapi.json
  product: K-Series
  request_style: space-delimited scope parameter
- scope: id-cards
  description: Create and manage ID card batches and cards.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-k-series-openapi.json
  product: K-Series
  request_style: space-delimited scope parameter
- scope: items
  description: Read and write items
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-k-series-openapi.json
  product: K-Series
  request_style: space-delimited scope parameter
- scope: orders-api
  description: '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.'
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-k-series-openapi.json
  product: K-Series
  request_style: space-delimited scope parameter
- scope: propertymanagement
  description: Read and write Property Management System configurations.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-k-series-openapi.json
  product: K-Series
  request_style: space-delimited scope parameter
- scope: reservation-***
  description: 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.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-k-series-openapi.json
  product: K-Series
  request_style: space-delimited scope parameter
- scope: reservations-api
  description: '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).'
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-k-series-openapi.json
  product: K-Series
  request_style: space-delimited scope parameter
- scope: staff-api
  description: Read shift information, read and write user information.
  flows:
  - authorizationCode
  sources:
  - openapi/lightspeed-k-series-openapi.json
  product: K-Series
  request_style: space-delimited scope parameter
- scope: user-token-by-authorization-code
  sources:
  - openapi/lightspeed-k-series-openapi.json
  product: K-Series
  request_style: space-delimited scope parameter
  description: '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.'
  declared_in_flow: false
docs:
- https://x-series-api.lightspeedhq.com/docs/scopes
- https://developers.lightspeedhq.com/retail/authentication/scopes/
- https://api-portal.lsk.lightspeed.app/quick-start/authentication/authorization-overview
note: Three separate OAuth scope vocabularies, one per product line, with no shared naming. X-Series uses
  resource:action (products:read) with sub-actions (consignments:write:stock_order); R-Series uses employee:permission
  (employee:inventory); K-Series uses product-area names (orders-api, financial-api). A partner integrating
  two Lightspeed products must learn two unrelated permission models.
counts:
  x_series: 50
  r_series: 30
  k_series: 9
  total: 90

Work with this as data

Every scope set here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for oauth scopes

4 MCP tools reach this
  • find_scopesBrowse and filter every scope set in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This scope set
curl "https://apis.io/api/v1/scopes/lightspeed-scopes"
All oauth scopes
curl "https://apis.io/api/v1/scopes?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.