Getting Started
Versioning Policy
This guide outlines our approach to versioning and deprecation, helping developers
build stable and future-proof integrations.
using the format:
After the end-of-support date, legacy versions will no longer be accessible.
build stable and future-proof integrations.
API Versioning
Starting July 2025, ShipBob is adopting a date-based versioning schemeusing the format:
YYYY-MM
Current Version
- Latest Version:
2025-07 - Base URL Format:
https://api.shipbob.com/2025-07/
Release Schedule
- A new version will be released every 6 months (January and July).
- Each version will be supported for 12 months from its release date.
Version Lifecycle
| Version | Release Date | End of Support |
|---|---|---|
| 2025-07 | Jul 31, 2025 | Jul 31, 2026 |
| 2026-01 | Jan 31, 2026 | Jan 31, 2027 |
| 2026-07 | Jul 31, 2026 | Jul 31, 2027 |
Legacy Version Deprecation
ShipBob previously used semantic versioning (
These versions are now deprecated.
1.0 and2.0).These versions are now deprecated.
Deprecation Timeline
| Legacy Version | Status | End of Support |
|---|---|---|
| 1.0 / 2.0 | Deprecated | Jul 31, 2026 |
Experimental Features
ShipBob may release experimental endpoints to gather feedback and test new functionality.- Experimental endpoints are prefixed with
/experimental. - These endpoints are subject to change or removal without notice.
Migration Assistance
For migration assistance or questions:- Changelog: View API Changelog
- Email: [email protected]