API Ultimate Custom Order Status

Gérez par programme les statuts de commande, envoyez des notifications et récupérez les données de commande

Version actuelle et par défaut 1.5. Tous les points de terminaison acceptent 1.0–1.5 ; envoyez X-API-Version pour 1.0–1.4.

Commencer

L'API Ultimate Custom Order Status vous permet d'interagir par programme avec votre système de gestion des commandes. Vous pouvez récupérer des commandes, mettre à jour les statuts, envoyer des notifications aux clients, et plus encore.

URL de base

URL de base de l'API
https://api.ultimate-custom-order-status.apps.msmtech.ca/api

Versionnement de l'API

L'API utilise un système de versionnement à deux niveaux avec des versions majeures dans l'URL et des versions mineures spécifiées via l'en-tête X-API-Version.

Version actuelle

Les versions 1.0–1.5 sont acceptées ; 1.5 est la version actuelle et par défaut. Une requête sans X-API-Version est servie en 1.5, et l’en-tête de réponse X-API-Version indique quelle version a servi la requête.

Utilisation d’une version spécifique avec l’en-tête X-API-Version
curl -X GET "https://api.ultimate-custom-order-status.apps.msmtech.ca/api/v1/orders?page=1&limit=25&use_shopify_order_id=false&sort_by=created_at&sort_order=desc&order_type=ALL" \
  -H "X-API-Key: ucos_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "X-API-Version: 1.5"

Comportement par défaut

Une requête sans X-API-Version est servie en 1.5. X-API-Version-Current et X-API-Version-Default indiquent tous deux 1.5 ; envoyer X-API-Version: 1.4 renvoie toujours la réponse 1.4 inchangée.

En-têtes de réponse pour une requête sans X-API-Version
X-API-Version: 1.5
X-API-Version-Current: 1.5
X-API-Version-Default: 1.5

Types d'identifiants de commande

L'API prend en charge deux types d'identifiants de commande. Vous pouvez choisir le type à utiliser en fonction de vos besoins d'intégration:

  • •UUID interne: Identifiant unique attribué par notre système (par ex., 550e8400-e29b-41d4-a716-446655440000). C'est la valeur par défaut.
  • •ID de commande Shopify: ID numérique du format GID Shopify (par ex., extraire 450789469 de gid://shopify/Order/450789469).
  • •Utilisez le paramètre use_shopify_order_id (requête ou corps selon le point de terminaison) défini sur true pour rechercher des commandes en utilisant des ID Shopify au lieu d'UUID internes.

Points de terminaison disponibles

GET/v1/orders

Récupérer une liste paginée de commandes avec des capacités de filtrage, tri et recherche.

En savoir plus
GET/v1/orders/:order_id

Récupérer des informations détaillées sur une commande spécifique par son ID.

En savoir plus
GET/v1/statuses

Récupérer une liste de tous les statuts de commande personnalisés configurés dans votre système.

En savoir plus
GET/v1/statuses/:status_id

Récupérer des informations détaillées sur un statut de commande personnalisé spécifique par son ID.

En savoir plus
POST/v1/orders/:order_id/notify

Forcer l'envoi de notifications client (email, SMS, WhatsApp) pour une commande spécifique.

En savoir plus
POST/v1/orders/:order_id/status

Mettre à jour le statut personnalisé d'une commande spécifique. Envoie automatiquement des notifications basées sur la configuration du statut.

En savoir plus
POST/v1/orders/notify-bulk

Envoyer des notifications aux clients pour plusieurs commandes en une seule requête.

En savoir plus
POST/v1/orders/status-bulk

Mettre à jour le statut personnalisé pour plusieurs commandes en une seule requête.

En savoir plus
POST/v1/orders/:order_id/workflow

Réaffectez une commande à un autre workflow. Le déplacement applique un statut de départ du workflow cible et entraîne le changement de statut ainsi que l'exécution qu'il déclenche.

En savoir plus

Démarrage rapide

1. Générer une clé API depuis votre tableau de bord

Accédez à la section Paramètres → Clés API de votre application pour générer une nouvelle clé API. Assurez-vous de la sauvegarder en toute sécurité car elle ne sera affichée qu'une seule fois.

En-tête d'authentification

Incluez votre clé API dans l'en-tête X-API-Key avec chaque requête:

En-tête d'authentification requis
X-API-Key: ucos_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

2. Effectuer votre première requête API avec une authentification appropriée

Exemple de requête API
curl -X GET "https://api.ultimate-custom-order-status.apps.msmtech.ca/api/v1/orders?page=1&limit=25&use_shopify_order_id=false&sort_by=created_at&sort_order=desc&order_type=ALL" \
  -H "X-API-Key: ucos_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "X-API-Version: 1.5"

3. Gérer la réponse

Toutes les réponses utilisent la même enveloppe JSON : { "success": true, "data": { ... } } en cas de succès, et { "success": false, "error": "..." } en cas d'échec. Vérifiez success avant de lire la charge utile.

Prochaines étapes