Changelog
Track API changes, new features, and updates. All endpoints are currently under the v0 prefix as we iterate toward a stable v1 release.
Versioning
The API uses URL-based versioning with the prefix /v0/. The v0 designation means the API is functional and production-ready but may receive breaking changes as we refine the interface based on developer feedback.
All current endpoints live under /v0/. When v1 is released, v0 will continue to work for a deprecation period with advance notice.
Breaking Change Policy
We try to avoid breaking changes, but during v0 they may happen. When they do:
Advance notice
Breaking changes are communicated via email to all registered OAuth clients at least 2 weeks before they take effect.
Additive by default
New fields, endpoints, and enum values are added without versioning. Your client should ignore unknown fields.
Deprecation period
Removed endpoints or changed behaviors will have a deprecation period where both old and new behavior coexist.
Recent Changes
Public API Launch
- OAuth 2.0 Authorization Code flow
- Shipments API (list, get, PnP, SPD)
- Inventory API (products, cartons, stock levels, warehouses)
- Invoices API (list, get, line items)
- Notifications API (unified feed)
- Recommendations API
- Organizations API
- Sandbox environment available
- OpenAPI 3.0 specification published