Added

New API Versioning Strategy

We are excited to announce a major update to our API versioning strategy. To better support the growing needs of the Lightspeed Retail (X-Series) platform, we are moving from Semantic Versioning to a Date-Based Versioning strategy.

This change is designed to provide a more predictable release schedule and a simplified, unified experience for developers.

What's Changing?

Date-Based Versions

Instead of versions like v2.1 or v3.0, new API versions will be identified by their release date in the format YYYY-MM.

Example:

  • 2026-01
  • 2026-04

Requests will now specify the version in the URL path:

GET /api/2026-01/products

Unified API Access

Each date-based version now includes the full set of APIs. You no longer need to manage different versions for different endpoints. Your application can reference a single version string to access all capabilities.

Quarterly Release Schedule

We will publish a new API release every 3 months.

  • Predictability: You'll know exactly when to expect new features and changes.
  • Support Lifecycle: Each version is supported for a minimum of 12 months, giving you ample time to plan upgrades.

For complete details on the new strategy, please refer to the Versioning Strategy documentation.