LIlightspeed
Reservations for Platforms

Get Business Locations

Changed on

Retrieve all the business locations accessible for a User

get/reservation/api/1/user/platform/{platform-code}/business-locations

Request

  • Base URL
    https://api.trial.lsk.lightspeed.app
  • URL
    https://api.trial.lsk.lightspeed.app/reservation/api/1/user/platform/{platform-code}/business-locations
  • 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: user-token-by-authorization-code

Path parameters

platform-codestring required

The unique code assigned to the reservation platform.

Example:MyPlatform

Query parameters

pageinteger

The page number, when paginating

sizeinteger

The items per page, when paginating

Response

A list of business locations

businessLocationIdstring required

The unique identifier of the business location.

citystring

The business location's city.

countrystring

The business location's country.

namestring

The business location's name.

statestring

The business location's state.

street1string

The first line of the business location's street address.

street2string

The second line of the business location's street address.

zipstring

The business location's postal code.

Example response

[
  {
    "businessLocationId": "123456789",
    "city": "Genève",
    "country": "CH",
    "name": "Le Gâteau",
    "state": "Canton de Genève",
    "street1": "Rue de la Servette 10",
    "street2": "Suite 2",
    "zip": "101201"
  }
]

Changes

  • 12c833108f68Revision changes
    • breaking

      for the query request parameter size, default value was changed from 10000 to 1000

  • 707b55d222abRevision changes
    • breaking

      the / response's property type changed from integer to string, and format from int64 to no format for status

    • info

      the response property / became required for the status