XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The API allows a client application to retrieve a list of trending items filtered by the store ID and brand ID of the item based on the popularity points.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/catalog/trendingitems?top={top}&brandId={brandId}&storeId={storeId}&includeActionDetails={includeActionDetails}

URI Parameters

Parameter Name Description Type Conditions
top Integer value indicating the number of items to retrieve descending by the total popularity point. Number
brandId ID of the brand to filter the results. Number
storeId ID of the store to filter the results Number
includeActionDetails Optional Boolean value indicating whether the trending action details should be included. Boolean

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

{
	"Id": 1,
	"Title": "f276bce0-df31-49fb-87bd-220bf2654f88",
	"Name": "6141092a-87ef-4a0f-aa54-a82f8d2e6296",
	"SKU": "4b2daaaa-f831-4232-955b-51c96abcd791",
	"TotalPoint": 627.12,
	"ItemPopularityRecords": [
		{
			"StoreId": 2,
			"ActionType": "ItemView",
			"TotalTimeImpactValue": 156.23,
			"TotalActionTypeImpactValue": 679.21,
			"TotalValue": 835.44,
			"TotalActionCount": 78
		}
	]
}

Response Body Description

Parameter Name Description Type
[0..N].CreatedDate 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.