Create Catalog Item | Coperniq API

const url = 'https://api.coperniq.io/v1/catalog-items';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"name":"Installation","type":"SERVICE","category":"INSTALLATION","cost":300,"price":600}'
};
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
}

Create a new catalog item.

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

namestringRequired

Catalog item name

typeenumRequired

Catalog item type

Allowed values:

categoryenumRequired

Catalog item category code. Must be a valid ProductCategory when type is PRODUCT or ServiceCategory when type is SERVICE.

costdoubleRequired>=0

Catalog item cost

pricedoubleRequired>=0

Catalog item price

tradeGroupenumOptional

High-level trade group for this item. If omitted, it is derived from the category — a product category resolves to the trade group it belongs to (for example ROOF_COVERING resolves to ENVELOPE), and services or category OTHER resolve to OTHER. When provided, it must be consistent with the category (for products, the category must belong to this trade group; category OTHER is allowed under any trade group).

manufacturerstring or nullOptional

Catalog item manufacturer

skustring or nullOptional

Catalog item SKU

codestring or nullOptional

Catalog item code

descriptionstring or nullOptional

Catalog item description

preferredVendorIdinteger or nullOptional

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

unitIdinteger or nullOptional

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

measurementIdslist of integersOptional

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.

coveragedouble or nullOptional

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.

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 created 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

502

Bad Gateway Error