DOCS

Mettre à jour le numéro de commande

Découvrez le fonctionnement du point de terminaison de mise à jour du numéro de commande.

Le point de terminaison updateMerchantOrderId met à jour une commande dans le système Zonos avec l'ID de commande de votre boutique pour un meilleur rapprochement, communication et audit.

Point de terminaison 

POST | https://api.iglobalstores.com/v1/updateMerchantOrderId

Requête HTTPS

Champ↕Notes↕
Méthode HTTPPOST
URL du point de terminaisonhttps://api.iglobalstores.com/v1/updateMerchantOrderId
ProtocoleHTTPS
Format du messageJSON
En-tête HTTP AcceptAccept: application/json
En-tête HTTP Content-TypeContent-Type: application/json

Paires clé/valeur JSON dans le corps de la requête

1{
2 "store": "999",
3 "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
4 "orderId": "999-9999",
5 "merchantOrderId": "12-34567"
6}

Définitions JSON de la requête

Champ↕Notes↕
merchantOrderId REQUIREDCe paramètre sert à transmettre l'ID de commande interne de votre boutique à la commande dans le système Zonos. Recommandé pour un meilleur rapprochement, communication et audit.string
orderId REQUIREDL'ID de commande Zonos — peut être transmis avec ou sans l'ID de votre boutique et le tiret (exemple : 123-45678 ou 45678).Note : Après la finalisation de la commande et le paiement, le client sera redirigé vers une page de finalisation / remerciement de commande hébergée sur votre domaine. L'URL contiendra un paramètre de chaîne de requête « orderId » qui contiendra cette valeur.integer / string
secret REQUIREDGUID secret API fourni par Zonos.string
store REQUIREDID de boutique fourni par Zonosinteger

Réponse HTTPS

1{
2 "success": "Updated Order: 99999 with new merchantOrderId: 12-34567"
3}

Réponses HTTP d'erreur

Code d'erreur↕Définition↕
406 - Not AcceptableEntité HTML. L'en-tête HTTP « Accept » est invalide.
415 - Unsupported media typeEntité HTML. L'en-tête HTTP « Content-Type » est invalide.
200« error »:« could not parse input »
200« error »:« Parameter orderId is required to processUpdateMerchantOrderId »
200« error »:« Parameter merchantOrderId is required to updateMerchantOrderId. »
200« error »:« orderId: 999-99999 is not a valid orderId »
200« error »:« Could not retrieve order to updateMerchantOrderId for orderId: 999-99999 »
200« error »:« Could not process update merchant order id. »
200« error »:« Invalid security credentials »

Définitions JSON de la réponse

Message↕Définition↕
errorCe paramètre ne sera présent dans la réponse qu'en cas d'erreur et contiendra une description de la cause.string
successCe paramètre contiendra un résumé de la mise à jour.string
Réserver une démo

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