catalogItems

Get Catalog Unit

Retrieve a specific catalog unit by ID.

get/catalog-units/{catalog_unit_id}

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/catalog-units/{catalog_unit_id}
  • Auth: API key in header x-api-key

Path parameters

catalog_unit_idstring required

Response

Catalog unit details

idinteger required

Catalog unit identifier

codestring required

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

labelstring required

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

dimension'LENGTH' | 'AREA' | 'COUNT'

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.

isCustomboolean

Whether this unit was defined by the company, as opposed to one of the seeded defaults.

isArchivedboolean

Whether this unit has been archived.

Changes

No recorded changes to this operation across all 1 revision of this API.