XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

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

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/catalog/trendingitems?top={top}&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
storeId ID of the Store to filter the results. Number
includeActionDetails Boolean value indicating whether the trending action details should be included. Boolean

Request Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.
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

{
    "Data": [
        {
            "Id": 1,
            "Title": "Sample Product Title",
            "Name": "Sample Product Name",
            "SKU": "12421442124213",
            "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
Data[0..N].Id ID of the item. Number
Data[0..N].Title Title of the item. String
Data[0..N].Name Name of the item. String
Data[0..N].SKU Stock keeping unit of the item. String
Data[0..N].TotalPoint Total popularity point of the item. Number
Data[0..N].ItemPopularityRecords[0..N].StoreId Id of the store where the trending action happened. Number
Data[0..N].ItemPopularityRecords[0..N].ActionType Type of the trending action such as "ItemView", "SocialShare", etc. String
Data[0..N].ItemPopularityRecords[0..N].TotalTimeImpactValue Total time impact value of the popularity point. Number
Data[0..N].ItemPopularityRecords[0..N].TotalActionTypeImpactValue Total action type impact value of the popularity point. Number
Data[0..N].ItemPopularityRecords[0..N].TotalValue Total popularity point. Number
Data[0..N].ItemPopularityRecords[0..N].TotalActionCount Total number of actions happened for the stated action type and the StoreId 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.