Aller au contenu

API Gestion des commandes

L'ensemble des méthodes regroupées dans la rubrique "Order" permettent de consulter les commandes et les tickets associés pour l'API client StockTicket. Les méthodes décrites dans cette section permettent de gérer la consultation des commandes passées par les clients.

Schéma général

Les commandes sont créées suite à la finalisation et au paiement d'un panier. Une fois créée, une commande contient l'ensemble des billets achetés par le client.

Méthodes de consultation des commandes

GetDetail - Récupération du détail d'une commande

Méthode : GET /Order/GetDetail

Retourne les informations détaillées sur une commande en se basant sur le token d'identification de la commande.

Paramètres : - orderToken (obligatoire) : Token d'identification de la commande fourni précédemment lors de la finalisation du processus de commande

Note : L'orderToken est obligatoire et permet de sécuriser l'accès à la consultation de la commande.

Détails supplémentaires : - Le token de commande est généré automatiquement lors de la finalisation du panier - Le module de vente du token doit correspondre au contexte d'appel - La méthode vérifie automatiquement les droits d'accès via le token

Réponses : - 200 OK : Retourne le détail de la commande (ClientOrderDetailModel) - 400 Bad Request : Token invalide ou non conforme au contexte - 404 Not Found : Commande non trouvée

GetList - Récupération de la liste des commandes d'un client

Méthode : GET /Order/GetList

Retourne la liste des commandes passées par un client identifié par son CustomerId.

Paramètres : - parameters : Paramètres de filtrage et de pagination de la liste (ClientOrderListParameters)

Note : La liste des commandes retournée est filtrée en fonction de l'identifiant du client renseigné dans le contexte d'appel, dans l'en-tête HTTP Stk-Cust-Id.

Détails supplémentaires : - L'identifiant client doit être obligatoirement renseigné dans le contexte d'appel - La méthode applique automatiquement un filtre sur le workspace et le client connecté - Permet de récupérer l'historique complet des commandes d'un client

Réponses : - 200 OK : Retourne la liste paginée des commandes (ListResult<ClientOrderListItemModel>) - 400 Bad Request : Identifiant client non renseigné ou contexte invalide - 404 Not Found : Aucune commande trouvée

Méthodes de consultation des tickets

Pour plus de détails sur la consultation des tickets associés aux commandes, consulter également les méthodes : - GetTicketFormats : Récupère les formats de fichiers disponibles pour les tickets - GetTicketFile : Récupère un fichier de ticket au format attendu - GetTicketDetail : Retourne le détail des informations d'un ou plusieurs tickets

Consulter la rubrique Tickets pour plus d'informations.

Gestion des clients invités

StockTicket permet également de gérer les commandes pour les clients "invités" (sans compte utilisateur) via les méthodes : - SendGuestOrderList : Envoie par email le récapitulatif des commandes d'un client invité - GetGuestOrderDetail : Retourne le détail d'une commande d'un client invité à partir d'un token envoyé par email

Client "invité" : Un client n'ayant pas de compte utilisateur dans le système StockTicket. Les commandes sont rattachées à son adresse email.

Notes importantes

  1. Sécurisation des accès : Toutes les méthodes de consultation utilisent des tokens sécurisés pour garantir l'accès uniquement aux commandes autorisées.

  2. Transmission de l'identifiant client : Pour utiliser la méthode GetList, consultez la documentation API StockTicket rubrique "Transmission de l'identifiant client final" pour plus de détails sur la gestion de l'en-tête Stk-Cust-Id.

  3. Formats de tickets : Les billets peuvent être récupérés dans différents formats (PDF, Wallet, etc.) selon les modules de génération de tickets configurés.