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 support)
  • X-API-Version: 1.1 - Version 1.1 (current, includes addon support)
  • X-API-Version: 1.2 - Version 1.2 (future features)

Support

For questions about API versioning or migration assistance:

Email: support@msmtech.ca

Documentation: API Reference

v1.0 - Initial Release

Release Date: October 2025

Access Method: Add X-API-Version: 1.0 header to requests

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