XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The API provides a way to provide batch download of full wish list data by specifying a last modification date. The modifiedOADate parameter values filters all the wish list through the last modification date and brings back a full list of wish lists with all wish list items included.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/pii/wishlists?skip={skip}&take={take}&modifiedOADate={modifiedOADate}

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
modifiedOADate An OleAutomation date without time precision. Number

Request Headers

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

Response

{
    "Results":[
       {
           "Id":4,
           "LastModificationDate":"2013-03-21T12:51:56.397",
           "LastAccessDateTime":"2013-03-21T12:51:56.36",
           "LastAccessedApiUserId":1,
	 “IsPublic” : true,
           "WishlistItems":[
              {
                  "Id":5,
                  "LastSeenLocation":{
                      "Longitude":59.0,
                      "Latitude":89.0
                  },
                  "ItemId":1,
                  "BluetoothId":"0",
                  "DateAdded":"2013-03-21T12:51:56.55",
                  "UniqueKey":"1daeb8bd-927e-4921-bc19-3c5ef5096807"
              }
           ],
           "LastSeenLocation":{
               "Longitude":18.0,
               "Latitude":80.0
           },
           "UniqueKey":"3492bd8f-2fca-48ee-9dbf-15382d4678aa"
       },
       {
           "Id":10,
           "LastModificationDate":"2013-03-21T12:51:57.553",
           "LastAccessDateTime":"2013-03-21T12:51:57.54",
           "LastAccessedApiUserId":1,
	 “IsPublic” : true,
           "WishlistItems":[
              {
                  "Id":29,
                  "LastSeenLocation":{
                      "Longitude":50.0,
                      "Latitude":71.0
                  },
                  "ItemId":1,
                  "BluetoothId":"0",
                  "DateAdded":"2013-03-21T12:51:57.58",
                  "UniqueKey":"29204ed8-05b2-4e1c-963c-1102f441ba25"
              },
              {
                  "Id":30,
                  "LastSeenLocation":{
                      "Longitude":26.0,
                      "Latitude":70.0
                  },
                  "ItemId":1,
                  "BluetoothId":"1",
                  "DateAdded":"2013-03-21T12:51:57.597",
                  "UniqueKey":"6e9b50a5-dfdf-4397-8c4a-aa1c95933f35"
              }
           ],
           "LastSeenLocation":{
               "Longitude":56.0,
               "Latitude":79.0
           },
           "UniqueKey":"24e085ff-39a8-462d-a8bd-0652372595d4"
       }
    ],
    "TotalCount":367
}

Response Body Description

Parameter Name Description Type
TotalCount Total count of the filtered collection without paging. Number
Results[0..N].Id The unique id of wish list. Number
Results[0..N].LastModificationDate Last modification date of the wish list. Date
Results[0..N].LastAccessDateTime Last access date of the wish list. Date
Results[0..N].LastAccessedApiUserId Number
Results[0..N].UniqueKey The unique ID of the last accessed API user. String
Results[0..N].Name Name of the wishlist String
Results[0..N].IsPublic Indicates whether the wish list is publicly visible or not. Boolean
Results[0..N].LastSeenLocation.Longitude Longitude value of the location. Number
Results[0..N].LastSeenLocation.Latitude Latitude value of the location. Number
Results[0..N].WishlistItems[0..N].Id The unique id of the wish list item. Number
Results[0..N].WishlistItems[0..N].ItemId The unique id of the catalog item found in wish list item. Number
Results[0..N].WishlistItems[0..N].BluetoothId Bluetooth sensor ID. String
Results[0..N].WishlistItems[0..N].DateAdded The date when the item is added into the wish list. Date
Results[0..N].WishlistItems[0..N].UniqueKey The unique key of wish list item. String
Results[0..N].WishlistItems[0..N].LastSeenLocation.Longitude Longitude value of the location. Number
Results[0..N].WishlistItems[0..N].LastSeenLocation.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
404 (Not Found) Wish list was not found.