Public API — Integration Guides

Step-by-step guides for integrating with the Retraced Public API. Each guide covers a specific partner use case with working curl examples derived from the API spec.

For interactive endpoint documentation and schema references, see the API Reference. For a history of API changes, see the release notes.

Start Here

v2

Getting Started & Integration FAQ

Start here. The conventions shared across every endpoint: authentication, the response envelope, pagination and incremental sync, date semantics, versioning, archiving vs deleting, and the questions integrators ask most.

 v2

DPP / Label Provider Guide

For Digital Product Passport providers and label integrators. Covers QR code retrieval, supply chain data, certificate lookup, and material composition.

 v2

LCA Provider Guide

For Life Cycle Assessment providers. Covers fetching product hierarchy, supply chain structure, company energy sources (ESG 2.1.6.1), and material composition.

Products

v2

Products Guide

Complete walkthrough of the styles, variants, and SKU lifecycle. Covers creating, updating, archiving, and querying products via the unified /styles endpoint.

 v2

BOM Guide

Bills of Materials: headers, lines, and the inheritance model. Covers ownership, copy-on-write behavior, main BOM versioning, and the gotchas integrators hit most.

 v2

Materials Guide

Material composition: headers, line trees, percentages, countries of origin, and the inheritance / copy-on-write model — including how it differs from BOM behavior.

Order Hub

v2

Orders & Order Lines Guide

Managing purchase/sales orders and their line items: creating orders, adding lines, pagination and filtering, auto-generated line numbers, and soft- vs hard-delete semantics.

Files

v2

File Upload Guide

Two-step flow for uploading files: request a pre-signed URL from POST /api/v2/files, then PUT the bytes directly to object storage. Covers allowed types, size limits, and required headers.

Authentication

All endpoints use the same API key, passed via the companyapikey request header. API keys are provided by the brand you are integrating with.

Base URLs: