Lightspeed Catalog API

openapi: 3.2.0
info:
  title: Lightspeed Retail R-Series Catalog API
  description: 'OpenAPI 3.1 representation of the Lightspeed Retail R-Series REST API

    (the original Lightspeed Retail / Retail Pro cloud POS). The R-Series API

    is documented at https://developers.lightspeedhq.com/retail/introduction/introduction/

    and exposes account-scoped resources under

    https://api.lightspeedapp.com/API/V3/Account/{accountID}. It uses OAuth 2.0

    with scope-based access control and supports both JSON (`.json`) and XML

    response formats. The numeric `accountID` is not the OAuth client_id; it

    must be resolved via `GET /API/V3/Account.json` immediately after the token

    exchange and is required for every subsequent account-scoped call.

    '
  version: 3.0.0
  contact:
    name: Lightspeed Commerce
    url: https://developers.lightspeedhq.com/retail/introduction/introduction/
  x-generated-from: documentation
  x-last-validated: '2026-06-02'
  x-source-url: https://developers.lightspeedhq.com/retail/introduction/introduction/
servers:
- url: https://api.lightspeedapp.com/API/V3
  description: Lightspeed Retail R-Series API host.
security:
- OAuth2: []
tags:
- name: Catalog
  description: Categories, manufacturers, and vendors that classify items.
paths:
  /Account/{accountID}/Category.json:
    get:
      summary: Lightspeed List Categories
      operationId: getCategories
      description: Returns the item categories defined for the account.
      tags:
      - Catalog
      security:
      - OAuth2:
        - employee:inventory_read
      parameters:
      - $ref: '#/components/parameters/accountID'
      responses:
        '200':
          description: A page of categories.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Category:
                    type: array
                    items:
                      $ref: '#/components/schemas/Category'
              examples:
                GetCategories200Example:
                  summary: Default getCategories 200 response
                  x-microcks-default: true
                  value:
                    Category:
                    - categoryID: '500123'
                      name: Sample name
                      parentID: '500123'
                      fullPathName: Sample fullPathName
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Account/{accountID}/Manufacturer.json:
    get:
      summary: Lightspeed List Manufacturers
      operationId: getManufacturers
      description: Returns the manufacturers defined for the account.
      tags:
      - Catalog
      security:
      - OAuth2:
        - employee:inventory_read
      parameters:
      - $ref: '#/components/parameters/accountID'
      responses:
        '200':
          description: A page of manufacturers.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Manufacturer:
                    type: array
                    items:
                      $ref: '#/components/schemas/Manufacturer'
              examples:
                GetManufacturers200Example:
                  summary: Default getManufacturers 200 response
                  x-microcks-default: true
                  value:
                    Manufacturer:
                    - manufacturerID: '500123'
                      name: Sample name
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /Account/{accountID}/Vendor.json:
    get:
      summary: Lightspeed List Vendors
      operationId: getVendors
      description: Returns the vendors (suppliers) defined for the account.
      tags:
      - Catalog
      security:
      - OAuth2:
        - employee:inventory_read
      parameters:
      - $ref: '#/components/parameters/accountID'
      responses:
        '200':
          description: A page of vendors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Vendor:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vendor'
              examples:
                GetVendors200Example:
                  summary: Default getVendors 200 response
                  x-microcks-default: true
                  value:
                    Vendor:
                    - vendorID: '500123'
                      name: Sample name
                      accountNumber: example
                      contactID: '500123'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    accountID:
      name: accountID
      in: path
      required: true
      description: The numeric Lightspeed Retail account identifier, resolved via GET /Account.json.
      schema:
        type: string
  schemas:
    Category:
      type: object
      description: An item category used to classify inventory.
      properties:
        categoryID:
          type: string
          description: Unique category identifier.
        name:
          type: string
          description: Category name.
        parentID:
          type: string
          description: Identifier of the parent category.
        fullPathName:
          type: string
          description: Fully qualified category path.
    Vendor:
      type: object
      description: A vendor (supplier) of inventory items.
      properties:
        vendorID:
          type: string
          description: Unique vendor identifier.
        name:
          type: string
          description: Vendor name.
        accountNumber:
          type: string
          description: Merchant account number with the vendor.
        contactID:
          type: string
          description: Identifier of the related contact record.
    Manufacturer:
      type: object
      description: A manufacturer of inventory items.
      properties:
        manufacturerID:
          type: string
          description: Unique manufacturer identifier.
        name:
          type: string
          description: Manufacturer name.
  securitySchemes:
    OAuth2:
      type: oauth2
      description: OAuth 2.0 authorization-code flow with scope-based access control.
      flows:
        authorizationCode:
          authorizationUrl: https://cloud.lightspeedapp.com/oauth/authorize.php
          tokenUrl: https://cloud.lightspeedapp.com/oauth/access_token.php
          scopes:
            employee:all: Full access to all account resources.
            employee:admin: Manage employees and shops.
            employee:inventory: Create and modify inventory items.
            employee:inventory_read: Read inventory items and catalog.
            employee:register: Create sales at the register.
            employee:reports: Read sales and reporting data.
            employee:customers: Create and modify customers.
            employee:customers_read: Read customers.