XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The unit type management systems provides APIs to fetch a full list of unit types from the backend.


HTTP Method Resource URI
GET https://{tenantName}.api.xomni.com/private/catalog/unittypes?skip={skipnumber}&take={takenumber}

URI Parameters

Parameter Name Description Type Conditions
skip The number of items in the collection to skip before executing a select. Number
take The number of items that should be fetched from the collection. 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


           "Name":"100 Gram",
           "Description":"100 Gram",
           "Name":"1 Kilogram",
           "Description":"1 Kilogram",

Response Body Description

Parameter Name Description Type
TotalCount Total count of the unit types in filtered collection without paging. Number
Results[0..N].Id This is the unique ID for a unit type. Number
Results[0..N].Name Name of the unit type. String
Results[0..N].Description Description of the unit type. String
Results[0..N].UnitCode Unit code of the unit type. (For example, kg for kilogram) 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
400 (Bad Request) Skip and/or take parameters are malformed.
404 (Not Found) No unit type defined in backend.