API Changelog (v1.0)

Track all changes to the Ultimate Custom Order Status API

Version Naming Convention

The API uses a two-tier versioning system:

Major Versions (URL-based)

Major versions with breaking changes require a URL change:

  • /api/v1/* - Version 1.x
  • /api/v2/* - Version 2.x (future)

Minor Versions (Header-based)

Minor versions with backward-compatible changes use the X-API-Version header:

  • X-API-Version: 1.0 - Version 1.0 (baseline, no addon statuses)
  • X-API-Version: 1.1 - Version 1.1 (addon statuses)
  • X-API-Version: 1.2 - Version 1.2 (draft order filtering, holiday skipping)
  • X-API-Version: 1.3 - Version 1.3 (includes workflows support)
  • X-API-Version: 1.4 - Version 1.4 (line-item status endpoints — supported)
  • X-API-Version: 1.5 - Version 1.5 (current and default, workflow reassignment and fulfilment selections)

Version Status at a Glance

VersionStatusServed without X-API-Version
X-API-Version: 1.5Current and defaultYes
X-API-Version: 1.4SupportedNo
X-API-Version: 1.3SupportedNo
X-API-Version: 1.2SupportedNo
X-API-Version: 1.1SupportedNo
X-API-Version: 1.0SupportedNo

Support

Questions and integration help — include the request and the response you received:

Email: support@msmtech.ca

Documentation: API Reference

v1.0 - Initial Release

Release Date: October 2025

Access Method: X-API-Version: 1.0

Features

  • Order listing with pagination, filtering, and search
  • Order detail retrieval
  • Status listing with sub-status support
  • Order status updates
  • Bulk operations support
  • Notification triggering

Available Endpoints:

  • GET /api/v1/orders
  • GET /api/v1/orders/:order_id
  • POST /api/v1/orders/:order_id/status
  • POST /api/v1/orders/status-bulk
  • GET /api/v1/statuses
  • GET /api/v1/statuses/:status_id
  • POST /api/v1/orders/:order_id/notify
  • POST /api/v1/orders/notify-bulk

Notes:

Does not include addon status support