LIlightspeed
PMS

Create PMS provider

Changed on

Creates a new PMS provider for the businessLocation.

post/pms/v1/providers

Request

  • Base URL
    https://api.trial.lsk.lightspeed.app
  • URL
    https://api.trial.lsk.lightspeed.app/pms/v1/providers
  • Auth
    OAuth 2
    Authorization code: https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/auth
    Token URL: https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/token scopes: propertymanagement

Request body

businessLocationIdinteger required

The unique identifier for the business location.

namestring required

The name of the PMS provider.

endpointstring required

The endpoint of the PMS provider. This is where Lightspeed will send PMS requests.

apiKeystring required

The API key for the PMS provider.

featuresPmsApiProviderFeature[] required

The optional features that the PMS provider supports. See the Integration Guide for more details.

Example request

{
  "businessLocationId": 45454565682155,
  "name": "My PMS Provider",
  "endpoint": "http://integration.com/pms/endpoint",
  "apiKey": "fake-secret",
  "features": [
    "MIRRORING"
  ]
}

Response

Provider created

idinteger

The unique identifier for the provider.

namestring

The name of the PMS provider.

apiKeystring

The API key for the PMS provider.

businessLocationIdinteger

The unique identifier for the business location.

endpointstring

The endpoint of the PMS provider. This is where Lightspeed will send PMS requests.

featuresPmsApiProviderFeature[]

The optional features that the PMS provider supports. See the Integration Guide for more details.

Example response

{
  "id": 3012455645,
  "apiKey": "fake-secret",
  "businessLocationId": 45454565682155,
  "endpoint": "http://integration.com/pms/endpoint",
  "features": [
    "MIRRORING"
  ]
}

Changes

  • 26ebb1b74d19Revision changes
    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

  • 707b55d222abRevision changes
    • breaking

      the response property's maxLength was unset from 255 for the response status

    • breaking

      the response property's maxLength was unset from 255 for the response status

    • breaking

      the response property's maxLength was unset from 255 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 1 to 0 for the response status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status