XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API returns a full list of categories with nested tree relationship.

Request

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

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

{
    "Categories":[
       {
           "Id":1,
           "Name":"Sample Category 0",
           "ShortDescription":"917f1053-d27c-4b5e-b701-e6a5892a6c8d",
           "LongDescription":"78e071d1-bc76-43da-824e-1a63e87eb171",
           "CategoryMetadata":[
              {
                  "Key":"Key0",
                  "Value":"4199e152-ec3a-4b7f-927b-1856efa9df98",
              },
              {
                  "Key":"Key1",
                  "Value":"4e88f7b5-1d17-41e5-aaec-98f2fec31946",
              },
           ],
           "CategoryTreeItems":[
              {
                  "Id":11,
                  "Name":"Sample Sub Category 0",
                  "ShortDescription":"fc241ce1-6465-4c4d-a983-017b876bfb0b",
                  "LongDescription":"6ff7c3ab-3c60-49e3-9e21-cdf5d0b5ef3d",
                  "CategoryMetadata":[

                  ],
                  "CategoryTreeItems":[

                  ]
              },
              {
                  "Id":12,
                  "Name":"Sample Sub Category 1",
                  "ShortDescription":"6a3d83bc-714a-498d-9e27-99feb75036d6",
                  "LongDescription":"e7e611d3-3168-48aa-b579-870aa27fada4",
                  "CategoryMetadata":[

                  ],
                  "CategoryTreeItems":[

                  ]
              }
           ]
       },
       {
           "Id":2,
           "Name":"Sample Category 1",
           "ShortDescription":"66455e04-bb80-4faf-a34b-9fe89d889f25",
           "LongDescription":"c12a9174-2dc9-4d21-b5b3-9284c4ccd517",
           "CategoryMetadata":[
              {
                  "Key":"Key0",
                  "Value":"6633f199-10fd-4c8e-b1e9-570b03a44d4b",
              },
              {
                  "Key":"Key1",
                  "Value":"b38396fe-4543-4f3b-96a8-bd77519665d1",
              },
           ],
           "CategoryTreeItems":[

           ]
       }
    ]
}

Response Body Description

Parameter Name Description Type
Categories[0..N].Id This is the unique ID for a category. Number
Categories[0..N].Name The name of the category. String
Categories[0..N].ShortDescription The short description of the category. String
Categories[0..N].LongDescription The long description of the category. String
Categories[0..N].CategoryMetadata[0..N].Key The key for the metadata. String
Categories[0..N].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
409 (Conflict) Given category already exists in backend.