Product Data OpenAPI

REST API specifications based on the ETIM xChange datamodel — product data, trade items, designed for programmatic consumption.

OpenAPI 3.1

Overview

Why a REST API for ETIM xChange?

The ETIM xChange V2.0 is a monolithic catalog file format for batch transfers. These OpenAPI specs transform it into focused REST APIs that unlock new capabilities.

Granular Access Query one product or trade item instead of downloading the entire catalog.
Incremental Sync Delta-only transfers via mutation date filtering — no more full exports.
Domain Decomposition Focused APIs (Product, Trade Item, Net Price, Stock) replace one monolithic tree.
SDK Generation Auto-generate typed clients in C#, Java, Python, and more from the OpenAPI spec.
Proper Data Types 112 string-encoded numeric fields converted to real numbers with format hints.
Governed Evolution Semantic versioning, 24-month deprecation policy, CI-enforced compatibility.

API Reference

Available APIs

Interactive documentation powered by Redocly. Select a version or download the bundled OpenAPI YAML for code generation.

Product API

Product information, specifications, ETIM classifications, and LCA environmental declarations.

Scope: read:products
View Docs ↓ YAML Changelog Domain Model

Trade Item API

Trade item details, descriptions, orderings, pricings, allowance/surcharges, relations, and logistics.

Scope: read:tradeitems
View Docs ↓ YAML Changelog Domain Model

Architecture

Architectural Overview

Any client can talk to any server — the OpenAPI specification is the shared contract, OAuth 2.0 and DSGO provide the trust layer.

Architecture diagram: client applications on the left (ERP, webshop, mobile app) send GET requests to server implementations on the right (2BA, DSGO node, other implementers), governed by the OpenAPI Specification above and secured by OAuth 2.0 / DSGO below.

Release History

Recent Releases

Each release includes a GitHub Release with downloadable assets, versioned documentation snapshot, and changelog entry.

Resources

Documentation & Governance

📋
Governance Model Versioning strategy, breaking change policy, 24-month deprecation, RFC process.
🔧
Implementer Guide URL contract, server variables, path conventions for API implementers.
🚀
Release Process How to tag, release, and publish a new API version.
💻
Source Repository OpenAPI source files, shared schemas, and CI configuration on GitHub.
💬
Issues & Feedback Report bugs, request features, or ask questions via GitHub Issues.
📖
Best Practices OpenAPI 3.1 conventions, naming rules, pagination, and schema patterns.
⚖️
MIT License Open-source license terms for using, modifying, and distributing this project.