Journal des modifications de l'API (v1.1)

Suivez tous les changements apportés à l'API Ultimate Custom Order Status

Convention de nommage des versions

L'API utilise un système de versionnement à deux niveaux:

Versions majeures (basées sur l'URL)

Les versions majeures avec des changements incompatibles nécessitent un changement d'URL:

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

Versions mineures (basées sur l'en-tête)

Les versions mineures avec des changements rétrocompatibles utilisent l'en-tête X-API-Version:

  • X-API-Version: 1.0 - Version 1.0 (base, sans statuts additionnels)
  • X-API-Version: 1.1 - Version 1.1 (statuts additionnels)
  • X-API-Version: 1.2 - Version 1.2 (filtrage des commandes brouillon, jours fériés)
  • X-API-Version: 1.3 - Version 1.3 (inclut le support des flux de travail)
  • X-API-Version: 1.4 - Version 1.4 (points de terminaison de statut par ligne — prise en charge)
  • X-API-Version: 1.5 - Version 1.5 (réaffectation de workflow et sélections d’exécution — prise en charge)
  • X-API-Version: 1.6 - Version 1.6 (actuelle et par défaut, statuts additionnels des articles dans la liste et le détail des commandes)

État des versions en un coup d’œil

VersionStatutServie sans X-API-Version
X-API-Version: 1.6Actuelle et par défautOui
X-API-Version: 1.5Prise en chargeNon
X-API-Version: 1.4Prise en chargeNon
X-API-Version: 1.3Prise en chargeNon
X-API-Version: 1.2Prise en chargeNon
X-API-Version: 1.1Prise en chargeNon
X-API-Version: 1.0Prise en chargeNon

Support

Questions et aide à l'intégration — incluez la requête et la réponse reçues :

v1.1 - Novembre 2025

Date de sortie: 14 novembre 2025

Méthode d'accès: X-API-Version: 1.1

Nouvelles fonctionnalités

Support des statuts complémentaires

Ajout du support des statuts complémentaires sur tous les points de terminaison liés aux commandes. Les statuts complémentaires peuvent être assignés en plus des statuts principaux.

Points de terminaison affectés:

  • GET /api/v1/orders - La liste des commandes inclut maintenant un tableau addon_statuses lorsque l'en-tête X-API-Version: 1.1 est présent
  • GET /api/v1/orders/:order_id - Le détail de la commande inclut maintenant un tableau addon_statuses lorsque l'en-tête X-API-Version: 1.1 est présent
  • GET /api/v1/statuses - La liste des statuts inclut maintenant un indicateur is_addon lorsque l'en-tête X-API-Version: 1.1 est présent

Changements de réponse

Les commandes incluent maintenant un champ addon_statuses avec support optionnel des sous-statuts:

Changements de réponse
{
  "id": "uuid",
  "status": {
    "id": "status-uuid",
    "name": "Processing",
    "color": "#2948ff"
  },
  "addon_statuses": [
    {
      "id": "addon-uuid-1",
      "name": "Quality Check",
      "color": "#10b981",
      "sub_status": {
        "id": "addon-sub-uuid",
        "name": "Passed"
      }
    },
    {
      "id": "addon-uuid-2",
      "name": "Packaging",
      "color": "#f59e0b",
      "sub_status": null
    }
  ]
}

Les statuts incluent maintenant des indicateurs de classification:

Classification des statuts
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Processing",
  "is_independent": false,
  "is_addon": false
}

Guide de migration

  • Aucune modification de code requise - entièrement rétrocompatible
  • Les requêtes sans en-tête de version utilisent la version par défaut (1.6)
  • Pour utiliser une version antérieure, indiquez-la explicitement avec l’en-tête X-API-Version
  • Aucune modification requise pour l'authentification ou la limitation de débit

Exemple de requête:

v1.1 Request
curl -X GET 'https://api.ultimate-custom-order-status.apps.msmtech.ca/api/v1/orders' \
  -H "X-API-Key: ucos_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "X-API-Version: 1.1"

Changements incompatibles

Aucun - cette version est rétrocompatible.

v1.0 - Version initiale

Date de sortie: Octobre 2025

Méthode d'accès: X-API-Version: 1.0

Fonctionnalités

  • Liste des commandes avec pagination, filtrage et recherche
  • Récupération des détails de commande
  • Liste des statuts avec support des sous-statuts
  • Mises à jour des statuts de commande
  • Support des opérations en masse
  • Déclenchement de notifications

Points de terminaison disponibles:

  • 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:

N'inclut pas le support des statuts complémentaires