EDI Versioning
Public DataShift EDI schema versioning and compatibility policy.
DataShift public EDI contracts are versioned so partners can pin integrations, validate reliably, and adopt changes deliberately. Each document type can move at its own schema version.
View current schema library · Compare versions
Current Document Artifacts
Public schema files are pinned independently by document type. A document can publish a new compatible schema version without forcing unrelated documents to publish at the same time.
Versioning: per document · Major path: v1 · Documents: 4
| Document | Current version | Pinned URL |
|---|---|---|
| Purchase Order | 1.0.11 | /edi/contracts/releases/1.0.11/schemas/purchase-order.schema.json |
| Purchase Order Acknowledgement | 1.0.13 | /edi/contracts/releases/1.0.13/schemas/purchase-order-acknowledgement.schema.json |
| Advance Shipping Notice | 1.0.8 | /edi/contracts/releases/1.0.8/schemas/advance-shipping-notice.schema.json |
| Invoice | 1.0.12 | /edi/contracts/releases/1.0.12/schemas/invoice.schema.json |
Historical Versions And Comparison
Historical schema versions are listed under each document, not under a shared release page. A document only shows versions that apply to that document.
Immutable contract artifacts
Immutable
Every versioned public schema or OpenAPI document is treated as immutable. A published artifact should not change in place; corrections require a new schema version for the affected document.
Major schema versions
Public schema URLs include the major version. Breaking schema changes require a new major version path so existing integrations can continue to validate against their selected contract.
Backwards compatibility
Additive changes should preserve existing required fields, enum meanings, identifier semantics, and correlation behavior within the same major version.
Stable channel behavior
The current documentation points developers to the recommended artifact for each document type. Consumers that need deterministic validation should pin to the document schema version they use.
CDN cache expectations
Versioned JSON files are suitable for long-lived caching. Current schema links may move forward when a new artifact version is promoted.
Last updated on