Lightspeed Commerce

Lightspeed Commerce PMS API

The PMS API from Lightspeed Commerce — 3 operation(s) for pms.

GitHub OpenAPI

Operations 6

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 /pms/v1/business-locations/{businessLocationId}/revenue-centers List POS configurations for PMS revenue centers · Get PMS Revenue Centers #
Ask an LLM
“Which POS configurations can I map to hotel PMS revenue centers?”
“How do I find revenue centers for a business location?”
Tell an agent
List the revenue centers for business location {businessLocationId}.
Show POS configurations I can map to PMS revenue centers at location {businessLocationId}.
GET /pms/v1/providers/{id} Get a PMS provider · Get a PMS provider by ID #
Ask an LLM
“How do I see the settings of a PMS provider I created?”
“Can I fetch a PMS provider created by another OAuth client?”
Tell an agent
Get PMS provider {id}.
Show the endpoint and features of PMS provider {id}.
PUT /pms/v1/providers/{id} Update a PMS provider · Update a PMS provider #
Ask an LLM
“How do I change the endpoint or API key for my PMS provider?”
“Can I update the features enabled on an existing PMS provider?”
Tell an agent
Update PMS provider {id} to use endpoint {endpoint} and API key {apiKey}.
Rename existing PMS provider {id} to {name} with features {features}.
DELETE /pms/v1/providers/{id} Delete a PMS provider · Delete a PMS provider #
Ask an LLM
“How do I permanently remove a PMS integration from a location?”
“Can I disconnect a hotel PMS provider I no longer use?”
Tell an agent destructive · confirm first
Delete PMS provider {id}.
Permanently remove PMS provider {id} from its business location.
GET /pms/v1/providers List PMS providers · Get PMS providers #
Ask an LLM
“Which PMS providers have I configured for my locations?”
“Can I filter PMS providers by business location?”
Tell an agent
List the PMS providers I have configured.
List PMS providers for business location {businessLocationId}.
POST /pms/v1/providers Create a PMS provider · Create PMS provider #
Ask an LLM
“How do I connect a property management system to a restaurant location?”
“What details do I need to register a new PMS provider?”
Tell an agent
Create PMS provider {name} at location {businessLocationId} with endpoint {endpoint} and API key {apiKey}.
Register a new PMS provider for location {businessLocationId} with features {features}.

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://artifacts.apis.io/lightspeed/openapi/lightspeed-pms-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-pms-api-get-provider-schema.json
📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-pms-api-provider-features-schema.json
📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-pms-api-provider-endpoint-schema.json
📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-pms-api-business-location-id-schema.json
📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-pms-api-provider-api-key-schema.json
📊
JSONSchema
https://artifacts.apis.io/lightspeed/json-schema/lightspeed-pms-api-provider-name-schema.json

Other Resources

🔗
ChangeLog
https://x-series-api.lightspeedhq.com/changelog
🔗
LLMsTxt
https://artifacts.apis.io/lightspeed/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-pms-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-pms-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Lightspeed PMS API
  version: 1.0.0
  x-logo:
    altText: Lightspeed Commerce
    url: static/lightspeed@2x.png
  description: 'Operations tagged PMS across 2 of this provider''s published API definitions: lightspeed-k-series-openapi.json, lightspeed-k-series-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.trial.lsk.lightspeed.app
  description: Demo URL
  x-bump-branch-name: demo
- url: https://api.lsk.lightspeed.app
  description: Production URL
  x-bump-branch-name: prod
