Lightspeed Commerce Product Types API

openapi: 3.2.0
info:
  contact:
    email: x-series.api@lightspeedhq.com
    name: Lightspeed Developer Relations
    url: https://developers.retail.lightspeed.app
  description: Lightspeed Retail (X-Series) API.
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://developers.lightspeedhq.com/terms
  title: 2026-07 Product Types API
  version: 2026-07
servers:
- url: https://{domain_prefix}.retail.lightspeed.app/api/2026-07
  variables:
    domain_prefix:
      default: example
      description: Domain prefix of the store to be operated on
security:
- bearerAuth: []
tags:
- description: Product Type operations
  name: Product Types
paths:
  /product_types:
    get:
      deprecated: true
      description: '**DEPRECATED**  We recommend using the product_categories endpoint instead.


        Returns a paginated list of product types.


        🔒 Requires: `products:read` scope'
      operationId: ListProductTypes
      parameters:
      - description: The lower limit for the version numbers to be included in the response.
        in: query
        name: after
        schema:
          format: int64
          type: integer
      - description: The upper limit for the version numbers to be included in the response.
        in: query
        name: before
        schema:
          format: int64
          type: integer
      - description: The maximum number of items to be returned in the response.
        in: query
        name: page_size
        schema:
          type: integer
      - description: Indicates whether deleted items should be included in the response.
        in: query
        name: deleted
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                - id: b1e2babe-f019-11e3-a0f5-b8ca3a64f8f4
                  name: General
                - category_path:
                  - id: b1e2babe-f019-11e3-a0f5-b8ca3a64f8f4
                    name: General
                  - id: b8ca3a65-0183-11e4-fbb5-3a61730ca2ef
                    name: Test type
                  id: b8ca3a65-0183-11e4-fbb5-3a61730ca2ef
                  leaf_category: true
                  name: Test type
                - id: bc305bf6-6183-11e4-f15a-162d346b231e
                  name: Enrollment Packages
              schema:
                $ref: '#/components/schemas/ProductTypeCollection'
          description: ''
      summary: List product types
      tags:
      - Product Types
  /product_types/{product_type_id}:
    get:
      description: 'Returns a single product type with a given ID.


        🔒 Requires: `products:read` scope'
      operationId: GetProductTypeByID
      parameters:
      - description: The product type id
        in: path
        name: product_type_id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  category_path:
                  - id: b1e2babe-f019-11e3-a0f5-b8ca3a64f8f4
                    name: General
                  - id: b8ca3a65-0183-11e4-fbb5-3a61730ca2ef
                    name: Test type
                  id: b1e2babe-f019-11e3-a0f5-b8ca3a64f8f4
                  leaf_category: true
                  name: General
                  version: 449902
              schema:
                $ref: '#/components/schemas/ProductTypeResponse'
          description: ''
      summary: Get a single product type
      tags:
      - Product Types
components:
  schemas:
    Version:
      description: An object containing the highest and lowest version numbers for all items of the returned collection.
      properties:
        max:
          description: Highest version number of the payload, or `null` when the result set is empty.
          format: int64
          type:
          - integer
          - 'null'
        min:
          description: Lowest version number of the payload, or `null` when the result set is empty.
          format: int64
          type:
          - integer
          - 'null'
      required:
      - max
      - min
      type: object
    ProductType:
      properties:
        category_path:
          description: The path of this product type (now product category) in the hierarchy.
          items:
            $ref: '#/components/schemas/ProductCategoryPath'
          type: array
        deleted_at:
          description: Deletion timestamp in UTC.
          type:
          - string
          - 'null'
        id:
          description: Auto-generated object ID.
          type: string
        leaf_category:
          description: Is this product type (now product category) at the bottom of the hierarchy.
          type: boolean
        name:
          description: The Product Type name.
          type: string
        version:
          description: Auto-incrementing object version number.
          format: int64
          type: integer
      required:
      - name
      - id
      - leaf_category
      title: Product Type
      type: object
    ProductCategoryPath:
      properties:
        id:
          description: Object id of the Product Type in the path.
          type: string
        name:
          description: The Product Type name.
          type: string
      required:
      - id
      - name
      title: Product Category Path
      type: object
    ProductTypeResponse:
      properties:
        data:
          $ref: '#/components/schemas/ProductType'
      title: Product Type Response
      type: object
    ProductTypeCollection:
      properties:
        data:
          description: An array of Product Type objects wrapped in top level `data` object.
          items:
            $ref: '#/components/schemas/ProductType'
          type: array
        version:
          $ref: '#/components/schemas/Version'
      required:
      - data
      - version
      title: Product Type Collection
      type: object
  securitySchemes:
    bearerAuth:
      description: Bearer Token for API authentication.
      scheme: bearer
      type: http
externalDocs:
  description: List of tz database time zones
  url: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones