Delete Catalog Item | Coperniq

curl -X DELETE https://api.coperniq.io/v1/catalog-items/1 \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "body": {}
}'

{
  "id": 1,
  "name": "Wireless Ergonomic Mouse",
  "type": "PRODUCT",
  "cost": 25.75,
  "price": 49.99,
  "manufacturer": "LogiTech",
  "sku": "WM-ERG-2024",
  "code": "LOGI-WM-ERG-01",
  "description": "A wireless ergonomic mouse designed for comfort and precision.",
  "image": {
    "id": 101,
    "name": "wireless-ergonomic-mouse.jpg",
    "metaData": {
      "resolution": "1024x768",
      "format": "jpg",
      "sizeKB": 150
    }
  },
  "isArchived": true,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "categoryId": 12
}

This is a hard delete, so the item is removed from the catalog and is no longer available for new requests.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

catalogItemIdintegerRequired

Catalog item identifier

Response

Catalog item deleted and returned

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 null

Catalog item manufacturer

skustring or null

Catalog item SKU

codestring or null

Catalog item code

descriptionstring or null

Catalog item description

imageobject or null

isArchivedboolean or null

Whether the catalog item is archived

createdByIdinteger or null

Identifier of the user who created the catalog item

createdAtstring or nullformat: "date-time"

updatedAtstring or nullformat: "date-time"

Authentication

Path parameters

Response

Errors