Update Catalog Item | Coperniq API

const url = 'https://api.coperniq.io/v1/catalog-items/1';
const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"type":"SERVICE","price":550,"isArchived":true}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": 1,
  "name": "string",
  "catalog": "ENERGY",
  "type": "PRODUCT",
  "category": "BATTERY_SYSTEM",
  "cost": 1.1,
  "price": 1.1,
  "manufacturer": "string",
  "sku": "string",
  "code": "string",
  "description": "string",
  "image": {
    "id": 1,
    "name": "string",
    "url": "string"
  },
  "isArchived": true,
  "createdById": 1,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "preferredVendorId": 1,
  "unit": {
    "id": 1,
    "code": "string",
    "label": "string",
    "dimension": "LENGTH",
    "isCustom": true,
    "isArchived": true
  },
  "measurements": [
    {
      "id": 1,
      "name": "string",
      "type": "MEASUREMENT",
      "unit": {
        "id": 1,
        "code": "string",
        "label": "string",
        "dimension": "LENGTH",
        "isCustom": true,
        "isArchived": true
      },
      "minimumValue": 1.1,
      "formula": {
        "operands": [
          {
            "name": "string",
            "measurementId": 1
          }
        ],
        "ast": {},
        "sourceText": "string"
      },
      "isArchived": true
    }
  ],
  "coverage": 1.1,
  "wasteFactorMode": "STATIC",
  "wasteFactorValue": 1.1
}

Update an existing catalog item.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

catalog_item_idintegerRequired

Catalog item identifier

Request

This endpoint expects an object.

typeenumOptional

Catalog item type

Allowed values:

namestringOptional

Catalog item name

categoryenumOptional

Catalog item category code. Must be a valid ProductCategory or ServiceCategory value.

codestringOptional

Catalog item code

descriptionstring or nullOptional

Catalog item description

costdoubleOptional>=0

Catalog item cost

pricedoubleOptional>=0

Catalog item price

tradeGroupenumOptional

High-level trade group for this item.

manufacturerstring or nullOptional

Catalog item manufacturer. PRODUCT items only.

skustring or nullOptional

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.

isArchivedbooleanOptional

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 or nullOptional

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

unitIdinteger or nullOptional

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

measurementIdslist of integersOptional

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.

coveragedouble or nullOptional

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

wasteFactorModeenum or nullOptional

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

Allowed values:

wasteFactorValuedouble or nullOptional0-100

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

Response

Catalog item updated successfully

idinteger

Catalog item identifier

namestring

Catalog item name

catalogenum or null

High-level trade group for this item.

typeenum

Catalog item type

Allowed values:

categoryenum

Catalog item category code (ProductCategory or ServiceCategory)

costdouble or null>=0

Catalog item cost

pricedouble or null>=0

Catalog item price

manufacturerstring or nullOptional

Catalog item manufacturer

skustring or nullOptional

Catalog item SKU

codestring or nullOptional

Catalog item code

descriptionstring or nullOptional

Catalog item description

imageobject or nullOptional

isArchivedboolean or nullOptional

Whether the catalog item is archived

createdByIdintegerOptional

Identifier of the user who created the catalog item

createdAtstring or nullOptionalformat: "date-time"

updatedAtstring or nullOptionalformat: "date-time"

preferredVendorIdinteger or nullOptional

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

unitobject or nullOptional

The unit this item is sold/measured in, if any. Set on write via unitId.

measurementslist of objectsOptional

Measurements (and sub-measurements) linked to this item to drive its quantity calculation. A sub-measurement is a linked Measurement with type SUB_CALCULATION; at most one may be linked, and it must be the only link when present.

coveragedouble or nullOptional

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.

wasteFactorModeenum or nullOptional

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

Allowed values:

wasteFactorValuedouble or nullOptional

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

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

502

Bad Gateway Error