tags:
- name: PMS
paths:
  /pms/v1/business-locations/{businessLocationId}/revenue-centers:
    get:
      summary: Get PMS Revenue Centers
      operationId: pms-apiGetRevenueCenters
      description: Returns a list of all POS Configurations which can be mapped to PMS Revenue Centers. For more details on revenue centers, see our Integration Guide.
      tags:
      - PMS
      parameters:
      - name: businessLocationId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/pms-apiBusinessLocationId'
      responses:
        '200':
          description: Found a list of Revenue Centers
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      $ref: '#/components/schemas/pms-apiRevenueCenterId'
                    name:
                      $ref: '#/components/schemas/pms-apiRevenueCenterName'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/pms-apiErrorResponse'
        '404':
          description: Invalid input business location id
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/pms-apiErrorResponse'
      security:
      - OAuth2:
        - propertymanagement
    servers:
    - url: https://api.trial.lsk.lightspeed.app
      description: Demo URL
      x-bump-branch-name: demo
    - url: https://api.lsk.lightspeed.app
      description: Production URL
      x-bump-branch-name: prod
  /pms/v1/providers/{id}:
    get:
      summary: Get a PMS provider by ID
      operationId: pms-apiGetProvider
      description: 'Returns the details of a specific PMS provider.


        Only PMS providers created by the authenticated OAuth client will be returned.'
      tags:
      - PMS
      parameters:
      - in: path
        schema:
          $ref: '#/components/schemas/pms-apiProviderId'
        name: id
        required: true
      responses:
        '200':
          description: Provider found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pms-apiGetProvider'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/pms-apiErrorResponse'
        '404':
          description: Provider not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/pms-apiErrorResponse'
      security:
      - OAuth2:
        - propertymanagement
    put:
      summary: Update a PMS provider
      operationId: pms-apiUpdateProvider
      description: 'Modifies the values of an existing **PMS** provider.


        Only PMS providers created by the authenticated OAuth client can be updated.'
      tags:
      - PMS
      parameters:
      - in: path
        schema:
          $ref: '#/components/schemas/pms-apiProviderId'
        name: id
        required: true
      requestBody:
        content:
          application/json:
            schema:
              required:
              - name
              - endpoint
              - apiKey
              - features
              properties:
                name:
                  $ref: '#/components/schemas/pms-apiProviderName'
                endpoint:
                  $ref: '#/components/schemas/pms-apiProviderEndpoint'
                apiKey:
                  $ref: '#/components/schemas/pms-apiProviderApiKey'
                features:
                  $ref: '#/components/schemas/pms-apiProviderFeatures'
              type: object
        required: true
      responses:
        '200':
          description: Provider updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pms-apiGetProvider'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/pms-apiErrorResponse'
        '404':
          description: Provider not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/pms-apiErrorResponse'
      security:
      - OAuth2:
        - propertymanagement
    delete:
      summary: Delete a PMS provider
      operationId: pms-apiDeleteProvider
      description: Permanently removes a PMS provider from a businessLocation.
      tags:
      - PMS
      parameters:
      - in: path
        schema:
          $ref: '#/components/schemas/pms-apiProviderId'
        name: id
        required: true
      responses:
        '200':
          description: Provider deleted
          content:
            application/json:
              schema:
                type: integer
                format: int64
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/pms-apiErrorResponse'
        '404':
          description: Provider not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/pms-apiErrorResponse'
      security:
      - OAuth2:
        - propertymanagement
    servers:
    - url: https://api.trial.lsk.lightspeed.app
      description: Demo URL
      x-bump-branch-name: demo
    - url: https://api.lsk.lightspeed.app
      description: Production URL
      x-bump-branch-name: prod
  /pms/v1/providers:
    get:
      summary: Get PMS providers
      operationId: pms-apiGetProviders
      description: Returns a list of PMS providers that have been configured for the business location. Only PMS providers created by the authenticated OAuth client will be returned.
      tags:
      - PMS
      parameters:
      - in: query
        schema:
          $ref: '#/components/schemas/pms-apiBusinessLocationId'
        name: businessLocationId
        required: false
      responses:
        '200':
          description: Result
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/pms-apiGetProvider'
      security:
      - OAuth2:
        - propertymanagement
    post:
      summary: Create PMS provider
      operationId: pms-apiCreateProvider
      description: Creates a new PMS provider for the businessLocation.
      tags:
      - PMS
      requestBody:
        content:
          application/json:
            schema:
              required:
              - name
              - endpoint
              - apiKey
              - features
              - businessLocationId
              properties:
                businessLocationId:
                  $ref: '#/components/schemas/pms-apiBusinessLocationId'
                name:
                  $ref: '#/components/schemas/pms-apiProviderName'
                endpoint:
                  $ref: '#/components/schemas/pms-apiProviderEndpoint'
                apiKey:
                  $ref: '#/components/schemas/pms-apiProviderApiKey'
                features:
                  $ref: '#/components/schemas/pms-apiProviderFeatures'
              type: object
        required: true
      responses:
        '200':
          description: Provider created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pms-apiGetProvider'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/pms-apiErrorResponse'
        '404':
          description: Provider not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/pms-apiErrorResponse'
      security:
      - OAuth2:
        - propertymanagement
    servers:
    - url: https://api.trial.lsk.lightspeed.app
      description: Demo URL
      x-bump-branch-name: demo
    - url: https://api.lsk.lightspeed.app
      description: Production URL
      x-bump-branch-name: prod
