For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocumentationAPI Reference
DocumentationAPI Reference
  • Get Started
    • Introduction
    • Quickstart
    • Authentication
    • Rate Limit
    • Webhooks
  • Integration Guides
    • Overview
    • Tracking
    • Receiving
    • Returns
    • Billing
  • Other
    • Concepts
    • Status Reference
      • Versioning
      • 2025-07 Migration
      • 2026-01 Migration
    • Errors
    • FAQ
LogoLogo
On this page
  • API Versioning
  • Current Version
  • Release Schedule
  • Version Lifecycle
  • Legacy Version Deprecation
  • Deprecation Timeline
  • Experimental Features
  • Migration Assistance
OtherVersioning

Versioning Policy

||View as Markdown|
Was this page helpful?

Last updated February 24, 2026

Previous

Setup with API Token

Next

Upgrade to 2025-07

Built with

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-01
  • Base URL Format: https://api.shipbob.com/2026-01/

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

VersionRelease DateEnd of Support
2025-07Jul 31, 2025Jul 31, 2027
2026-01Jan 31, 2026Jan 31, 2028
2026-07Jul 31, 2026Jul 31, 2028

Legacy Version Deprecation

ShipBob previously used semantic versioning (1.0 and2.0).
These versions are now deprecated.

Deprecation Timeline

Legacy VersionStatusEnd of Support
1.0 / 2.0DeprecatedJul 31, 2026

After the end-of-support date, legacy versions will no longer be accessible.

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: support@shipbob.com