XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API can be used to create a new store.

Request

{    
    "Name": "Relationed Store",
    "Description": "The Description",
    "Address": "Sample Data Address",
    "Location": {
                "Longitude": 23.54,
                "Latitude": 35.41
    }
}
HTTP Method Resource URI
POST https://{tenantName}.api.xomni.com/management/company/store

Request Body Description

Parameter Name Description Type Conditions
Name Name of the store. String
Required: Yes
Description Description of the store. String
Address Address of the store String
Location.Longitude Longitude value of the location. Number
Location.Latitude Latitude value of the location. 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

{
   "Id":1004,
   "Name":"Relationed Store",
   "Description":"The Description",
   "Address":"Sample Data Address",
   "Location":{
      "Longitude":23.54,
      "Latitude":35.41
   },
   "PhysicalDevices":[
      {
         "DeviceId":"TestDevice",
         "Description":"Test Device",
         "StoreId":1004
      }
   ]
}

Response Body Description

Parameter Name Description Type
Id Id of the store. Number
Name Name of the store. String
Description Description of the store. String
Address Address of the store String
PhysicalDevices[0..N].DeviceId Unique ID of the physical device. String
PhysicalDevices[0..N].StoreId Unique ID of the store where physical device is used. Number
PhysicalDevices[0..N].Description Description of the physical device. String
PhysicalDevices[0..N].StoreName Name of the store where physical device is used. String
Location.Longitude Longitude value of the location. Number
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 POST operations. Possible response status codes are as listed below:

Status Code Description
409 (Conflict) There is an existing store with the same name.