XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API returns a full list of stores.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/management/company/stores?skip={skip}&take={take}

URI Parameters

Parameter Name Description Type Conditions
skip The number of items in the collection to skip before executing a select. Number
take The number of items that should be fetched from the collection. Number

Request Headers

Header Field Name Description
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
Accept
Includes minor version header.
Sample: application/vnd.xomni.api-v4-1, */*

Response

{
   "Results":[
      {
         "Id":1004,
         "Name":"Relationed Store",
         "Description":"The Description",
         "Address":"Adres",
         "Location":{
            "Longitude":23.54,
            "Latitude":35.41
         },
         "PhysicalDevices":[
            {
               "DeviceId":"TestDevice",
               "Description":"Test Device",
               "StoreId":1004
            }
         ]
      },
      {
         "Id":1011,
         "Name":"New Store",
         "Description":"Description of New Store",
         "Address":"Adres",
         "Location":{
            "Longitude":37.65,
            "Latitude":23.41
         },
         "PhysicalDevices":[

         ]
      }
   ],
   "TotalCount":6
}

Response Body Description

Parameter Name Description Type
TotalCount Total count of stores in the filtered collection without paging. Number
Results[0..N].Id Id of the store. Number
Results[0..N].Name Name of the store. String
Results[0..N].Description Description of the store. String
Results[0..N].Address Address of the store String
Results[0..N].PhysicalDevices[0..N].DeviceId Unique ID of the physical device. String
Results[0..N].PhysicalDevices[0..N].StoreId Unique ID of the store where physical device is used. Number
Results[0..N].PhysicalDevices[0..N].Description Description of the physical device. String
Results[0..N].PhysicalDevices[0..N].StoreName Name of the store where physical device is used. String
Results[0..N].Location.Longitude Longitude value of the location. Number
Results[0..N].Location.Latitude Latitude value of the location. Number

Response Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.

Status Codes

A successful operation returns status code 200 (OK) for GET operations.