XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The category metadata management systems provides APIs to fetch a list of category metadata related with given category from the backend. The metadata may be used to store contextual and optional data about a category.


HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/catalog/categorymetadata?categoryId={categoryId}

URI Parameters

Parameter Name Description Type Conditions
categoryId The Id of the category which the metadata belongs to. Number

Request Headers

Header Field Name Description
Includes minor version header.
Sample: application/vnd.xomni.api-v4-0, */*
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da


       "Key": "676753ab-aff2-4e66-b59c-a24acfb3599b",
       "Value": "a32dfde3-97ce-4935-ba65-05ae29c81a5e",
       "Key": "a2ad9d93-49d0-4074-bd36-5c860aed22cb",
       "Value": "5898abeb-9afe-4483-b444-5e812358c74d",
       "Key": "b40a94a6-af6e-474b-a98f-8597fbc05260",
       "Value": "c31270e3-383a-4b7b-85f5-25d0f1d0519f",
       "Key": "848f828d-bb34-4e80-9e2b-dbf08d83d30c",
       "Value": "68a8ee52-1573-481f-984f-76a6f18f64e5",
       "Key": "6ac9c487-6e1a-4f83-b0cb-ce85d45121fb",
       "Value": "565e5035-6a38-4d76-812a-b431bdb3d345",

Response Body Description

Parameter Name Description Type
[0..N].Key The key for the metadata. String
[0..N].Value The value of the metadata. String

Response Headers

Header Field Name Description
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 category or no metadata for the given category could not be found.