E-shop API – commandes
Événements de commande : nouvelle commande, changement de statut, paiement, numéro de suivi, annulation d'un produit et avoir. Les paramètres de la requête, le choix de la notification et la forme de la réponse sont les mêmes pour tous et sont décrits dans la vue d'ensemble de l'E-shop API.
API URL
| ENDPOINT | ÉVÉNEMENT DE NOTIFICATION |
|---|---|
https://portal.bulkgate.com/api/1.0/eshop/order/new |
order_new |
https://portal.bulkgate.com/api/1.0/eshop/order/change-status |
order_status_change_<order_status_id> |
https://portal.bulkgate.com/api/1.0/eshop/order/payment |
order_payment_complete, order_payment_confirmation |
https://portal.bulkgate.com/api/1.0/eshop/order/tracking-number |
order_tracking_number |
https://portal.bulkgate.com/api/1.0/eshop/order/product-cancel |
order_product_cancel |
https://portal.bulkgate.com/api/1.0/eshop/order/slip-add |
order_slip_add |
Si la requête n'atteint pas sa destination, renvoyez-la sur le serveur de secours backup1.bulkgate.com.
Méthodes HTTP prises en charge
POST-application/json
Nouvelle commande
eshop/order/new déclenche la notification de l'événement order_new. Envoyez-la au moment où le client finalise sa commande.
Changement de statut de la commande
eshop/order/change-status recherche la notification correspondant à un statut précis. Le nom de l'événement est composé de order_status_change_ et de la valeur de la variable order_status_id ; envoyez donc toujours order_status_id — sans elle, le portail n'associe la notification à aucun statut. Les statuts pour lesquels une notification peut être configurée sont envoyés par votre boutique via la configuration.
La requête ci-dessus utilise la notification configurée pour l'événement order_status_change_completed.
Paiement de la commande
eshop/order/payment recherche d'abord la notification order_payment_complete et, si elle n'est pas configurée, utilise order_payment_confirmation. Les notifications client et administrateur sont choisies séparément — le client peut ainsi recevoir order_payment_complete et les administrateurs order_payment_confirmation.
Numéro de suivi
eshop/order/tracking-number déclenche la notification order_tracking_number. Transmettez le numéro de suivi et le transporteur dans les variables, p. ex. order_carrier_tracking_number, order_carrier_name et order_carrier_url.
Annulation d'un produit et avoir
eshop/order/product-canceldéclenche la notificationorder_product_cancel— un produit a été annulé dans la commande.eshop/order/slip-adddéclenche la notificationorder_slip_add— un avoir a été émis pour la commande.
Réponse
La signification des clés customer et admin, les erreurs d'envoi et les types d'erreurs sont décrits dans la vue d'ensemble de l'E-shop API.
Merci pour votre retour.