Get Catalog Unit

Retrieve a specific catalog unit by ID.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

catalog_unit_idstringRequired

Response

Catalog unit details
idinteger
Catalog unit identifier
codestring

Stable short code for the unit (e.g. “SF”, “EA”)

labelstring

Human-readable label for the unit (e.g. “Square Feet”)

dimensionenum or nullOptional

The physical dimension this unit measures, if any. Null for packaging-style units (e.g. bundle, roll) that can’t be used on a measurement.

isCustombooleanOptional
Whether this unit was defined by the company, as opposed to one of the seeded defaults.
isArchivedbooleanOptional
Whether this unit has been archived.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
502
Bad Gateway Error