catalogItems

Create Catalog Item

Create a new catalog item.

post/catalog-items

Request

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

Request body

namestring required

Catalog item name

type'PRODUCT' | 'SERVICE' required

Catalog item type

costnumber double required

Catalog item cost

pricenumber double required

Catalog item price

tradeGroup'ENERGY' | 'MECHANICAL' | 'ELECTRICAL' | 'PLUMBING' | 'LOW_VOLTAGE' | 'ENVELOPE' | 'OTHER'

High-level trade group for catalog items.

manufacturerstring nullable

Catalog item manufacturer

skustring nullable

Catalog item SKU

codestring nullable

Catalog item code

descriptionstring nullable

Catalog item description

preferredVendorIdinteger nullable

ID of the preferred vendor (must be an existing active vendor for this company)

unitIdinteger nullable

ID of the unit this item is sold/measured in. Must reference a unit belonging to your company (see GET /catalog-units).

measurementIdsinteger[]

IDs of measurements (and/or a single sub-measurement) to link to this item, driving its quantity calculation. At most one linked measurement may be a sub-measurement (type SUB_CALCULATION), and it must be the only one linked. Multiple plain measurement links must share the same unit (or be unitless) — their values are summed.

coveragenumber double nullable

Measurement units covered per item unit. Must be greater than zero. Not compatible with a linked sub-calculation, which derives quantity from its own formula.

wasteFactorMode'STATIC'

Waste factor mode. Must be set together with wasteFactorValue — both, or neither.

wasteFactorValuenumber double nullable

Waste factor percentage (0-100). Must be set together with wasteFactorMode.

Response

Catalog item created successfully

idinteger required

Catalog item identifier

namestring required

Catalog item name

catalog'ENERGY' | 'MECHANICAL' | 'ELECTRICAL' | 'PLUMBING' | 'LOW_VOLTAGE' | 'ENVELOPE' | 'OTHER' required

High-level trade group for catalog items.

type'PRODUCT' | 'SERVICE' required

Catalog item type

manufacturerstring nullable

Catalog item manufacturer

skustring nullable

Catalog item SKU

codestring nullable

Catalog item code

costnumber double nullable required

Catalog item cost

pricenumber double nullable required

Catalog item price

descriptionstring nullable

Catalog item description

isArchivedboolean nullable

Whether the catalog item is archived

createdByIdinteger

Identifier of the user who created the catalog item

createdAtstring date-time nullable
updatedAtstring date-time nullable
preferredVendorIdinteger nullable

ID of the preferred vendor (must be an existing active vendor for this company)

coveragenumber double nullable

Measurement units covered per item unit (e.g. a bundle covering ~33.33 SF). Used to size quantity from summed linked measurements; not used when the item is linked to a sub-calculation, which derives quantity from its own formula.

wasteFactorMode'STATIC'

Waste factor mode applied when computing this item's quantity. Currently only STATIC is supported. Paired with wasteFactorValue — both are set, or neither.

wasteFactorValuenumber double nullable

Waste factor percentage (0-100) applied when computing this item's quantity. Paired with wasteFactorMode.

Changes

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