Référence de l'API

Référence complète pour tous les points de terminaison de l'API Ultimate Custom Order Status

Aperçu

L'API Ultimate Custom Order Status fournit un accès programmatique pour gérer les statuts de commande, envoyer des notifications et récupérer les informations de commande. Tous les points de terminaison nécessitent une authentification et suivent les conventions RESTful.

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

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.

GET/v1/orders/:order_id

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

GET/v1/statuses

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

GET/v1/statuses/:status_id

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

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.

POST/v1/orders/:order_id/notify

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

POST/v1/orders/status-bulk

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

POST/v1/orders/notify-bulk

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

Authentification

Toutes les requêtes API nécessitent une authentification à l'aide de clés API. Pour commencer, vous devrez générer une clé API à partir des paramètres de votre application:

Accédez à votre application Ultimate Custom Order Status
Allez dans Paramètres → Clés API
Cliquez sur "Générer une nouvelle clé API"
Configurez les permissions appropriées pour votre cas d'utilisation
Enregistrez la clé API en toute sécurité (elle ne sera affichée qu'une seule fois)

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

En savoir plus dans le Guide d'authentification

Limitation de débit

Tous les points de terminaison de l'API sont soumis à une limitation de débit pour assurer la stabilité du service. Les limites de débit sont appliquées par clé API avec deux fenêtres séparées:

Limite par minute: Configurable par clé API (par défaut: 60 requêtes/minute)
Limite par jour: Configurable par clé API (par défaut: 10 000 requêtes/jour)

Les informations de limite de débit sont incluses dans les en-têtes de réponse:

X-RateLimit-Limit-Minute - Nombre maximum de requêtes par minute
X-RateLimit-Remaining-Minute - Requêtes restantes dans la minute en cours
X-RateLimit-Reset-Minute - Horodatage Unix de réinitialisation de la fenêtre minute
X-RateLimit-Limit-Day - Nombre maximum de requêtes par jour
X-RateLimit-Remaining-Day - Requêtes restantes dans le jour en cours
X-RateLimit-Reset-Day - Horodatage Unix de réinitialisation de la fenêtre jour
Retry-After - Secondes à attendre avant de réessayer (présent uniquement en cas de limitation)

Gestion des erreurs

L'API utilise des codes d'état HTTP standard pour indiquer le succès ou l'échec:

200 OK-Requête réussie

400 Bad Request-Paramètres de requête invalides

401 Unauthorized-Authentification manquante ou invalide

403 Forbidden-Permissions insuffisantes

404 Not Found-Ressource non trouvée

500 Server Error-Erreur interne du serveur