XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The unit type management systems provides APIs to update a particular unit type in backend. Using this API, you can update unit type name, description and unit code of a particular unit type.

Request

{
    "Id":1,
    "Name":"10 Gram",
    "Description":"10 Gram",
    "UnitCode":"Gr"
}
HTTP Method Resource URI
PUT https://{tenantName}.api.xomni.com/private/catalog/unittype

Request Body Description

Parameter Name Description Type Conditions
Id This is the unique ID for a unit type. Number
Name Name of the unit type. String
Max Length: 512
Description Description of the unit type. String
Max Length: 512
UnitCode Unit code of the unit type. (For example, kg for kilogram) String
Max Length: 8

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":1,
    "Name":"10 Gram",
    "Description":"10 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 PUT operations. Possible response status codes are as listed below:

Status Code Description
404 (Not Found) No unit type found for given unit type id.
409 (Conflict) Given unit type description already exists.