GET /api/v202304/commodity/{commodityId}/unit

Retrieves available units for a specific commodity, optionally filtered by value type

GetUnitsByCommodityV202304
Use this endpoint to find which units of measure are valid for a given commodity. Optionally filter by value type to get only use, demand, or cost units.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Path Parameters

Name Description Type Required
commodityId Unique numeric identifier of the commodity integer (int32) Required

Query Parameters

Name Description Type Required
valueType Optional value type filter. Valid values: ‘use’, ‘demand’, ‘cost’. If omitted, returns all unit types. string Optional

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

Array of:

Unit
Property Description Type
unitCode Must be between 0 and 16 characters string
unitDisplayName Must be between 0 and 64 characters string
unitId integer (int32)
unitInfo Must be between 0 and 32 characters string
unitType UnitType
UnitType properties
Property Description Type
unitTypeCode string
unitTypeId integer (int32)
unitTypeInfo string
Example Response application/json 
[
  {    "unitCode": "string",    "unitDisplayName": "string",    "unitId": 1,    "unitInfo": "string",    "unitType": {      "unitTypeCode": "string",      "unitTypeId": 1,      "unitTypeInfo": "string"
    }
  }
]
404 Not Found The requested resource was not found. Verify the ID or path is correct.