v1

latestOpenAPI 3.1.02026-08-0420819698.7 KB
Routes
Units of Measure

Update Unit

The HTTP PATCH request is used to update a specific unit identified by its unit code. The request should be made to the endpoint {{protocol}}://{{server}}:{{port}}/v2/uom/:unitCode, where :unitCode is the unique identifier of the unit being updated.

Request Body

The body is interpreted slightly differently, depending on whether the unitCode in the url is for a custom unit or a provided unit. If it is custom, then either property can be used to update the unit. If it is a provided unit, the name property will be ignored and only the abbreviation property will be used to override the defaut one. You can also use null to remove the override from the provided unit. If either property is null for a custom unit, that property will not be updated.

The request should include a JSON payload with the following parameters:

  • name (string): The full name of the unit.

  • abbreviation (string): A compact name of the unit.

Response

The full object of the updated unit.

patch/v2/uom/{unitCode}

Request body

namestring
abbreviationstring

Response

Update Custom Unit

unitCodestring
namestring
abbreviationstring
defaultAbbreviationstring
categorystring
isCustomboolean