Create PMS provider

POST /pms/v1/providers

OAuth2

Creates a new PMS provider for the businessLocation.

application/json

Body Required

businessLocationId integer(int64) Required

The unique identifier for the business location.
name string Required

The name of the PMS provider.

Minimum length is 1, maximum length is 255.
endpoint string Required

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

Minimum length is 1, maximum length is 255.
apiKey string Required

The API key for the PMS provider.

Minimum length is 1, maximum length is 255.
features array[string] Required

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

Values are SEARCH_BY_NAME, MIRRORING, PARTIAL_PAYMENTS, MULTI_PAYMENTS, SERVICE_CHARGE, or ENRICHED_PAYLOAD.

Responses

200 application/json

Provider created
Hide response attributes Show response attributes object
- id integer(int64)
  
  The unique identifier for the provider.
- businessLocationId integer(int64)
  
  The unique identifier for the business location.
- name string
  
  The name of the PMS provider.
  
  Minimum length is 1, maximum length is 255.
- endpoint string
  
  The endpoint of the PMS provider. This is where Lightspeed will send PMS requests.
  
  Minimum length is 1, maximum length is 255.
- apiKey string
  
  The API key for the PMS provider.
  
  Minimum length is 1, maximum length is 255.
- features array[string]
  
  The optional features that the PMS provider supports. See the Integration Guide for more details.
  
  Values are SEARCH_BY_NAME, MIRRORING, PARTIAL_PAYMENTS, MULTI_PAYMENTS, SERVICE_CHARGE, or ENRICHED_PAYLOAD.
400 */*

Bad Request
Hide response attributes Show response attributes object
- status string
- timestamp string(date-time)
- message string
- apiSubExceptions array[object]
  
  Hide apiSubExceptions attributes Show apiSubExceptions attributes object
  
  field string
  
  rejectedValue object
  
  Additional properties are allowed.
  
  message string
403 */*

Forbidden
Hide response attributes Show response attributes object
- status string
- timestamp string(date-time)
- message string
- apiSubExceptions array[object]
  
  Hide apiSubExceptions attributes Show apiSubExceptions attributes object
  
  field string
  
  rejectedValue object
  
  Additional properties are allowed.
  
  message string
404 */*

Provider not found
Hide response attributes Show response attributes object
- status string
- timestamp string(date-time)
- message string
- apiSubExceptions array[object]
  
  Hide apiSubExceptions attributes Show apiSubExceptions attributes object
  
  field string
  
  rejectedValue object
  
  Additional properties are allowed.
  
  message string
503 */*

Service Unavailable
Hide response attributes Show response attributes object
- status string
- timestamp string(date-time)
- message string
- apiSubExceptions array[object]
  
  Hide apiSubExceptions attributes Show apiSubExceptions attributes object
  
  field string
  
  rejectedValue object
  
  Additional properties are allowed.
  
  message string

POST /pms/v1/providers

curl \
 -X POST https://api.trial.lsk.lightspeed.app/pms/v1/providers \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"businessLocationId":45454565682155,"name":"My PMS Provider","endpoint":"http://integration.com/pms/endpoint","apiKey":"fake-secret","features":["MIRRORING"]}'

Request examples

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

Response examples (200)

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

Response examples (400)

{
  "status": "string",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": {},
      "message": "string"
    }
  ]
}

Response examples (403)

{
  "status": "string",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": {},
      "message": "string"
    }
  ]
}

Response examples (404)

{
  "status": "string",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": {},
      "message": "string"
    }
  ]
}

Response examples (503)

{
  "status": "string",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": {},
      "message": "string"
    }
  ]
}