catalogItems

Update Catalog Item

Update an existing catalog item.

patch/catalog-items/{catalog_item_id}

Request

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

Path parameters

catalog_item_idinteger required

Catalog item identifier

Request body

type'PRODUCT' | 'SERVICE'

Catalog item type

namestring

Catalog item name

codestring

Catalog item code

descriptionstring nullable

Catalog item description

costnumber double

Catalog item cost

pricenumber double

Catalog item price

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

High-level trade group for catalog items.

manufacturerstring nullable

Catalog item manufacturer. PRODUCT items only.

skustring nullable

Catalog item SKU. PRODUCT items only — sending an SKU while the item is, or is becoming, a SERVICE returns 400. Converting a PRODUCT that has an SKU into a SERVICE is allowed and does not require clearing it first: services have no SKU, so it is dropped as part of the conversion. Pass null to clear a PRODUCT SKU or during that conversion; an already-SERVICE item with a legacy SKU cannot change or clear it through this API and returns 400.

isArchivedboolean

Set true to archive the item, or false to restore an archived one. Archiving via this field is equivalent to DELETE /catalog-items/{catalog_item_id}.

preferredVendorIdinteger nullable

ID of the preferred vendor. Pass null to clear the preferred vendor.

unitIdinteger nullable

ID of the unit this item is sold/measured in. Pass null to clear it.

measurementIdsinteger[]

Replaces the full set of measurement/sub-calculation links driving this item's quantity. Omit this field to leave existing links unchanged; pass an empty array to clear all links. This is NOT a merge/append — any previously linked measurement not included here is unlinked. At most one linked measurement may be a sub-measurement (type SUB_CALCULATION), and it must be the only one linked.

coveragenumber double nullable

Measurement units covered per item unit. Must be greater than zero.

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 updated 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.