Products

Get a product by id

The same product as under its location, found from its id. For a caller that holds an id and not the location it belongs to. The answer carries locationId.

get/v1/products/{productId}

Request

  • Base URL: https://api.cliento.com
  • URL: https://api.cliento.com/v1/products/{productId}
  • Auth: HTTP bearer

Path parameters

productIdstring required

Response

OK

articleNumberstring

The supplier's article number, as read from a delivery note. Not unique: two suppliers can use the same one.

averageCoststring

The average cost of those in stock, VAT excluded. Only with the scope stock:cost.

brandstring
createdAtstring date-time

When it was created, in UTC. Left out when that is not known.

eansstring[] required

The product's barcodes. A product can be linked to an article in a supplier's catalogue, and then that article's barcodes are included. Can be empty.

idstring required

Product id.

latestPurchasePricestring

What one cost at the latest delivery, VAT excluded. Only with the scope stock:cost.

locationIdstring required
namestring required
notForSaleboolean required

Marked as not sold to customers, such as colour used in a treatment. It is a mark only: the point of sale does not refuse to sell the product.

pricestring

The sale price, VAT included. Left out when none is set.

stockQuantityinteger

The stock balance. Never negative. Left out when the product is not stock-tracked.

stockTrackedboolean required

Whether the location keeps a stock balance for the product.

updatedAtstring date-time required

When it last changed, in UTC.

vatPercentstring

VAT rate in per cent.

Example response

{
  "articleNumber": "81650673",
  "averageCost": "61.2311",
  "brand": "Wella",
  "createdAt": "2026-03-02T08:15:00Z",
  "eans": [
    "4064666230412"
  ],
  "id": "prd_5Tg8mPq1Xc7Jd2Ls9WbNrK",
  "latestPurchasePrice": "62.4500",
  "locationId": "loc_4fK9xQ2mLr8TzB1vNc7HdW",
  "name": "Color Touch 7/0",
  "notForSale": true,
  "price": "149.00",
  "stockQuantity": 12,
  "stockTracked": true,
  "updatedAt": "2026-10-12T09:24:31.512Z",
  "vatPercent": "25"
}

Changes

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