XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The category management systems provides APIs to get a single category and related metadata from the backend. Using this API, you can get a particular category and related metadata.

Request

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

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,
    "Name":"Sample Category 0",
    "ShortDescription":"c0241832-722e-4f3c-9906-226329af9543",
    "LongDescription":"9a662538-a508-454f-8acd-ddf01a235a0c",
    "SubCategoryCount":5,
    "CategoryMetadata":[
       {
           "Key":"Key0",
           "Value":"eee5ffc7-63f0-45fa-b44d-a4a67e775ded",
       },
       {
           "Key":"Key1",
           "Value":"611a18b7-8db7-45c5-9dcc-62fbf477f18b",
       },
       {
           "Key":"Key2",
           "Value":"1ee32f30-2c6b-47d8-9f65-fe5f6f20d74a",
       },
    ],
    "ParentCategoryId":null,
    "ParentCategoryName":""
}

Response Body Description

Parameter Name Description Type
Id This is the unique ID for a category. Number
Name The name of the category. String
ShortDescription The short description of the category. String
LongDescription The long description of the category. String
SubCategoryCount The count of subcategories of this category Number
ParentCategoryId The unique ID of the parent category. Number
ParentCategoryName The name of the parent category. String
CategoryMetadata[0..N].Key The key for the metadata. String
CategoryMetadata[0..N].Value The value of the metadata. String

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 category found for given category id.