GET

Obtenir un statut

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

Point de terminaison

Requête HTTP

GET /v1/statuses/:status_id

Authentification

Ce point de terminaison nécessite une clé API valide avec la permission canViewStatuses . 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	Description
`status_id`	string	UUID du statut à récupérer

Réponse

Retourne des informations détaillées sur le statut, y compris les paramètres de notification, les limites de durée et les options de sous-statut:

200 OK - Réponse de succès

{
  "success": true,
  "data": {
    "status": {
      "id": "string",
      "name": "string",
      "public_name": null,
      "use_public_name": true,
      "display_name": "string",
      "color": "string",
      "order": 0,
      "is_independent": true,
      "is_addon": true,
      "workflow_id": "string",
      "workflow_name": "string",
      "notifications": {
        "email": true,
        "sms": true,
        "whatsapp": true
      },
      "shopify_order_effect": "string",
      "max_duration": {
        "enabled": true,
        "seconds": 0,
        "skip_weekends": true,
        "skip_holidays": true,
        "show_public_overdue_date": true
      },
      "sub_status_group": null
    }
  }
}

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.
`status`	object	Objet de statut contenant tous les détails

Champs d'objet de statut

Champ	Type	Description
`id`	string	UUID du statut
`name`	string	Nom interne du statut
`public_name`	string \| null	Nom orienté client
`use_public_name`	boolean	Indique si le nom public doit être utilisé pour les clients
`display_name`	string	Nom d'affichage calculé (public_name si use_public_name est vrai, sinon name)
`color`	string	Code couleur hexadécimal du statut
`order`	number	Ordre d'affichage dans le flux de travail
`is_independent`	boolean	Indique si le statut peut être utilisé indépendamment du flux de travail
`is_addon`	boolean	Indique s'il s'agit d'un statut additionnel (v1.1 uniquement)
`workflow_id`	string	UUID du flux de travail auquel ce statut appartient (v1.3+ uniquement)
`workflow_name`	string	Nom du flux de travail auquel ce statut appartient (v1.3+ uniquement)
`notifications`	object	Objet contenant les paramètres de notification
`shopify_order_effect`	string	Effet sur la commande Shopify (par ex., NONE, MARKS_ORDER_FULFILLED)
`max_duration`	object	Objet contenant les paramètres de limite de durée
`sub_status_group`	object \| null	Objet contenant les détails du groupe de sous-statut, ou null

Champs d'objet de notifications

Champ	Type	Description
`email`	boolean	Indique si les notifications par email sont activées
`sms`	boolean	Indique si les notifications SMS sont activées
`whatsapp`	boolean	Indique si les notifications WhatsApp sont activées

Champs d'objet de durée maximale

Champ	Type	Description
`enabled`	boolean	Indique si la durée maximale est activée
`seconds`	number	Durée maximale en secondes
`skip_weekends`	boolean	Indique si les week-ends doivent être ignorés dans le calcul de durée
`skip_holidays`	boolean	Indique si les jours fériés doivent être ignorés dans le calcul de durée (v1.2+)
`show_public_overdue_date`	boolean	Indique si la date de retard doit être affichée aux clients

Champs de groupe de sous-statut

Champ	Type	Description
`id`	string	UUID du groupe de sous-statut
`name`	string	Nom du groupe de sous-statut
`options`	array	Tableau des options de sous-statut

Champs d'option de sous-statut

Champ	Type	Description
`id`	string	UUID de l'option de sous-statut
`name`	string	Nom de l'option de sous-statut
`order`	number	Ordre d'affichage de l'option de sous-statut

Exemples

Requête de base

Requête cURL

curl -X GET "https://api.ultimate-custom-order-status.apps.msmtech.ca/api/v1/statuses/8c1d4e2f-0a53-49b7-b6e4-7f2d9c3a5e10" \
  -H "X-API-Key: ucos_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "X-API-Version: 1.5"

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

Format d'ID de statut 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: canViewStatuses"
}

404 Non trouvé

Statut non trouvé

404 Non trouvé

{
  "success": false,
  "error": "Status 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"
  }
}