Get a PMS provider by ID

GET /pms/v1/providers/{id}
OAuth2

Returns the details of a specific PMS provider.

Only PMS providers created by the authenticated OAuth client will be returned.

Path parameters

  • id integer(int64) Required

    The unique identifier for the provider.

Responses

  • 200 application/json

    Provider found

    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
  • 403 */*

    Forbidden

    Hide response attributes Show response attributes object
  • 404 */*

    Provider not found

    Hide response attributes Show response attributes object
  • 503 */*

    Service Unavailable

    Hide response attributes Show response attributes object
GET /pms/v1/providers/{id} 
curl \
 -X GET https://api.trial.lsk.lightspeed.app/pms/v1/providers/3012455645 \
 -H "Authorization: Bearer $ACCESS_TOKEN"
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"
    }
  ]
}