Sign in

v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB
PMS

Create PMS provider

Creates a new PMS provider for the businessLocation.

post/pms/v1/providers

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"
  ]
}