XOMNI: Experience Omni-Channel

Last Updated: February 19, 2016

The unit type management systems provides APIs to get a single unit type from the backend.

Request

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

URI Parameters

Parameter Name Description Type Conditions
unitTypeId The unique Id of a unit type. Number

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":"100 Gram",
    "Description":"100 Gram",
    "UnitCode":"Gr"
}

Response Body Description

Parameter Name Description Type
Id This is the unique ID for a unit type. Number
Name Name of the unit type. String
Description Description of the unit type. String
UnitCode Unit code of the unit type. (For example, kg for kilogram) 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 unit type found for given unit type id.