components:
  schemas:
    pms-apiProviderName:
      description: The name of the PMS provider.
      type: string
      minLength: 1
      maxLength: 255
      example: My PMS Provider
    pms-apiProviderId:
      description: The unique identifier for the provider.
      type: integer
      format: int64
      example: 3012455645
    pms-apiRevenueCenterId:
      example: 343243933
      description: The unique identifier for the revenue center.
      type: integer
      format: int64
    pms-apiProviderEndpoint:
      description: The endpoint of the PMS provider. This is where Lightspeed will send PMS requests.
      type: string
      minLength: 1
      maxLength: 255
      example: http://integration.com/pms/endpoint
    pms-apiBusinessLocationId:
      description: The unique identifier for the business location.
      type: integer
      format: int64
      example: 45454565682155
    pms-apiProviderFeature:
      type: string
      enum:
      - SEARCH_BY_NAME
      - MIRRORING
      - PARTIAL_PAYMENTS
      - MULTI_PAYMENTS
      - SERVICE_CHARGE
      - ENRICHED_PAYLOAD
      example: MIRRORING
    pms-apiRevenueCenterName:
      example: Bar
      description: The name of the revenue center.
      type: string
    pms-apiErrorResponse:
      type: object
      properties:
        status:
          type: string
        timestamp:
          type: string
          format: date-time
        message:
          type: string
        apiSubExceptions:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              rejectedValue:
                type: object
              message:
                type: string
    pms-apiGetProvider:
      properties:
        id:
          description: The unique identifier for the provider.
          type: integer
          format: int64
          example: 3012455645
        name:
          description: The name of the PMS provider.
          type: string
        apiKey:
          description: The API key for the PMS provider.
          type: string
          example: fake-secret
        businessLocationId:
          description: The unique identifier for the business location.
          type: integer
          format: int64
          example: 45454565682155
        endpoint:
          description: The endpoint of the PMS provider. This is where Lightspeed will send PMS requests.
          type: string
          example: http://integration.com/pms/endpoint
        features:
          description: The optional features that the PMS provider supports. See the [Integration Guide](https://api-portal.lsk.lightspeed.app/category/property-management-systems) for more details.
          items:
            $ref: '#/components/schemas/pms-apiProviderFeature'
          type: array
          uniqueItems: true
      type: object
    pms-apiProviderApiKey:
      description: The API key for the PMS provider.
      type: string
      minLength: 1
      maxLength: 255
      example: fake-secret
    pms-apiProviderFeatures:
      type: array
      uniqueItems: true
      description: The optional features that the PMS provider supports. See the [Integration Guide](https://api-portal.lsk.lightspeed.app/category/property-management-systems) for more details.
      items:
        $ref: '#/components/schemas/pms-apiProviderFeature'
  securitySchemes:
    OAuth2:
      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.

        '
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /oauth/authorize
          tokenUrl: /oauth/token
          scopes:
            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.'
            financial-api: Read financial data
            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.
            items: Read and write items
            propertymanagement: Read and write Property Management System configurations.
            id-cards: Create and manage ID card batches and cards.
            staff-api: Read shift information, read and write user information.
            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).'
x-refined-from:
- lightspeed-k-series-openapi.json
- lightspeed-k-series-openapi.yml
x-tagGroups:
- name: Rich Item API
  tags:
  - Rich Item
  - Migration
- name: Tax Preview API
  tags:
  - Tax Breakdown
- name: Staff Api
  tags:
  - Staff
  - Internal Staff
- name: Reservation API
  tags:
  - Reservations for Platforms
- name: PMS API
  tags:
  - PMS
- name: Items API
  tags:
  - Items
  - ItemsV2
  - Menus
  - Buttons
  - Production Instructions
  - Inventory
  - Combos
  - Groups
  - MenusV2
  - Accounting Group
  - IntegrationMenu
  - Price Lists
  - Products
  - ItemAppearance
  - Modifiers
  - ModifierGroups
  - Allergens
  - Locales
  - RichItem
- name: id-cards-api API
  tags:
  - ID Cards
- name: Financial API
  tags:
  - Financial
  - FinancialV2
- name: Online Ordering API
  tags:
  - Order and Pay
  - 'Order and Pay: Webhook'