Aucun résultat

E-shop API – retours

Événements de retour : le client a créé un nouveau retour ou son statut a changé. Les paramètres de la requête, le choix de la notification et la forme de la réponse 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/return/new product_return
https://portal.bulkgate.com/api/1.0/eshop/return/change-status return_status_change_<return_status_id>
Note

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
POST /api/1.0/eshop/return/new HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json

Nouveau retour

eshop/return/new déclenche la notification de l'événement product_return. Transmettez les données du retour à l'aide des variables du groupe Retour, p. ex. return_id, return_reason ou return_products1.

POST /api/1.0/eshop/return/new HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "language": "fr", "variables": { "return_id": "77", "order_id": "10045", "return_reason": "Taille inadaptée", "customer_mobile": "777777777", "customer_country_id": "cz" } }

Changement de statut du retour

eshop/return/change-status recherche la notification correspondant à un statut précis. Le nom de l'événement est composé de return_status_change_ et de la valeur de la variable return_status_id ; envoyez donc toujours return_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.

POST /api/1.0/eshop/return/change-status HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "language": "fr", "variables": { "return_id": "77", "return_status_id": "3", "return_status": "Retour reçu", "customer_mobile": "777777777", "customer_country_id": "cz" } }

La requête ci-dessus utilise la notification configurée pour l'événement return_status_change_3.

Réponse

{ "data": { "customer": [ { "status": "accepted", "message_id": "tmpde1bcd4b1d1", "part_id": ["tmpde1bcd4b1d1"], "number": "420777777777", "channel": "sms" } ] } }

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.

Cette page vous a-t-elle été utile ?