POST

Envoyer une notification

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

Point de terminaison

Requête HTTP

POST /v1/orders/:order_id/notify

Authentification

Ce point de terminaison nécessite une clé API valide avec la permission canSendNotifications . La clé API doit être passée dans l'en-tête X-API-Key .

En-tête requis

X-API-Key: ucos_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Paramètres de chemin

Paramètre	Type	Requis	Défaut	Description
`order_id`	string	Oui	-	Identifiant de commande (UUID par défaut, ou partie numérique de l'ID Shopify si use_shopify_order_id est activé dans le corps de la requête)

Corps de la requête

Paramètre	Type	Requis	Défaut	Description
`channels`	string[]	Oui	-	Canaux de notification à utiliser: "email", "sms", "whatsapp". Au moins un canal est requis pour éviter les notifications accidentelles.
`use_shopify_order_id`	boolean	Non	false	Définir à 'true' pour rechercher la commande en utilisant l'ID Shopify. Extraire le numéro du format GID Shopify (gid://shopify/Order/450789469 → 450789469) et l'utiliser dans le chemin URL

Réponse

Retourne les résultats détaillés des notifications:

200 OK - Réponse de succès

{
  "success": true,
  "data": {
    "message": "string",
    "order_id": "string",
    "notifications_sent": {
      "email": "string",
      "sms": "string",
      "whatsapp": "string"
    }
  }
}

Champs de réponse

Objet de réponse racine

Champ	Type	Description
`success`	boolean	Toujours true pour une réponse réussie.
`data`	object	Charge utile de le point de terminaison. Ses champs sont détaillés dans les tableaux ci-dessous.
`message`	string	Message de confirmation
`order_id`	string	UUID de la commande
`notifications_sent`	object	Objet contenant le statut de notification pour chaque canal

Champs d'objet de notifications envoyées

Champ	Type	Description
`email`	string	Statut de notification email: "sent", "skipped", ou "failed"
`sms`	string	Statut de notification SMS: "sent", "skipped", ou "failed"
`whatsapp`	string	Statut de notification WhatsApp: "sent", "skipped", ou "failed"

Exemples

Requête de base

Requête cURL

curl -X POST "https://api.ultimate-custom-order-status.apps.msmtech.ca/api/v1/orders/8c1d4e2f-0a53-49b7-b6e4-7f2d9c3a5e10/notify" \
  -H "X-API-Key: ucos_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "X-API-Version: 1.5" \
  -H "Content-Type: application/json" \
  -d '{"order_id":"8c1d4e2f-0a53-49b7-b6e4-7f2d9c3a5e10","use_shopify_order_id":false,"type":"email","message":"string"}'

Utilisation de l'ID de commande Shopify

Requête cURL

curl -X POST "https://api.ultimate-custom-order-status.apps.msmtech.ca/api/v1/orders/5460132438316/notify" \
  -H "X-API-Key: ucos_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "X-API-Version: 1.5" \
  -H "Content-Type: application/json" \
  -d '{
    "channels": ["email"],
    "use_shopify_order_id": true
  }'

Limitation de débit

Ce point de terminaison est soumis à des limites de débit par minute et par jour en fonction de votre clé API. Les informations de limite de débit sont renvoyées 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 (en cas de limitation)

Réponses d'erreur

400 Mauvaise requête

Corps de requête invalide

400 Mauvaise requête

{
  "success": false,
  "error": "Validation failed",
  "details": {
    "errors": [
      {
        "code": "invalid_type",
        "expected": "string",
        "received": "undefined",
        "path": [
          "status_id"
        ],
        "message": "Required"
      }
    ]
  }
}

401 Non autorisé

Clé API manquante ou invalide

401 Non autorisé

{
  "success": false,
  "error": "Missing API key. Include it in the X-API-Key header"
}

403 Interdit

La clé API manque de permissions requises

403 Interdit

{
  "success": false,
  "error": "Insufficient permissions. Required: canSendNotifications"
}

404 Non trouvé

Commande non trouvée

404 Non trouvé

{
  "success": false,
  "error": "Order not found"
}

500 Erreur interne du serveur

Une erreur du serveur s'est produite

500 Erreur interne du serveur

{
  "success": false,
  "error": "Internal server error",
  "details": {
    "message": "An unexpected error occurred"
  }
}