Versioning Policy
This guide outlines our approach to versioning and deprecation, helping developers
build stable and future-proof integrations.
API Versioning
Starting July 2025, ShipBob is adopting a date-based versioning scheme
using the format:
YYYY-MM
Current Version
- Latest Version:
2026-07 - Base URL Format:
https://api.shipbob.com/2026-07/
Release Schedule
- A new version will be released every 6 months (January and July).
- Each version will be supported for 24 months from its release date.
Version Lifecycle
Legacy Version Deprecation
ShipBob previously used semantic versioning (1.0 and2.0).
These versions are now deprecated.
Deprecation Timeline
After the end-of-support date, legacy versions will no longer be accessible.
1.0 Deprecation Rollout
To give integrations time to migrate, access to API 1.0 is phased out gradually rather than cut off all at once. Starting the week after end-of-support, an increasing share of 1.0 requests is blocked (per merchant account) until 1.0 is fully retired:
This blocking is scoped to 1.0 traffic only; dated versions (e.g. 2026-07) are unaffected. See Errors for details on the 410 response returned once a request is blocked.
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:
- Upgrade guides: Upgrade to 2025-07, Upgrade to 2026-01, Upgrade to 2026-07
Each guide lists the changes for a single version step. Apply them in order if you are more than one version behind. - Changelog: View API Changelog
- Email: support@shipbob.com