v1

latestOpenAPI 3.0.02026-08-04265791.1 MB
Stores

Get

Get a store for the given id.

get/public/api/stores/{id}

Headers

Acceptstring

e.g. application/json

Response

OK

store_idstring
titlestring
addressstring
tagsstring[]
client_idstring
store_type_namestring
latitudenumber
longitudenumber
contact_emailstring
contact_phonestring
contact_namestring
notification_emailsstring[]
countrystring
timezonestring
vipboolean
created_datestring
updated_datestring

Example response

{
  "store_id": "5b2122014ebf5300360acae1",
  "title": "ice-cream-store",
  "address": "Statue of Liberty, New York, USA",
  "tags": [
    "The dream ice-cream",
    "number 1 ice-cream"
  ],
  "client_id": "007",
  "store_type_name": "ice-cream",
  "latitude": 40.6895453,
  "longitude": -74.0449292,
  "contact_email": "support@store.com",
  "contact_phone": "1800-007-007",
  "contact_name": "james",
  "notification_emails": [
    "james@store.com",
    "jane@store.com"
  ],
  "country": "United States",
  "timezone": "America/New_York",
  "vip": true,
  "properties": [
    {
      "title": "KPI S27",
      "type": "columns",
      "values": [
        {
          "title": "Revenues",
          "value": "1 456 $",
          "isPercent": false,
          "colorHex": "#00FF00"
        },
        {
          "title": "Nb Hours",
          "value": "7/66",
          "colorHex": "#B404FF"
        },
        {
          "title": "QP",
          "value": 2.8,
          "isPercent": true,
          "colorHex": "#B40404"
        }
      ]
    }
  ],
  "created_date": "2018-05-24T04:51:40.862Z",
  "updated_date": "2018-05-24T04:51:40.862Z"
}