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
}

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

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.

preferredVendorIdinteger or nullOptional

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

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

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)

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error