XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API provides a functionality to get shopping cart creation logs.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/analytics/servercounters/shoppingcartbycreateddate/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": "c6756fd8-f7c3-4fe4-852e-4e849c8cd943",
    "Logs": [
      {
	  "ShoppingCartName": "Test",
          "Name": "3e1dedbc-0355-410c-bf29-3a72c3ff2fe2",
          "IsPublic": true,
          "OwnerName": "ecd8540a-2336-4339-80d8-258fb0413ce0",
          "OwnerUserName": "2c28bfab-ec26-4dec-93f9-0d054329072e",
          "OwnerUserTypeId": 84,
          "OwnerUserTypeDescription": "04f50e8a-67b0-4670-8f37-5b22efa0609e",
          "PhysicalDeviceId : "84",
          "PhysicalDeviceDescription": "974704a0-d8e6-42f9-91a0-71e633dff34c",
          "StoredId": 84,
          "StoreName": "bcb33cca-fd6a-4c0b-8e11-bd38dba0655c",
          "UniqueKey": "bfdac71e-75d4-488a-a0cd-ed2c9ca5e586",
          "CreatedDate": "2017-03-19T16:43:25.5779679+02:00"
      }
    ]
}

Response Body Description

Parameter Name Description Type
ContinuationToken Continuation key for getting further logs. String
Logs[0..N].ShoppingCartName Name of the shopping cart. String
Logs[0..N].IsPublic Boolean field indicating if the shopping cart is publicly visible or not. Unknown
Logs[0..N].OwnerName Name of the shopping cart owner. String
Logs[0..N].OwnerUserName Username of the shopping cart owner. String
Logs[0..N].OwnerUserTypeId The unique ID of the user type of shopping cart owner. Number
Logs[0..N].OwnerUserTypeDescription 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].CreatedPhysicalDeviceDescription Description of the physical device. String
Logs[0..N].StoredId The unique ID of the store that the physical device of this operation assigned. Number
Logs[0..N].StoreName Name of the store that the physical device of this operation assigned. String
Logs[0..N].UniqueKey The unique key of the shopping cart. Unknown
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.