XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The APIs can be used to create new categories. Using this API, you can create a new category.

Request

{
    "Name":"Sample Sub Category 0",
    "ShortDescription":"fc241ce1-6465-4c4d-a983-017b876bfb0b",
    "LongDescription":"6ff7c3ab-3c60-49e3-9e21-cdf5d0b5ef3d",
    "ParentCategoryId":null

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

Request Body Description

Parameter Name Description Type Conditions
Name The name of the category. String
ShortDescription The short description of the category. String
LongDescription The long description of the category. String
ParentCategoryId The unique ID of the parent category. Number

Request Headers

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

{
    "Id":11,
    "Name":"Sample Sub Category 0",
    "ShortDescription":"fc241ce1-6465-4c4d-a983-017b876bfb0b",
    "LongDescription":"6ff7c3ab-3c60-49e3-9e21-cdf5d0b5ef3d",
    "CategoryMetadata":[
 
    ]
}

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 POST operations. Possible response status codes are as listed below:

Status Code Description
409 (Conflict) Given category already exists in backend.