Shop(Store)

Simple shop object#

Only main fields of shop object

Attribute	Type	Description	Nullable
id	Integer	Identifier	false
active	Boolean	user activity field	false
sap	String	Unique store number	false
address	String	Store address	false
locality	String	Name of store	false
city	String	The city where the store is located	false
latitude	Double	Latitude of store	false
longitude	Double	Longitude of store	false
timeZoneId	String	Id of the time zone in which the store is located (format like Europe/Moscow)	true

Example:

{
  "id": 679,
  "active": true,
  "sap": "0001",
  "locality": "Manhattan Mall",
  "address": "100 W 33rd St, New York, NY 10001",
  "city": "New York",
  "latitude": 40.749,
  "longitude": 73.989,
  "clusterId": 74,
  "timeZoneId": "Europe/Moscow"
}

Usages:

Additional shop fields#

Additional shop object fields

Attribute	Type	Description	Nullable
dir	List of String	Set of user report roles	true
cluster	List of String	Set of user report roles	true
division	List of String	Set of user report roles	true
supervisors	Simple user object	Add inspector user for this shop	true

Example:

{
  "dir": {
    "id": 1654,
    "active": true,
    "login": "samplemail@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "position": "Store manager",
    "level": "SHOP",
    "businessDirId": 1003,
    "lang": "en_EN",
    "voximplantLogin": "samplemail@example.com"
  },
  "cluster": {
    "id": 74,
    "name": "Madison",
    "active": true,
    "divisionId": 60,
    "shopsCount": 6
  },
  "division": {
    "id": 60,
    "name": "USA, Central New York",
    "active": true,
    "regionsCount": 3,
    "shopsCount": 8
  },
  "supervisors": [
    {
      "id": 1654,
      "active": true,
      "login": "samplemail@example.com",
      "firstName": "Rebecca",
      "lastName": "Jefferson",
      "position": "Inspector",
      "level": "SHOP",
      "businessDirId": 1001,
      "lang": "en_EN",
      "voximplantLogin": "samplemail@example.com"
    }
  ]
}

Usages: