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

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

{
  "status": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Processing",
    "public_name": "Your order is being processed",
    "use_public_name": true,
    "display_name": "Your order is being processed",
    "color": "#2948ff",
    "order": 1,
    "is_independent": false,
    "notifications": {
      "email": true,
      "sms": false,
      "whatsapp": true
    },
    "shopify_order_effect": "NONE",
    "max_duration": {
      "enabled": true,
      "seconds": 86400,
      "skip_weekends": false,
      "show_public_overdue_date": true
    },
    "sub_status_group": {
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "name": "Shipping Methods",
      "options": [
        {
          "id": "770e8400-e29b-41d4-a716-446655440002",
          "name": "Standard Shipping",
          "order": 1
        },
        {
          "id": "880e8400-e29b-41d4-a716-446655440003",
          "name": "Express Shipping",
          "order": 2
        }
      ]
    }
  }
}

Champs de réponse

Objet de réponse racine

Champ	Type	Description
`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	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
`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
`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/550e8400-e29b-41d4-a716-446655440000" \
  -H "X-API-Key: your_api_key_here"

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

{
  "error": "Invalid status ID format",
  "details": {
    "errors": [...]
  }
}

401 Non autorisé

Clé API manquante ou invalide

401 Non autorisé

{
  "error": "Invalid API key"
}

403 Interdit

La clé API manque de permissions requises

403 Interdit

{
  "error": "Insufficient permissions"
}

404 Non trouvé

Statut non trouvé

404 Non trouvé

{
  "error": "Status not found",
  "details": {
    "statusId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

500 Erreur interne du serveur

Une erreur du serveur s'est produite

500 Erreur interne du serveur

{
  "error": "Internal server error",
  "details": {
    "message": "Error description"
  }
}