catalogItems

List Catalog Units

Lists the units of measure available to your company (e.g. Each, Square Feet, Linear Feet). Use these IDs when setting unitId on a catalog item, or when linking measurements.

get/catalog-units

Request

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

Query parameters

include_archivedboolean

Whether to include archived (inactive) records in the response. By default only active records are returned.

pageinteger

Page number (1-based)

page_sizeinteger

Number of items per page (max 100)

Response

List of catalog units

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.