Locations

Location contains data about a restaurant’s location.

Most of API endpoints require a locationId path parameter. The id field of the Location objects returned by this endpoint correspond to that locationId parameter.

Methods

Retrieve Locations

Provides the details for all businesses locations which client is allowed to see.

GET /marketplace/v2/locations

Response 200

Returns a collection of Location objects

{
  "results": [
    {
      "id": 0,
      "name": "string",
      "timeZone": "string",
      "merchantId": "string",
      "countryCode": "US",
      "currency": "USD",
      "language": "en",
      "brandRef": "string"
    }
  ],
  "meta": {}
}

Delete installations for the location

Delete installations for the location and requesting app.

DELETE /marketplace/v2/locations/{locationId}

Response 204

Delete installations for the location and requesting app.

Definitions

LocationData

Location data

Name Type Description
id* integer Location numeric ID
name* string Location name
timeZone* string Location timezone
merchantId* string Merchant ID
countryCode* string Two-letter ISO 3166-1 alpha-2 country code
currency* string Three-letter ISO 4217 currency code
language* string Two-letter ISO 639-1 language code
brandRef* string Location brand reference

results matching ""

    No results matching ""