XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

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

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/analytics/servercounters/addedshoppingcartitem/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": "a711af1c-2a20-4525-9e56-051682c87788",
    "Logs": [
      {
          "UniqueKey": "06ddf62e-a6c5-452d-a4a9-6ab8764b271d",
          "ShoppingCartId": 44,
          "AddedShoppingCartName": "da252867-f383-4a78-9c96-3a26e5c80bef",
          "BluetoothId": "caf2c853-336d-438a-8d21-1c4016ef214b",
          "ShoppingCartUniqueKey": "7fdd161c-1815-4544-b725-ff5ab8158b03",
          "ItemId": 44,
          "ItemTitle": "957e1847-4c98-4efb-ac68-58267857b5ea",
          "Longitude": null,
          "Latitude": null,
          "AddedStoreId": 44,
          "AddedStoreName": "ff292920-6c37-418a-88d4-7bdeac067418",
          "ShoppingCartOwnerName": "9ff1be71-f96f-49a1-9d93-02633e490d58",
          "ShoppingCartOwnerUserName": "1fbfaeed-d82f-47a8-b052-a4b5c6c21d94",
          "ShoppingCartOwnerUserTypeId": 44,
          "ShoppingCartOwnerUserTypeDescription": "cc98c68b-bcc3-448d-9281-743cc99e8457",
          "PhysicalDeviceId : "44",
          "PhysicalDeviceDescription": "258adc18-a099-42ca-8cdf-46f4a11e17f4",
          "ShoppingCartIsPublic": true,
          "CategoryName": "740c1006-2ba7-40ae-b9a5-9955a9c9d969",
          "CategoryId": 44,
          "BrandId": 44,
          "BrandName": "816b67f1-486a-4483-b86c-2a84a9ab017d",
          "Quantity": 44,
          "CreatedDate": "2015-07-11T16:43:25.3603539+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].AddedShoppingCartName 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 added to the shopping cart. Number
Logs[0..N].ItemTitle Title of the item added to the shopping cart. String
Logs[0..N].Longitude Longitude value of the location where the shopping cart item was created. Number
Logs[0..N].Latitude Latitude value of the location where the shopping cart item was created. Number
Logs[0..N].AddedStoreId The unique id of the store that the physical device of this operation assigned. Number
Logs[0..N].AddedStoreName 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 added to the shopping cart. String
Logs[0..N].CategoryId The unique ID of a category assigned to the item added to the shopping cart. Number
Logs[0..N].BrandId The unique ID of a brand assigned to the item added to the shopping cart. Number
Logs[0..N].BrandName Name of a brand assigned to the item added to the shopping cart. String
Logs[0..N].Quantity Quantity of the added item. Number
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.