Lightspeed Commerce

Lightspeed Commerce Variant Attributes API

The Variant Attributes API from Lightspeed Commerce — 2 operation(s) for variant attributes.

GitHub OpenAPI
Business capability
Product Configuration & Variant Management BC-820.40

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /variant_attributes List variant attributes · Retrieve all Variant Attributes #
Ask an LLM
“Which variant attributes like Size or Color are defined in my store?”
“Can I include deleted variant attributes in the list?”
Tell an agent
List all variant attributes.
List variant attributes including deleted ones: {deleted}.
POST /variant_attributes Create a variant attribute · Create a Variant Attribute #
Ask an LLM
“How do I add a new attribute like Size before creating variants?”
“What is needed to define a variant attribute?”
Tell an agent
Create a variant attribute named {name}.
Add {name} as a new attribute for differentiating product variants.
DELETE /variant_attributes/{attribute-id} Delete a variant attribute · Delete a variant attribute #
Ask an LLM
“Why can't I delete a variant attribute that's used by a product family?”
“How do I remove an unused variant attribute?”
Tell an agent destructive · confirm first
Delete variant attribute {attribute-id}.
Remove the unused variant attribute {attribute-id}.
GET /variant_attributes/{attribute-id} Get a single variant attribute · Retrieve a single Variant Attribute #
Ask an LLM
“How do I fetch one variant attribute by ID?”
“Can I look up a variant attribute even if it was deleted?”
Tell an agent
Get variant attribute {attribute-id}.
Show variant attribute {attribute-id}, including if deleted: {deleted}.
PUT /variant_attributes/{attribute-id} Rename a variant attribute · Update a Variant Attribute's #
Ask an LLM
“How do I rename an existing variant attribute?”
“Can I change 'Colour' to 'Color' on an attribute already in use?”
Tell an agent
Rename variant attribute {attribute-id} to {name}.
Update the existing attribute {attribute-id} so its name is {name}.

Documentation

📖
Documentation
https://x-series-api.lightspeedhq.com/docs/introduction
📖
APIReference
https://x-series-api.lightspeedhq.com/reference
📖
GettingStarted
https://x-series-api.lightspeedhq.com/docs/quick_start
📖
Documentation
https://api-portal.lsk.lightspeed.app/
📖
APIReference
https://api-docs.lsk.lightspeed.app/
📖
GettingStarted
https://api-portal.lsk.lightspeed.app/quick-start/intro

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lightspeed/refs/heads/main/openapi/lightspeed-variant-attributes-api-openapi.yml

Other Resources

🔗
ChangeLog
https://x-series-api.lightspeedhq.com/changelog
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/lightspeed/refs/heads/main/llms/lightspeed-llms.txt
🔗
SignUp
https://developers.retail.lightspeed.app/register
🔗
ChangeLog
https://api-docs.lsk.lightspeed.app/changes

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/lightspeed:lightspeed-variant-attributes-api"
All apis 
curl "https://apis.io/api/v1/apis?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.

GitHub Google LinkedIn

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

OpenAPI Specification

lightspeed-variant-attributes-api-openapi.yml Raw ↑ 
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 Variant Attributes 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:
- name: Variant Attributes
paths:
  /variant_attributes:
    get:
      description: 'Retrieve all Variant Attributes.


        🔒 Requires: `products:read` scope'
      operationId: ListVariantAttributes
      parameters:
      - description: Indicates whether deleted items should be included in the response.
        in: query
        name: deleted
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariantAttributesListResponse'
          description: The list of variant attributes.
      summary: Retrieve all Variant Attributes
      tags:
      - Variant Attributes
    post:
      description: 'Variant Attributes are required when creating variants. They are used to specify what properties make a particular SKU different to another. e.g. You may

        have an attribute ''Size'' that lets you differentiate variants based on their size.


        🔒 Requires: `products:write` scope'
      operationId: CreateVariantAttribute
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VariantAttributeCreateUpdateBody'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariantAttributeCreateResponse'
          description: The created variant attribute.
        '422':
          content:
            application/json:
              schema:
                type: object
          description: Error response. Failed to process variant attribute.
      summary: Create a Variant Attribute
      tags:
      - Variant Attributes
  /variant_attributes/{attribute-id}:
    delete:
      description: 'Note you can''t delete a variant attribute that is currently being used by a family.


        🔒 Requires: `products:write` scope'
      operationId: DeleteVariantAttribute
      parameters:
      - description: The object identifier of the Variant Attribute to delete.
        in: path
        name: attribute-id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariantAttributeDeleteResponse'
          description: The deleted variant attribute.
        '404':
          content:
            application/json:
              schema:
                type: object
          description: Error response. Attribute not found.
      summary: Delete a variant attribute
      tags:
      - Variant Attributes
    get:
      description: 'Retrieves a single Variant Attribute with the given id.


        🔒 Requires: `products:read` scope'
      operationId: GetVariantAttributes
      parameters:
      - description: The object identifier of the Variant Attribute to retrieve.
        in: path
        name: attribute-id
        required: true
        schema:
          format: uuid
          type: string
      - description: Indicates whether deleted items should be included in the response.
        in: query
        name: deleted
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariantAttributeResponse'
          description: The variant attribute.
      summary: Retrieve a single Variant Attribute
      tags:
      - Variant Attributes
    put:
      description: 'Updates a Variant Attribute''s name.


        🔒 Requires: `products:write` scope'
      operationId: UpdateVariantAttribute
      parameters:
      - description: The object identifier of the Variant Attribute to update.
        in: path
        name: attribute-id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VariantAttributeCreateUpdateBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariantAttributeUpdateResponse'
          description: The updated variant attribute.
        '404':
          content:
            application/json:
              schema:
                type: object
          description: Error response. Attribute not found.
        '422':
          content:
            application/json:
              schema:
                type: object
          description: Error response. Failed to process variant attribute.
      summary: Update a Variant Attribute's
      tags:
      - Variant Attributes
components:
  schemas:
    VariantAttributeCreateResponse:
      properties:
        data:
          properties:
            created_at:
              description: Timestamp in UTC.
              type: string
            id:
              type: string
            name:
              type: string
            updated_at:
              description: Timestamp in UTC.
              type: string
          type: object
      title: VariantAttributeCreateResponse
      type: object
    VariantAttributeDeleteResponse:
      properties:
        data:
          properties:
            id:
              type: string
          type: object
      title: VariantAttributeDeleteResponse
      type: object
    VariantAttributeCreateUpdateBody:
      properties:
        name:
          example: Size
          type: string
      required:
      - name
      title: VariantAttributeCreateUpdateBody
      type: object
    VariantAttributeUpdateResponse:
      properties:
        data:
          properties:
            id:
              type: string
            name:
              type: string
          type: object
      title: VariantAttributeUpdateResponse
      type: object
    VariantAttributeResponse:
      properties:
        deleted_at:
          description: Timestamp in UTC.
          format: date-time
          type:
          - string
          - 'null'
        id:
          example: 06564c2b-6841-11eb-f2da-d2fb9abb0c90
          format: uuid
          type: string
        name:
          example: Size
          type: string
      title: VariantAttributeResponse
      type: object
    VariantAttributesListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/VariantAttributeResponse'
          type: array
      title: VariantAttributesListResponse
      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