Manage products, EU Digital Product Passports, operator parties, and GS1 EPCIS supply-chain events.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
TracePass API key as a bearer token (tp_ prefix). Mint one in the dashboard under Developer -> API Keys.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
GS1 EPCIS 2.0 supply-chain events. `export`, `capture`, `capture_job` and `query` are on every plan, Free included. Captured events count against the plan's event allowance (10 a month on Free); over it, `capture` returns an overage or hard-block message. Actions (pass via `action`, with `args`): - export — args: { id }. Export a passport's events as an EPCIS 2.0 JSON-LD document. Read-only. - export_by_serial — args: { serial, gtin? }. Same as export, addressed by your own serial. A serial is unique only WITHIN a GTIN — if it isn't unique in your account the call returns 409 ambiguous_serial; pass `gtin` (or use export by id). Read-only. - capture — args: { events }. `events` is an EPCISDocument, a single event, or an array of events (JSON-LD). Returns a 202 with a captureJobId. - capture_job — args: { jobId }. Poll an async capture job. Read-only. - query — args: { params? }. `params` is a key/value map of standard EPCIS query parameters (EQ_bizStep, GE_eventTime, MATCH_epc, …). Read-only.
EPCIS 2.0: export a passport's events (export | export_by_serial), capture new events, poll a capture job, or query events.
Arguments for the chosen action; required fields depend on `action`.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Tool list last changed Oct 23, 2026.
GS1 EPCIS 2.0 supply-chain events. `export`, `capture`, `capture_job` and `query` are on every plan, Free included. Captured events count against the plan's event allowance (10 a month on Free); over it, `capture` returns an overage or hard-block message. Actions (pass via `action`, with `args`): - export — args: { id }. Export a passport's events as an EPCIS 2.0 JSON-LD document. Read-only. - export_by_serial — args: { serial, gtin? }. Same as export, addressed by your own serial. A serial is unique only WITHIN a GTIN — if it isn't unique in your account the call returns 409 ambiguous_serial; pass `gtin` (or use export by id). Read-only. - capture — args: { events }. `events` is an EPCISDocument, a single event, or an array of events (JSON-LD). Returns a 202 with a captureJobId. - capture_job — args: { jobId }. Poll an async capture job. Read-only. - query — args: { params? }. `params` is a key/value map of standard EPCIS query parameters (EQ_bizStep, GE_eventTime, MATCH_epc, …). Read-only.
| Argument | Type | Description |
|---|---|---|
| args | object | Arguments for the chosen action; required fields depend on `action`. |
| action* | string | EPCIS 2.0: export a passport's events (export | export_by_serial), capture new events, poll a capture job, or query events. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"action"
],
"properties": {
"args": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Passport id. Required for export."
},
"gtin": {
"type": "string",
"description": "GTIN disambiguator for export_by_serial when the serial isn't unique (else 409)."
},
"jobId": {
"type": "string",
"description": "Capture job id to poll. Required for capture_job."
},
"events": {
"description": "EPCIS 2.0 event payload (an EPCISDocument or event list). Required for capture."
},
"params": {
"type": "object",
"description": "EPCIS query parameters as key→value strings (query, optional).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"serial": {
"type": "string",
"description": "Your serial. Required for export_by_serial."
}
},
"description": "Arguments for the chosen action; required fields depend on `action`."
},
"action": {
"enum": [
"export",
"export_by_serial",
"capture",
"capture_job",
"query"
],
"type": "string",
"description": "EPCIS 2.0: export a passport's events (export | export_by_serial), capture new events, poll a capture job, or query events."
}
}
}Update field values on a Digital Product Passport. Every change is recorded in the passport's audit trail with the credential that made it (API key or connected app) and this MCP channel. `source` (optional) says where the value came from. Omit it, or pass "manual", when the user gave you the value or it comes from their own records: it is written with the user's rights (approved for an API key or an admin; sent to review for a connected app acting for an editor). Pass "ai_suggested" when you found or inferred the value yourself (web research, reading a document): it lands in the dashboard review queue for a human to approve, and it is refused on fields only the economic operator may state or that must be measured (e.g. battery stateOfHealth). Actions (pass via `action`, with `args`): - update — args: { id, fieldKey, value, source? }. `value` type matches the field's dataType (string, number, boolean, array, object). - update_by_serial — args: { serial, fieldKey, value, gtin?, source? }. Same as update, addressed by your own serial. A serial is unique only WITHIN a GTIN — if it isn't unique in your account the call returns 409 ambiguous_serial; pass `gtin` (or use update by id) to resolve exactly.
| Argument | Type | Description |
|---|---|---|
| args | object | Arguments for the chosen action; required fields depend on `action`. |
| action* | string | Update one passport field, addressed by passport id (update) or by your serial (update_by_serial). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"action"
],
"properties": {
"args": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Passport id. Required for update."
},
"gtin": {
"type": "string",
"description": "GTIN disambiguator for update_by_serial when the serial isn't unique (else 409)."
},
"value": {
"description": "The new value for the field (required). Type depends on the field's dataType."
},
"serial": {
"type": "string",
"description": "Your serial. Required for update_by_serial."
},
"source": {
"enum": [
"manual",
"ai_suggested"
],
"type": "string",
"description": "Where the value came from: \"manual\" (default — the user's statement) or \"ai_suggested\" (you found it; it goes to human review)."
},
"fieldKey": {
"type": "string",
"description": "The field key to set (required)."
}
},
"description": "Arguments for the chosen action; required fields depend on `action`."
},
"action": {
"enum": [
"update",
"update_by_serial"
],
"type": "string",
"description": "Update one passport field, addressed by passport id (update) or by your serial (update_by_serial)."
}
}
}Manage the economic-operator parties on a passport — manufacturer, importer, authorisedRepresentative, distributor, recycler, producerResponsibilityOrg. Each party carries a legal name and at least one identifier. Identifier rules (EN 18219 §6.2–6.5): a party needs at least one of `gln`, `legacyOperatorId`, or `operatorIdentifier`. If both `gln` and `operatorIdentifier` (scheme gln) are provided they must agree — a mismatch returns 400. An operatorIdentifier of scheme gln also fills the top-level `gln` field; facilityIdentifier never does. Typed identifiers (operatorIdentifier / facilityIdentifier) are not set by AI extraction or CSV import. operatorIdentifier schemes: • iso6523 — { scheme:"iso6523", icd:"<4 digits>", value } — ICD 0199 = LEI (ISO 17442), 0088 = GLN, 0060 = DUNS. • gln — { scheme:"gln", gln:"<13 digits>" } — also fills top-level `gln`. • did — { scheme:"did", did:"did:<method>:<id>" } — syntax-checked only (EN 18219 §6.4.2(b)). • doi — { scheme:"doi", doi:"10.<registrant>/<suffix>" } — doi:/https://doi.org/ prefix accepted and stripped. facilityIdentifier schemes: same four; the gln variant also accepts optional `extension` (GS1 SGLN sub-location). Actions (pass via `action`, with `args`): - set — args: { id, role, legalName, gln?, country?, legacyOperatorId?, operatorIdentifier?, facilityIdentifier? }. Sets or updates one role. - remove — args: { id, role }. Clears one role.
| Argument | Type | Description |
|---|---|---|
| args | object | Arguments for the chosen action; required fields depend on `action`. |
| action* | string | Set (add/replace) or remove an economic-operator party on a passport by its role. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"action"
],
"properties": {
"args": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Passport id (required)."
},
"gln": {
"type": "string",
"description": "GS1 Global Location Number (13 digits). Strongly recommended for multi-role disambiguation."
},
"role": {
"type": "string",
"description": "Economic-operator role: manufacturer | importer | authorisedRepresentative | distributor | recycler | producerResponsibilityOrg (required)."
},
"country": {
"type": "string",
"description": "ISO 3166-1 alpha-2 country code (set, optional)."
},
"legalName": {
"type": "string",
"description": "Party legal name. Required for set."
},
"legacyOperatorId": {
"type": "string",
"description": "Free-text fallback identifier (VAT, EORI, supplier code). Required when gln and operatorIdentifier are both absent."
},
"facilityIdentifier": {
"type": "object",
"description": "Structured facility identifier per EN 18219 §6.2–6.5. Same four schemes as operatorIdentifier; the gln variant also accepts optional `extension` (GS1 SGLN sub-location). Never fills the top-level gln field. Not set by AI extraction.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"operatorIdentifier": {
"type": "object",
"description": "Structured operator identifier per EN 18219 §6.2–6.5. Must have `scheme` plus scheme fields. Schemes: iso6523 {icd:\"<4 digits>\", value} | gln {gln:\"<13 digits>\"} | did {did:\"did:<method>:<id>\"} | doi {doi:\"10.<registrant>/<suffix>\"}. scheme gln also fills the top-level gln field; they must match if both are set (400 otherwise). Not set by AI extraction.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"description": "Arguments for the chosen action; required fields depend on `action`."
},
"action": {
"enum": [
"set",
"remove"
],
"type": "string",
"description": "Set (add/replace) or remove an economic-operator party on a passport by its role."
}
}
}Manage Digital Product Passports — create, read, and run lifecycle actions. IMPORTANT: `create` makes a DRAFT passport. A draft takes no plan DPP slot and is never billed; the slot, and any per-DPP overage past the plan cap, is taken when the passport is published, which happens in the TracePass dashboard, not through this tool. Each create counts against the daily write budget. `archive` is IRREVERSIBLE (the public QR permanently 404s); prefer `suspend` when a change might be undone. IDENTIFIER SCHEMES (EN 18219): passports are identified by one of five schemes. Battery passports (Battery Regulation Art. 77(3)) accept ONLY gs1 and iso15459. • gs1 — { scheme:"gs1", gtin, serialNumber } — GS1 GTIN + serial; gtin is 8/12/13/14 digits, stored as GTIN-14. • iso15459 — { scheme:"iso15459", issuingAgencyCode, primaryId, serial? } — ISO/IEC 15459; the server derives raw (IAC + primaryId + serial). • iec61406 — { scheme:"iec61406", uri } — IEC 61406 Identification Link (https URI). Not valid for batteries. • did — { scheme:"did", did, method } — W3C DID Core. Not valid for batteries. • doi — { scheme:"doi", doi, granularity:"model"|"batch"|"item" } — ISO 26324 DOI, stored as bare 10.<registrant>/<suffix> (any https://doi.org/ or doi: prefix stripped on input; resolves as https://doi.org/<doi>); granularity REQUIRED per EN 18219 §5.6.2(b). Not valid for batteries. The legacy top-level gtin + serialNumber pair is still accepted as a deprecated alias for scheme:"gs1". Actions (pass via `action`, with `args`): - list — args: { page?, limit? (≤100), productId?, status?, search? }. status ∈ draft|in_review|approved|published|suspended|expired|archived. Read-only. - get — args: { id, format? (summary|full), lang? }. Read-only. Response includes `identifier`, `identifierKey`, and (for GS1 passports) `gs1`. - get_by_serial — args: { serial, format?, lang?, gtin? }. Read-only. Addresses the passport by your own serial. A serial is unique only WITHIN a GTIN — if the same serial exists under two GTINs in your account the call returns 409 ambiguous_serial; pass `gtin` (or use the by-id action) to resolve exactly. - compliance — args: { id }. Read-only. Returns a three-tier compliance verdict (compliant | compliant_with_warnings | incomplete) with regulation-cited findings — use to gap-check a passport against the rules for its category, fix the cited fields/parties, then re-check. Also returns byRegulation[]: the same findings grouped per regulation, worst first, so you can tell WHICH regime is failing instead of reading one `incomplete` as everything being wrong. A regulation absent from that array raised no finding — that is not the same as it having passed. - registry_readiness — args: { id }. Read-only. Returns { ready, findings[] } — whether the passport would pass the EU DPP Registry's FORMAL submission gate (mandatory fields present, correct formatting, a resolvable public link, item-level granularity via a serial number, and a well-formed commodity code where the category carries one). This is the registry's mechanical pre-submission check, NOT the substantive compliance verdict; a passport can be registry-ready yet not substantively compliant. Battery passports only. - create — args: { productId, identifier?, gtin?, serialNumber?, lineage? }. Creates a draft (not billed). Provide identifier (preferred) or legacy gtin + serialNumber. Battery passports accept only gs1 and iso15459 schemes — other schemes return 400. A duplicate identifier returns 409. lineage (battery only) — a repurposed, remanufactured or reused battery needs a NEW passport linked to the original(s) (Battery Regulation Art. 77(7)): { predecessors: [ { internalPassportId? | identifier?, trigger: preparation_for_reuse|preparation_for_repurposing|repurposing|remanufacturing } ] (≤10), noPredecessorReason? (only with an empty list, e.g. placed on the market before 18 Feb 2027) }. The server derives batteryStatus from the triggers and links your own predecessor passports back. Immutable after create. Rule violations return 422 with the rule code (duplicate_predecessor, predecessor_not_found, status_trigger_mismatch, …). - suspend — args: { id }. Reversible — public QR shows 'suspended'. - suspend_by_serial — args: { serial, gtin? }. Same as suspend, addressed by your serial. 409 ambiguous_serial if the serial isn't unique in your account — pass `gtin`. - archive — args: { id }. IRREVERSIBLE — confirm with the user first. - archive_by_serial — args: { serial, gtin? }. IRREVERSIBLE, addressed by your serial — confirm first. 409 ambiguous_serial if the serial isn't unique — pass `gtin`. - get_qr — args: { id, format? (svg|png), symbology? (qr|datamatrix) }. Read-only. symbology=datamatrix renders an ISO/IEC 16022 Data Matrix instead of a QR (EN 18220 permits both; same passport URL). - get_qr_by_serial — args: { serial, format? (svg|png), symbology? (qr|datamatrix), gtin? }. Read-only. Same as get_qr, addressed by your own serial. A serial is unique only WITHIN a GTIN — if the same serial exists under two GTINs in your account the call returns 409 ambiguous_serial; pass `gtin` (or use get_qr by id) to resolve exactly. - list_snapshots — args: { id, page?, limit? (≤100), at? (ISO 8601) }. Read-only. Returns a paginated list of snapshots for the passport (newest first). A snapshot is written on publish and after every change to a non-draft passport (EN 18221 change archive); each carries id, version, reason (e.g. published|field_edit|status_change|baseline), actor (who caused it, when known), snapshotAt, contentHash, hashValid (re-verified on every read), restorable, fieldCount. With `at`, returns instead the single snapshot valid at that instant (full record plus validFrom/validUntil) — answers "what did this passport say on date D"; 404 before the first snapshot. Counts 1 against the daily read budget. - get_snapshot — args: { id, snapshotId }. Read-only. Returns the full archival record of one snapshot: the complete JSON-LD the passport asserted at that time, plus hash and hashValid. Counts 1 against the daily read budget. - get_condition_flags — args: { id }. Read-only. Returns the resolved condition profile Record<flagKey,{value,status,source}>. Condition flags are reviewer-approved yes/no facts gating conditional legal duties. Battery flags: hasBMS, rechargeable, externalStorageOnly, isStationaryBess. An approved flag makes specific fields required — a missing gated field is a hard publish block (conditional_missing). Counts 1 against the daily read budget. - get_condition_flags_by_serial — args: { serial, gtin? }. Read-only. Same as get_condition_flags, addressed by your own serial. 409 ambiguous_serial if serial not unique — pass gtin. - set_condition_flags — args: { id, flags: Record<flagKey, boolean|null> }. WRITE. Set or clear condition flags (null clears). Keys must be registered for the passport category (battery: hasBMS, rechargeable, externalStorageOnly, isStationaryBess). WARNING: approving a flag can make fields required and block publishing if those fields are empty — fix any gated fields before or immediately after setting the flag. Writes are approved + audited. Idempotency-Key supported. Counts 1 write. - set_condition_flags_by_serial — args: { serial, gtin?, flags }. WRITE. Same as set_condition_flags, addressed by your own serial. 409 ambiguous_serial if serial not unique — pass gtin. - capture_measurements — args: { id, measurements: [ { fieldKey, value, measuredAt (ISO 8601), externalId?, unit? } ] (≤500) }. WRITE, battery passports only, published only. Pushes over-life measurements from the customer's own equipment (e.g. a BMS reporting stateOfHealth, numberOfFullEquivalentChargingCycles; the Annex XIII point 4 use-data keys). Every measurement is stored; the newest per field becomes the passport's current value and sets dynamicDataAsOf. externalId makes a measurement idempotent. A value may be at most 16 KB serialised. batteryStatus is NOT a measurement (400 invalid_field_key). A key the Regulation keeps off this battery category returns 422 field_not_applicable (e.g. stateOfCertifiedEnergy on an LMT battery). Metered against the plan's monthly measurement allowance, not the daily write budget: paid plans keep counting past it at no charge; Free stops at its allowance. Reading a passport is never metered. - capture_measurements_by_serial — args: { serial, gtin?, measurements }. Same, addressed by your own serial. - list_measurements — args: { id, fieldKey?, from?, to? (ISO 8601), limit? (≤200), cursor? }. Read-only. Measurement history, newest first; page with the returned nextCursor. - list_measurements_by_serial — args: { serial, gtin?, fieldKey?, from?, to?, limit?, cursor? }. Read-only. - latest_measurements — args: { id }. Read-only. The newest measurement per accepted key (null where none yet). - latest_measurements_by_serial — args: { serial, gtin? }. Read-only.
Manage the TracePass product catalogue. A product is the catalogue layer — one product can have many passports (one per serialised unit). Products are not billable on their own. Actions (pass via `action`, with `args`): - list — args: { page?, limit? (≤100), category?, status?, search? }. Read-only. - get — args: { id }. Read-only. - create — args: { name, model, category, description? }. `category` is one of: battery, textile, electronics, construction, steel, detergents, paints-coatings, packaging, furniture, tyres, jewelry, toys, fmcg. - update — args: { id, name?, model?, description? }; pass at least one field to change. - create_batch — args: { products: [ { name, model, category, description? }, … ] }, up to 100. Partial-success: the response carries a per-item status, so some items can be created while others error. The whole batch consumes N writes upfront; if that would exceed the daily cap NOTHING is created (429). - archive — args: { id }. Soft-archive a product. Blocked with 409 while any non-archived passport still references it — archive those passports first. This is reversible and is NOT deletion.
| Argument | Type | Description |
|---|---|---|
| args | object | Arguments for the chosen action; required fields depend on `action` (see each action above). |
| action* | string | Which product operation to run: list | get | create | create_batch | update | archive. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"action"
],
"properties": {
"args": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Product id. Required for get and update."
},
"name": {
"type": "string",
"description": "Product name. Required for create; optional on update."
},
"page": {
"type": "number",
"description": "Page number for list (1-based)."
},
"limit": {
"type": "number",
"description": "Page size for list, max 100."
},
"model": {
"type": "string",
"description": "Manufacturer model / SKU. Required for create; optional on update."
},
"search": {
"type": "string",
"description": "Filter list by a search term."
},
"status": {
"type": "string",
"description": "Filter list by product status."
},
"category": {
"type": "string",
"description": "DPP category for create: battery | textile | electronics | construction | steel | detergents | paints-coatings | packaging | furniture | tyres | jewelry | toys | fmcg."
},
"products": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"description": "Products to create for create_batch: [{ name, model, category, description? }], max 100."
},
"description": {
"type": "string",
"description": "Free-text product description (create/update)."
}
},
"description": "Arguments for the chosen action; required fields depend on `action` (see each action above)."
},
"action": {
"enum": [
"list",
"get",
"create",
"create_batch",
"update",
"archive"
],
"type": "string",
"description": "Which product operation to run: list | get | create | create_batch | update | archive."
}
}
}Check what EU law says for a product type matching the facts given: whether it needs a Digital Product Passport, from when, at which level, under which act and article, and the duties of each role. Also read the company's catalogue-wide scope report and trigger a catalogue refresh run. HARD RULES — always apply these to scope answers: - Answers state what the law says for product types matching the given facts. This is not legal advice; never write 'you must' — use product-type phrasing ('LMT batteries need a passport from 18 February 2027, Battery Regulation Art. 77(1)'). - Cite the article the answer gives for every verdict and duty. A regulation without an article is not a citation. A `not_covered` answer rests on no article: say our rules do not cover the product and name the nearest act it gives, never cite that act as the basis. - A date with precision 'quarter', 'month' or 'year' is a plan, NEVER a deadline or a start date. Write 'planned for Q2 2027 (planned, not law yet)', never 'from', 'by' or 'deadline'. - Relay `not_covered` and `needs_input` as the results they are, never as errors. `not_covered` = the product falls outside these scope rules. `needs_input` = blocking questions remain unanswered — relay the questions in `ask[]` to the user before giving a verdict. - Items in an act's `planned` list are not law yet: always label them 'Planned, not law yet' (`labelText`), with their `wording`. - `ruleStatus: 'needs_recheck'` means the law behind an act changed and our rules for it are being re-checked (since `recheckSince`): say so with the answer. Actions (pass via `action`, with `args`): - check — args: { category?, facts?, role?, placedOnMarket?, lifecycleEvent?, contains?, productId?, passportId?, locale? }. Ask whether a product type needs a DPP. Available on every plan, Free included. Counts against the per-company scope-answer cap (~100/day, 30/min burst), NOT the v1 read/write budget. 429 `scope_answer_cap` when the daily cap is spent. `not_covered` and `needs_input` are 200 results, not errors. category: one of battery | detergents | toys | construction | textile | steel | tyres | furniture | electronics | packaging | paints-coatings | jewelry | fmcg | vehicles | other. facts: namespace-prefixed keys from the loaded rules (e.g. battery.use, battery.capacityKWh). Unknown keys or wrong values return 400 invalid_input. role: your role in the act's terms: manufacturer | importer | distributor | authorised_representative | fulfilment_service_provider. Selling under your own name = manufacturer with facts.ownBrand: true. Omit to list every role's duties. placedOnMarket: { date: 'YYYY-MM-DD' | 'YYYY-MM' | 'YYYY', precision?: 'day'|'month'|'year' } or null. contains: array (≤5) of component queries — use to ask about a battery inside a toy: [ { label?, facts? } ]. locale: en | bg | de | it (default: from Accept-Language header, else en). - catalogue_report — args: { classification?, category?, act?, changed?, q?, cursor?, limit? (≤500) }. Read the catalogue-wide scope report (one row per product). Requires the Growth plan or above; 403 `plan_upgrade_required` below Growth — tell the user this needs a plan upgrade, do not retry. Counts 1 against the daily read budget per page. classification filter: missing | draft_only | published_incomplete | published | not_required | open_questions | not_covered. Response: { run, running, totals, items: [{ productId, passportIds, gtin, category, summary, classification, changedAt }], nextCursor, disclaimer }. Full answer for one product: call check with that productId. - catalogue_run — args: {}. Start a catalogue scope refresh run (also runs nightly). Returns 202 { runId, status }; poll with catalogue_run_status. Requires Growth plan. 409 run_in_progress if already active; 429 run_cooldown with retryAfter within 10 minutes of a finished run. - catalogue_run_status — args: { runId }. Get the status (queued | running | done | failed) and result counts for one catalogue run. Requires Growth plan.
Discover the regulatory field schema for each DPP category — what a COMPLIANT passport must contain, per the governing EU regulation. Read-only reference data. Use this to advise on requirements before creating products/passports, and to gap-check a draft against the rules. Actions (pass via `action`, with `args`): - list — args: {}. Lists all 13 categories with their field count, required-field count, and governing regulation (name + number + effective/mandatory dates). - get — args: { category }. Full field schema for one category: every field's key, label, dataType, whether it is REQUIRED, its access level (public/restricted/authority), enum options, validation bounds, and — where known — the regulation article/annex that mandates it. `category` is one of: battery, textile, electronics, construction, steel, detergents, paints-coatings, packaging, furniture, tyres, jewelry, toys, fmcg. BATTERY — required-ness is per-category, so `required` alone is the wrong answer. Resolve it in this order: 1. SCOPE FIRST. Only EV, LMT and industrial_gt_2kwh batteries owe a passport at all (Art. 77(1), Reg (EU) 2023/1542). For portable, SLI or industrial_lte_2kwh, NO field is required — do not list mandatory fields for them; say the battery is out of scope. 2. Then `requiredBy[batteryCategory]` where the field carries that map (required | conditional | notApplicable). 3. Then fall back to `required`. The map is keyed ONLY by the three in-scope categories, so skipping step 1 falls through to `required` and invents an obligation the Regulation does not impose. Note also that EV and LMT report state-of-health through MUTUALLY EXCLUSIVE field sets — an EV battery must leave the remaining-capacity cluster empty and an LMT battery must leave stateOfCertifiedEnergy empty, so no single battery ever fills every field.
| Argument | Type | Description |
|---|---|---|
| args | object | Arguments for the chosen action; `category` is required for get, ignored for list. |
| action |
| Argument | Type | Description |
|---|---|---|
| args | object | Arguments for the chosen action; required fields depend on `action` (see each action above). |
| action* | string | Which passport operation to run. Reads: list | get | get_by_serial | compliance | registry_readiness | get_condition_flags | get_condition_flags_by_serial | get_qr | get_qr_by_serial | list_snapshots | get_snapshot | list_measurements(_by_serial) | latest_measurements(_by_serial). Writes: set_condition_flags | set_condition_flags_by_serial | capture_measurements(_by_serial) | create (a draft, not billed). Lifecycle: suspend (reversible) | archive (IRREVERSIBLE), each with a _by_serial variant. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"action"
],
"properties": {
"args": {
"type": "object",
"properties": {
"at": {
"type": "string",
"description": "list_snapshots: ISO 8601 instant — return the snapshot valid then instead of the list."
},
"id": {
"type": "string",
"description": "Passport id. Required for get/compliance/suspend/archive/get_qr (the by-id actions)."
},
"to": {
"type": "string",
"description": "list_measurements(_by_serial): measuredAt to (ISO 8601)."
},
"from": {
"type": "string",
"description": "list_measurements(_by_serial): measuredAt from (ISO 8601)."
},
"gtin": {
"type": "string",
"description": "For create (legacy): GS1 GTIN. Also used as a disambiguator for *_by_serial actions when a serial isn't unique (else 409 ambiguous_serial)."
},
"lang": {
"type": "string",
"description": "Resolve field values to one of the 24 EU locales server-side (get/get_by_serial)."
},
"page": {
"type": "number",
"description": "Page number for list (1-based)."
},
"flags": {
"type": "object",
"description": "For set_condition_flags / set_condition_flags_by_serial: Record<flagKey, boolean|null>. null clears the flag.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"limit": {
"type": "number",
"description": "Page size for list, max 100."
},
"cursor": {
"type": "string",
"description": "list_measurements(_by_serial): nextCursor from the previous page."
},
"format": {
"type": "string",
"description": "get/get_by_serial: summary|full. get_qr/get_qr_by_serial: svg|png."
},
"search": {
"type": "string",
"description": "Filter list by a search term."
},
"serial": {
"type": "string",
"description": "Your own serial number. Required for the *_by_serial actions."
},
"status": {
"type": "string",
"description": "Filter list by status: draft|in_review|approved|published|suspended|expired|archived."
},
"lineage": {
"type": "object",
"required": [
"predecessors"
],
"properties": {
"predecessors": {
"type": "array",
"items": {
"type": "object",
"required": [
"trigger"
],
"properties": {
"trigger": {
"enum": [
"preparation_for_reuse",
"preparation_for_repurposing",
"repurposing",
"remanufacturing"
],
"type": "string"
},
"identifier": {
"type": "string",
"maxLength": 2000
},
"internalPassportId": {
"type": "string"
}
}
},
"maxItems": 10
},
"noPredecessorReason": {
"type": "string",
"maxLength": 500
}
},
"description": "create, battery only: link a second-life battery's new passport to the original passport(s) (Art. 77(7)). See the create action."
},
"fieldKey": {
"type": "string",
"description": "list_measurements(_by_serial): only this field key."
},
"productId": {
"type": "string",
"description": "Parent product id. Required for create."
},
"symbology": {
"type": "string",
"description": "get_qr/get_qr_by_serial: qr (default) | datamatrix."
},
"identifier": {
"type": "object",
"description": "EN 18219 scheme-tagged identifier for create. Must have `scheme` plus scheme-specific fields. Schemes: gs1 {gtin, serialNumber} | iso15459 {issuingAgencyCode, primaryId, serial?} | iec61406 {uri} | did {did, method} | doi {doi, granularity} (granularity: \"model\"|\"batch\"|\"item\" REQUIRED per EN 18219 §5.6.2(b)). Battery passports: gs1 and iso15459 only.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"snapshotId": {
"type": "string",
"description": "Snapshot id. Required for get_snapshot."
},
"measurements": {
"type": "array",
"items": {
"type": "object",
"required": [
"fieldKey",
"value",
"measuredAt"
],
"properties": {
"unit": {
"type": "string"
},
"value": {},
"fieldKey": {
"type": "string",
"minLength": 1
},
"externalId": {
"type": "string"
},
"measuredAt": {
"type": "string",
"minLength": 1
}
}
},
"description": "capture_measurements(_by_serial): [{ fieldKey, value, measuredAt, externalId?, unit? }], max 500."
},
"serialNumber": {
"type": "string",
"description": "Serial for the new passport (create, legacy gs1 path)."
}
},
"description": "Arguments for the chosen action; required fields depend on `action` (see each action above)."
},
"action": {
"enum": [
"list",
"get",
"get_by_serial",
"compliance",
"registry_readiness",
"get_condition_flags",
"get_condition_flags_by_serial",
"set_condition_flags",
"set_condition_flags_by_serial",
"capture_measurements",
"capture_measurements_by_serial",
"list_measurements",
"list_measurements_by_serial",
"latest_measurements",
"latest_measurements_by_serial",
"create",
"suspend",
"suspend_by_serial",
"archive",
"archive_by_serial",
"get_qr",
"get_qr_by_serial",
"list_snapshots",
"get_snapshot"
],
"type": "string",
"description": "Which passport operation to run. Reads: list | get | get_by_serial | compliance | registry_readiness | get_condition_flags | get_condition_flags_by_serial | get_qr | get_qr_by_serial | list_snapshots | get_snapshot | list_measurements(_by_serial) | latest_measurements(_by_serial). Writes: set_condition_flags | set_condition_flags_by_serial | capture_measurements(_by_serial) | create (a draft, not billed). Lifecycle: suspend (reversible) | archive (IRREVERSIBLE), each with a _by_serial variant."
}
}
}| Argument | Type | Description |
|---|---|---|
| args | object | Arguments for the chosen action; required fields depend on `action` (see above). |
| action* | string | Which scope operation to run: check | catalogue_report | catalogue_run | catalogue_run_status. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"action"
],
"properties": {
"args": {
"type": "object",
"properties": {
"q": {
"type": "string",
"description": "catalogue_report: search by product name or GTIN."
},
"act": {
"type": "string",
"description": "Filter catalogue_report by governing act (CELEX, e.g. 32023R1542)."
},
"role": {
"type": "string",
"description": "Role hint for check (e.g. manufacturer, importer, ownBrand)."
},
"facts": {
"type": "object",
"description": "Fact key→value map for check (e.g. { 'battery.use': 'ev' }).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"limit": {
"type": "number",
"description": "Page size for catalogue_report, max 500."
},
"runId": {
"type": "string",
"description": "Run id to poll (catalogue_run_status)."
},
"cursor": {
"type": "string",
"description": "Pagination cursor (catalogue_report)."
},
"locale": {
"type": "string",
"description": "Answer locale for check: en | bg | de | it."
},
"changed": {
"type": "boolean",
"description": "catalogue_report: true to return only rows changed since the last run."
},
"category": {
"type": "string",
"description": "Product category for check (battery, textile, vehicles, other, …)."
},
"contains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"facts": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"label": {
"type": "string"
}
}
},
"description": "Component queries for check (max 5), e.g. a toy containing a battery."
},
"productId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Product id — adds saved product facts and passport data to check."
},
"passportId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Passport id — adds saved passport facts to check."
},
"classification": {
"type": "string",
"description": "Filter catalogue_report by classification: missing | draft_only | published_incomplete | published | not_required | open_questions | not_covered."
},
"lifecycleEvent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Lifecycle event for check (e.g. end_of_life)."
},
"placedOnMarket": {
"anyOf": [
{
"type": "object",
"required": [
"date"
],
"properties": {
"date": {
"type": "string"
},
"precision": {
"type": "string"
}
}
},
{
"type": "null"
}
],
"description": "Placing date for check: { date: YYYY[-MM[-DD]], precision?: day|month|year } or null."
}
},
"description": "Arguments for the chosen action; required fields depend on `action` (see above)."
},
"action": {
"enum": [
"check",
"catalogue_report",
"catalogue_run",
"catalogue_run_status"
],
"type": "string",
"description": "Which scope operation to run: check | catalogue_report | catalogue_run | catalogue_run_status."
}
}
}| string |
| List all DPP category templates, or get one template by category. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"action"
],
"properties": {
"args": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "DPP category to fetch (required for get): battery | textile | electronics | construction | steel | detergents | paints-coatings | packaging | furniture | tyres | jewelry | toys | fmcg."
}
},
"description": "Arguments for the chosen action; `category` is required for get, ignored for list."
},
"action": {
"enum": [
"list",
"get"
],
"type": "string",
"description": "List all DPP category templates, or get one template by category."
}
}
}