Your compliance data, programmable

Get API access

Everything on this page is public, and stays public: the endpoint reference, the field tables and the OpenAPI document. You can size the integration, build against the spec and generate a client before you talk to anyone.

What we issue on request is the credential. API keys are company-scoped and provisioned by us for customers on a paid plan; there is no self-service key page yet, so the first one comes from a conversation. Tell us which system is calling and whether it reads or writes, and we set it up.

POST /api/v1/oauth/token

Exchange client credentials for a bearer token

RFC 6749 §4.4. client_id is your API key id, client_secret is the ppwr_… key itself; send them as HTTP Basic credentials or as body parameters. The token is valid for 900 seconds and carries the scopes you asked for — omit scope to get every scope your client holds. There is no refresh token: a client credentials grant needs no user present, so re-requesting is the refresh. Revoking the API key invalidates outstanding tokens at once. Both application/x-www-form-urlencoded (what the RFC mandates) and application/json bodies are accepted. Unknown parameters are ignored rather than refused, so a generic OAuth library that sends extras works.

Request body: TokenRequest as JSON. Unknown fields are rejected rather than ignored, so a typo in a field name is an error you see at once instead of data that silently never arrived.

GET /api/v1/skus

List your SKUs

Newest first. Use limit/offset to page through the portfolio.

POST /api/v1/skus

Create or update one SKU

Upserts by sku_code within your company: an unknown code creates, a known one updates. The recyclability grade is recomputed on every write, from the component graph when there is one. Your plan's SKU limit applies exactly as it does in the app — the API is not a way around it, though re-sending SKUs you already hold costs no quota. A field you omit is left exactly as it is; a field you send as null is cleared. So an ERP exporting ten columns never wipes the twenty a colleague filled in the app. components is the one array field: sending it replaces the SKU’s whole component graph, omitting it keeps the existing one, and [] clears it.

Request body: SkuInput as JSON. Unknown fields are rejected rather than ignored, so a typo in a field name is an error you see at once instead of data that silently never arrived.

GET /api/v1/skus/{id}

Get one SKU with components and compliance

Adds the component graph and the compliance block (Annex II grade, DoC status, Annex V format-ban flags) to the list shape. Another company's id returns 404 — the same answer as an id that does not exist.

PUT /api/v1/skus/{id}

Update one SKU by id

Same body as POST /api/v1/skus, addressed by PPWR Connect id instead of sku_code. The body's sku_code must match the row: renaming a code through PUT would quietly create a second record rather than rename anything. A field you omit is left exactly as it is; a field you send as null is cleared. So an ERP exporting ten columns never wipes the twenty a colleague filled in the app. components is the one array field: sending it replaces the SKU’s whole component graph, omitting it keeps the existing one, and [] clears it.

Request body: SkuInput as JSON. Unknown fields are rejected rather than ignored, so a typo in a field name is an error you see at once instead of data that silently never arrived.

POST /api/v1/skus/batch

Create or update many SKUs in one call

Up to 1 000 SKUs per call, same upsert semantics as the single write. Rows are independent: a rejected row is reported in results with its reasons and does not roll back the others — a 500-reference push lands the 499 good ones and tells you what to fix. Set dry_run: true to validate an export end to end without writing anything. A field you omit is left exactly as it is; a field you send as null is cleared. So an ERP exporting ten columns never wipes the twenty a colleague filled in the app. components is the one array field: sending it replaces the SKU’s whole component graph, omitting it keeps the existing one, and [] clears it.

Request body: SkuBatchInput as JSON. Unknown fields are rejected rather than ignored, so a typo in a field name is an error you see at once instead of data that silently never arrived.

POST /api/v1/imports

Submit a CSV or XLSX file for import

The batch door: hand us the same CSV/XLSX the app accepts and poll GET /api/v1/imports/{id} for a line-by-line verdict. Answers 202 with an id — the writing happens after the response, because ingestion costs a round trip per SKU and a few thousand references do not fit in one request. What is decided BEFORE the 202, so an accepted import never fails for a reason you could have been told up front: the file parses, a table was found, sku_code and name map to columns, and the whole file fits your plan. source in the response says which sheet, which header row and which column we read each field from — check it first when a value did not land where you expected. Send the file as a file part of a multipart body, or as the raw bytes with ?filename= naming it. Up to 10 MiB and 50 000 rows. An optional second sheet named components replaces the component graph of the SKUs it names, and only those. A field you omit is left exactly as it is; a field you send as null is cleared. So an ERP exporting ten columns never wipes the twenty a colleague filled in the app. components is the one array field: sending it replaces the SKU’s whole component graph, omitting it keeps the existing one, and [] clears it.

Request body: object as JSON. Unknown fields are rejected rather than ignored, so a typo in a field name is an error you see at once instead of data that silently never arrived.

GET /api/v1/imports/{id}

Import status and line-by-line error report

Poll until status is completed or failed. completed means every row has an outcome — including the rejected ones, which is what errors[] is for: each carries the line number of your own file so you can fix the export rather than guess. The report is paginated with limit / offset. Polling also nudges an import that stalled, so there is no state in which asking for the status leaves it stuck.

GET /api/v1/docs

List your Declarations of Conformity

Metadata only — reference, supplier, status and validity dates. v1 returns no file contents and no download URLs; the PDF export stays in the app.

SkuListItem

SkuComponent

SkuCompliance

DocListItem

SkuInput