XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

This API enables a client application to filter stores by their locations. This allows an application to pull all the nearby stores.

Request

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

URI Parameters

Parameter Name Description Type Conditions
locationInfo GPS location information. GPS information should be in longitude;latitude format. Ex. 41.038473;28.970034 String
searchDistance Maximum distance in miles defining a search perimeter. Double
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
Content-Type
Content type of the response entity. The value of this header is always application/json.
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

{
   "Data":{
      "Results":[
         {
            "Id":25,
            "Description":"Test Store 1 Description",
            "Location":{
               "Longitude":41.034973,
               "Latitude":28.992459
            },
            "Name":"Test Store 1",
            "Address":"Test Store 1 Detailed Address"
         },
         {
            "Id":26,
            "Description":"Test Store 2 Description",
            "Location":{
               "Longitude":41.034948,
               "Latitude":28.992024
            },
            "Name":"Test Store 2",
            "Address":"Test Store 2 Detailed Address"
         }
      ],
      "TotalCount":4
   }
}

Response Body Description

Parameter Name Description Type
Data.TotalCount Total count of items in the filtered collection without paging. Number
Data.Results[0..N].Id The unique ID for the store. Number
Data.Results[0..N].Description Description of the store. String
Data.Results[0..N].Name Name of the store. String
Data.Results[0..N].Address Detailed address of the store. String
Data.Results[0..N].Location.Longitude Longitude value of the location. Number
Data.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. Possible response status codes are as listed below:

Status Code Description
400 (Bad Request) Location info malformed.
404 (Not Found) No nearby store found.