Versioning Policy
Versioning Scheme
Major versions are documented as separate integration guides (e.g. /guides/shipments/v3). Each version corresponds to a specific entity schema revision. When a new major version is released, the JSON (queue) and CSV (SFTP) formats are updated accordingly.
Non-Breaking Changes
- New optional entity fields
- New allowed values for existing enumerated fields
- New entities or guides added to the portal
- Improved validation error messages
Breaking Changes (require a new major version)
- Renaming or removing fields
- Changing field types or formats (e.g. date format, number precision)
- Making optional fields required
- Removing allowed values from enumerated fields
- Removing an entity guide entirely
New Version Lifecycle
- Announcement → Beta → GA → Deprecation → Sunset