XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API provides a functionality to get removed shopping cart item logs.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/analytics/servercounters/removedshoppingcartitem/logs?OADate={OADate}&continuationKey={continuationKey}

URI Parameters

Parameter Name Description Type Conditions
OADate Date filter in OA date format. Number
continuationKey Continuation key for getting further logs. String

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

{
    "ContinuationToken": "7d01b6d7-6f25-4138-9591-86f60450db40",
    "Logs": [
      {
          "UniqueKey": "ae08e888-c83a-4685-a9bf-df681b5d6773",
          "ShoppingCartId": 49,
          "RemovedShoppingCartName": "ee7243b0-31f1-4e68-982d-03201c937fd8",
          "BluetoothId": "8e50df2e-5346-4232-b2b5-49ce7eec5611",
          "ShoppingCartUniqueKey": "c8c24a2b-fdaf-4e2c-9f2e-3bf64cae0c8e",
          "ItemId": 49,
          "ItemTitle": "68500e5e-6fbb-48d5-8e99-7b2b1025bd70",
          "Longitude": null,
          "Latitude": null,
          "RemovedStoreId": 49,
          "RemovedStoreName": "f8013cec-5b5a-44c5-b456-a57933899a18",
          "ShoppingCartOwnerName": "5f2d415c-2aaa-4ffa-88c4-e4a0a16fcdc6",
          "ShoppingCartOwnerUserName": "ba70b3c8-61d0-4819-af10-5c5f392fc433",
          "ShoppingCartOwnerUserTypeId": 49,
          "ShoppingCartOwnerUserTypeDescription": "6877267c-aef4-4953-89dd-1a33ca863b26",
          "PhysicalDeviceId : "49",
          "PhysicalDeviceDescription": "3ad8b698-24c2-4e09-939c-c33b3697f686",
          "ShoppingCartIsPublic": true,
          "CategoryName": "245b042f-3b55-4af8-9aec-cfd3be621c67",
          "CategoryId": 49,
          "BrandId": 49,
          "BrandName": "24b74f79-f963-4f7a-a02b-4ae683273b5b",
          "CreatedDate": "2015-09-28T16:43:25.5536127+03:00"
      }
    ]
}

Response Body Description

Parameter Name Description Type
ContinuationToken Continuation key for getting further logs. String
Logs[0..N].UniqueKey The unique key of the shopping cart item. Unknown
Logs[0..N].ShoppingCartId The unique ID of the shopping cart. Number
Logs[0..N].RemovedShoppingCartName Name of the shopping cart. String
Logs[0..N].BluetoothId Bluetooth sensor ID. String
Logs[0..N].ShoppingCartUniqueKey The unique key of the shopping cart. Unknown
Logs[0..N].ItemId The unique ID of the item removed from the shopping cart. Number
Logs[0..N].ItemTitle Title of the item removed from the shopping cart. String
Logs[0..N].Longitude Longitude value of the location where the shopping cart item was removed. Number
Logs[0..N].Latitude Latitude value of the location where the shopping cart item was removed. Number
Logs[0..N].RemovedStoreId The unique ID of the store that the physical device of this operation assigned. Number
Logs[0..N].RemovedStoreName Name of the store that the physical device of this operation assigned. String
Logs[0..N].ShoppingCartOwnerName Name of the shopping cart owner. String
Logs[0..N].ShoppingCartOwnerUserName Username of the shopping cart owner. String
Logs[0..N].ShoppingCartOwnerUserTypeId The unique ID of the user type of shopping cart owner. Number
Logs[0..N].ShoppingCartOwnerUserTypeDescription Description of the user type of shopping cart owner. String
Logs[0..N].PhysicalDeviceId The unique ID of the physical device. String
Logs[0..N].PhysicalDeviceDescription Description of the physical device. String
Logs[0..N].ShoppingCartIsPublic Boolean field indicating if the shopping cart is publicly visible or not. Unknown
Logs[0..N].CategoryName Name of a category assigned to the item removed from the shopping cart. String
Logs[0..N].CategoryId The unique ID of a category assigned to the item removed from the shopping cart. Number
Logs[0..N].BrandId The unique ID of a brand assigned to the item removed from the shopping cart. Number
Logs[0..N].BrandName Name of a brand assigned to the item removed from the shopping cart. String
Logs[0..N].CreatedDate Log creation date. Date

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) No log found.
404 (Not Found) Analytics is not enabled. Please enable analytics functionality using tenant settings.