GET

Obtenir une commande

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

Point de terminaison

Requête HTTP

GET /v1/orders/:order_id

Authentification

Ce point de terminaison nécessite une clé API valide avec la permission canViewOrders . 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 d'URL

Paramètre	Type	Requis	Description
`order_id`	string	Oui	Identifiant de commande (UUID par défaut, ou partie numérique de l'ID Shopify si le paramètre de requête use_shopify_order_id est true). Pour les ID de commande Shopify, extraire le numéro du format GID (par ex., pour 'gid://shopify/Order/450789469', utiliser '450789469').

Paramètres de requête

Paramètre	Type	Requis	Défaut	Description
`use_shopify_order_id`	boolean	Non	false	Définir à 'true' pour rechercher la commande en utilisant l'ID Shopify au lieu de l'UUID. Extraire le numéro du format GID Shopify (gid://shopify/Order/450789469 → 450789469) et l'utiliser dans le paramètre de chemin order_id.

Réponse

Retourne un objet JSON avec les détails de la commande:

200 OK - Réponse de succès

{
  "order": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "shopify_order_id": "gid://shopify/Order/123456789",
    "name": "#1001",
    "created_at": "2024-10-30T12:00:00Z",
    "custom_status": {
      "id": "status-uuid",
      "name": "Processing",
      "color": "#2948ff"
    },
    "custom_sub_status": {
      "id": "sub-status-uuid",
      "name": "Awaiting Parts"
    },
    "customer": {
      "first_name": "John",
      "last_name": "Doe",
      "email": "john@example.com",
      "phone": "+1234567890"
    },
    "shipping_address": {
      "company": "Acme Corp",
      "address1": "123 Main St",
      "address2": "Suite 100",
      "city": "New York",
      "province": "NY",
      "zip": "10001",
      "country": "United States",
      "latitude": "40.7128",
      "longitude": "-74.0060"
    },
    "total_price": "150.00",
    "currency": "USD",
    "line_items": [
      {
        "id": "line-item-uuid",
        "shopify_line_item_id": "gid://shopify/LineItem/123456789",
        "name": "Product Name",
        "quantity": 2
      }
    ],
    "note": "Please ship carefully",
    "cancelled": false,
    "cancelled_at": null
  }
}

Champs de réponse

Objet de réponse racine

Champ	Type	Description
`order`	object	L'objet de commande contenant tous les détails de la commande

Objet de commande

Champ	Type	Description
`id`	string	Identifiant unique de la commande (UUID)
`shopify_order_id`	string	ID global Shopify de la commande
`name`	string	Numéro de commande (par ex., #1001)
`created_at`	string	Horodatage ISO 8601 de création de la commande dans Shopify
`custom_status`	object	Informations sur le statut personnalisé
`custom_sub_status`	object \| null	Informations sur le sous-statut personnalisé
`customer`	object	Informations du client
`shipping_address`	object	Informations d'adresse de livraison
`total_price`	string	Prix total de la commande
`currency`	string	Code de devise (par ex., USD, CAD)
`line_items`	array	Tableau d'objets d'articles de ligne
`note`	string \| null	Note/commentaires de la commande
`cancelled`	boolean	Indique si la commande est annulée
`cancelled_at`	string \| null	Horodatage ISO 8601 de l'annulation de la commande

Champs d'objet de statut

Champ	Type	Description
`id`	string	Identifiant unique du statut personnalisé
`name`	string	Nom d'affichage du statut (utilise le nom public si configuré)
`color`	string	Code couleur hexadécimal du statut

Objet de sous-statut

Champ	Type	Description
`id`	string	Identifiant unique du sous-statut
`name`	string	Nom du sous-statut

Champs d'objet client

Champ	Type	Description
`first_name`	string	Prénom du client
`last_name`	string	Nom de famille du client
`email`	string	Adresse email du client
`phone`	string \| null	Numéro de téléphone du client

Champs d'objet d'adresse de livraison

Champ	Type	Description
`company`	string \| null	Nom de l'entreprise
`address1`	string	Ligne d'adresse principale
`address2`	string \| null	Ligne d'adresse secondaire
`city`	string	Nom de la ville
`province`	string	Code d'état/province
`zip`	string	Code postal
`country`	string	Nom du pays
`latitude`	string \| null	Coordonnée de latitude
`longitude`	string \| null	Coordonnée de longitude

Champs d'objet d'article de ligne

Champ	Type	Description
`id`	string	Identifiant unique pour l'article de ligne
`shopify_line_item_id`	string	ID global Shopify pour l'article de ligne
`name`	string	Nom du produit
`quantity`	number	Quantité commandée

Exemples

Requête de base (UUID)

Requête cURL

curl -X GET "https://api.ultimate-custom-order-status.apps.msmtech.ca/api/v1/orders/550e8400-e29b-41d4-a716-446655440000" \
  -H "X-API-Key: your_api_key_here"

Utilisation de l'ID de commande Shopify

Requête cURL

curl -X GET "https://api.ultimate-custom-order-status.apps.msmtech.ca/api/v1/orders/5460132438316?use_shopify_order_id=true" \
  -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 commande invalide

400 Mauvaise requête

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

401 Non autorisé

Clé API manquante ou invalide

401 Non autorisé

{
  "error": "Unauthorized"
}

403 Interdit

La clé API manque de permissions requises

403 Interdit

{
  "error": "Insufficient permissions"
}

404 Non trouvé

Commande non trouvée ou n'appartient pas à cette boutique

404 Non trouvé

{
  "error": "Order not found",
  "details": {
    "orderId": "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"
  }
}