Skip to main content
GET
Get product

Authorizations

X-API-Key
string
header
required

Per-manufacturer API key in the X-API-Key header, format emidat-{key_id}-{secret} where key_id is a random public handle. Issued by an owner in the Emidat dashboard; carries its own permission scopes, optional plant restrictions, and optional expiry. A revoked, expired, or unknown key returns 401. See the Authentication guide for details.

Path Parameters

id
string<uuid>
required

UUID of the product.

Response

Product.

A sellable product, independent of any plant — what you sell, as opposed to the product instances that say where and how it is made. Products are created and edited in the Emidat UI; the API only reads them.

id
string<uuid>
required
external_id
string | null
required

Your own code for this product (e.g. an article number), or null if none. Unique among your active products. See External IDs.

name
string
required
description
string
required

Free-text description, as entered in the Emidat UI. May be empty.

use_case
string
required

What the product is used for, as entered in the Emidat UI. May be empty.

elementary_id
string<uuid>
required

Emidat material-type UUID — determines the product type.

unit
enum<string>
required

The unit the product is sold in.

Available options:
M,
M2,
M3,
KG,
T,
L,
KWH,
MJ,
UNIT,
METRIC TON*KM
Example:

"KG"

is_published_on_emidat
boolean
required

Whether the product is published on the public Emidat catalog.

product_instance_ids
string<uuid>[]
required

The active product instances linked to this product — the manufacturing behind it. Empty while nothing is linked.

plant_ids
string<uuid>[]
required

The plants those instances are made at, derived from product_instance_ids.

created_at
string<date-time>
required

RFC 3339 timestamp of when the product was created.