Clover · OAuth Scopes

Clover OAuth Scopes

OAuth 2.0 searched

Clover publishes 13 OAuth 2.0 scopes via the authorizationCode flow. Scopes are the fine-grained permissions an application requests at authorization time to act against the Clover API on a user’s behalf.

Tokens are issued from https://api.clover.com/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.

RestaurantPOSPaymentsRetailSMBHardware

Scopes: 13 Flows: authorizationCode Method: searched

OAuth endpoints

Authorization URL
https://www.clover.com/oauth/authorize

Token URL
https://api.clover.com/oauth/token

Flows
authorizationCode

Scopes (13)

Scope	Description	Flows
Read customers	Required to read customer information.
Write customers	Required to add and update customer information.
Read employees	Required to read employee information, for example, to view who created an order.
Write employees	Required to add and update employees.
Read inventory	Required to read inventory.
Write inventory	Required to add and update inventory.
Read merchant	Required to read merchant properties, for example, to view basic information for a merchant.
Write merchant	Required to update merchant properties.
Read orders	Required to read order information.
Write orders	Required to add and update an order.
Read payments	Required to read payment information.
Write payments	Required to add and update payment records.
Online payments	Ecommerce API permission for Clover apps providing card-not-present payments; required to create charges and process payments.

📄 Provider scope reference: https://docs.clover.com/dev/docs/permissions

Source

OAuth Scopes

generated: '2026-07-11'
method: searched
source: openapi/clover-ecommerce-api-openapi.yml
docs: https://docs.clover.com/dev/docs/permissions
note: Clover does not use an OAuth scope parameter; access is governed by Read/Write
  app permissions per category, configured in the Developer Dashboard and granted
  by the merchant when installing the app via the OAuth flow
  (https://docs.clover.com/dev/docs/permissions,
  https://docs.clover.com/dev/docs/ecommerce-app-permissions).
schemes:
- name: OAuth2
  source: openapi/clover-ecommerce-api-openapi.yml
  flows:
  - flow: authorizationCode
    authorizationUrl: https://www.clover.com/oauth/authorize
    tokenUrl: https://api.clover.com/oauth/token
  description: OAuth 2.0 token or Ecommerce (PAKMS) API key.
scopes:
- scope: Read customers
  description: Required to read customer information.
  sources:
  - https://docs.clover.com/dev/docs/permissions
- scope: Write customers
  description: Required to add and update customer information.
  sources:
  - https://docs.clover.com/dev/docs/permissions
- scope: Read employees
  description: Required to read employee information, for example, to view who created
    an order.
  sources:
  - https://docs.clover.com/dev/docs/permissions
- scope: Write employees
  description: Required to add and update employees.
  sources:
  - https://docs.clover.com/dev/docs/permissions
- scope: Read inventory
  description: Required to read inventory.
  sources:
  - https://docs.clover.com/dev/docs/permissions
- scope: Write inventory
  description: Required to add and update inventory.
  sources:
  - https://docs.clover.com/dev/docs/permissions
- scope: Read merchant
  description: Required to read merchant properties, for example, to view basic information
    for a merchant.
  sources:
  - https://docs.clover.com/dev/docs/permissions
- scope: Write merchant
  description: Required to update merchant properties.
  sources:
  - https://docs.clover.com/dev/docs/permissions
- scope: Read orders
  description: Required to read order information.
  sources:
  - https://docs.clover.com/dev/docs/permissions
- scope: Write orders
  description: Required to add and update an order.
  sources:
  - https://docs.clover.com/dev/docs/permissions
- scope: Read payments
  description: Required to read payment information.
  sources:
  - https://docs.clover.com/dev/docs/permissions
- scope: Write payments
  description: Required to add and update payment records.
  sources:
  - https://docs.clover.com/dev/docs/permissions
- scope: Online payments
  description: Ecommerce API permission for Clover apps providing card-not-present
    payments; required to create charges and process payments.
  sources:
  - https://docs.clover.com/dev/docs/ecommerce-app-permissions