Skip to main content
GET
Get a product's value ledger

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the organization that owns the product.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
gtin
string<gtin>
required

GTIN-8/12/13/14 of the product. Normalized to GTIN-14 by zero-padding before lookup.

Required string length: 8 - 14
Pattern: ^[0-9]{8}$|^[0-9]{12,14}$

Response

OK

What Closient did for one product this month.

available
boolean
required

False when the product does not have enhanced resolution switched on; the other fields are then empty.

Example:

true

month_label
string
required

Calendar month the figures cover, for example October 2026; blank when unavailable.

Example:

"October 2026"

worth_it
boolean
required

True once any measured line has a non-zero figure.

Example:

true

is_new_product
boolean
required

True for a product with no activity yet, ever.

Example:

false

rows
ValueLedgerRowOut · object[]
required

The ledger lines, most tangible first.