List Catalog Items

GET

https://api.coperniq.io/v1/catalog-items

GET

/v1/catalog-items

const url = 'https://api.coperniq.io/v1/catalog-items';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
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
  }
]

Lists catalog items (products and services).

Authentication

x-api-keystring

API Key authentication via header

Response

List of catalog items

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

401

Unauthorized Error

502

Bad Gateway Error