Colour bar items

Update a colour bar item

Changes only the fields in the request. Either all of them are changed or none. See ColourBarItemUpdate for how to clear a field. An item stays in its range, and its stock is not changed here.

patch/v1/locations/{locationId}/colour-bar-items/{colourBarItemId}

Request

  • Base URL: https://api.cliento.com
  • URL: https://api.cliento.com/v1/locations/{locationId}/colour-bar-items/{colourBarItemId}
  • Auth: HTTP bearer

Path parameters

locationIdstring required
colourBarItemIdstring required

Headers

Idempotency-Keystring

A value you make up for this one request, such as a UUID. Send the same value when you retry and the first answer is returned; see Retrying safely.

Request body

articleNumberstring
listPricestring
namestring
packSizeinteger
shadestring
strengthPercentstring

Example request

{
  "articleNumber": "99350118254",
  "listPrice": "149.00",
  "name": "Blondor Multi Blonde",
  "packSize": 60,
  "shade": "7/10",
  "strengthPercent": "6"
}

Response

OK

articleNumberstring

The supplier's article number, as read from a delivery note.

catalogueEansstring[] required

Read-only. Those of eans that the item has from the article in a supplier's catalogue it was made from. They are not the item's own and cannot be removed from it. Can be empty.

createdAtstring date-time required
eansstring[] required

The item's barcodes: its own, and those in catalogueEans. Can be empty.

gramsLeftinteger

Read-only. Grams left in all the item's packs together. Left out when the item has no pack size.

idstring required

Colour bar item id.

listPricestring

The list price of one pack, VAT excluded, where the item differs from its range. Left out when the item follows the range's listPrice.

listPriceInUsestring

Read-only. The list price that applies: the item's own, otherwise its range's.

locationIdstring required
namestring required

What the item is called. An item without a name of its own is called by its shade, and follows it when the shade is changed.

openLeftinteger

Read-only. Grams left in the open pack. Left out when no pack is open or the item has no pack size.

openUsedinteger required

Read-only. Grams taken from the open pack. 0 when no pack is open.

packSizeinteger

Grams in one pack, where the item differs from its range. Left out when the item follows the range's packSize.

packSizeInUseinteger

Read-only. The pack size that applies: the item's own, otherwise its range's. Left out for an item used a whole pack at a time.

packsinteger required

Read-only. The packs in stock, the open one included. Never negative.

rangeIdstring required

The range the item belongs to. Set when the item is created.

shadestring

The shade of a colour, as the supplier writes it.

strengthPercentstring

The strength of a developer in per cent, as a decimal string.

unopenedPacksinteger required

Read-only. The packs that are not opened.

updatedAtstring date-time required

When the item last changed, which includes its stock and its own barcodes.

Example response

{
  "articleNumber": "99350118254",
  "catalogueEans": [],
  "createdAt": "2026-10-12T08:15:30Z",
  "eans": [
    "4064666230412"
  ],
  "gramsLeft": 203,
  "id": "cbi_3Vn8Kq5TzL1xWc7PdM2RbJ",
  "listPrice": "137.00",
  "listPriceInUse": "137.00",
  "locationId": "loc_4fK9xQ2mLr8TzB1vNc7HdW",
  "name": "7/10",
  "openLeft": 23,
  "openUsed": 37,
  "packSize": 60,
  "packSizeInUse": 60,
  "packs": 4,
  "rangeId": "cbr_7Hc2Lm9QxT4vBn6KdR1WsP",
  "shade": "7/10",
  "strengthPercent": "6",
  "unopenedPacks": 3,
  "updatedAt": "2026-10-12T08:15:30Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.