XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The summary information management systems provide APIs to fetch summary information about catalog members, users and stores. This API provides total count information about catalog members, users and stores.

Request

HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/catalog/summary

Request Headers

Header Field Name Description
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

{
    "TotalActiveItemCount": 9,
    "TotalCategoryCount": 75,
    "TotalBrandCount": 4,
    "TotalStoreCount": 0,
    "TotalPIIUserCount": 1,
    "TotalPrivateMemberCount": 1,
    "TotalPublicMemberCount": 1
}

Response Body Description

Parameter Name Description Type
TotalActiveItemCount Total count of active items. Number
TotalCategoryCount Total count of categories. Number
TotalBrandCount Total count of brands. Number
TotalStoreCount Total count of stores. Number
TotalPIIUserCount Total count of PII users. Number
TotalPrivateMemberCount Total count of private API members. Number
TotalPublicMemberCount Total count of public API members. 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.