Endpoint
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
Requête HTTPS
| Champ | Remarques |
|---|---|
| Méthode HTTP | POST |
| URL de l'endpoint | https://api.iglobalstores.com/v1/updateMerchantOrderId |
| Protocole | HTTPS |
| Format du message | JSON |
| En-tête HTTP Accept | Accepter : application/json |
| En-tête HTTP Content-Type | Content-Type : application/json |
Paires clé/valeur JSON dans le corps de la requête
Exemple
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"orderId": "999-9999",
"merchantOrderId": "12-34567"
}
Définitions JSON de la requête
| Champ | Remarques |
|---|---|
merchantOrderId REQUIS | Ce paramètre est utilisé pour transmettre l'identifiant de commande interne de votre magasin au système de commande de Zonos. Cela est recommandé pour une meilleure conciliation, communication et audit. chaîne de caractères |
orderId REQUIS | L'identifiant de commande de Zonos - peut être transmis avec ou sans l'identifiant de votre magasin et le trait d'union (Exemple : 123-45678 ou 45678). Remarque : Après la finalisation de la commande et le paiement, le client sera redirigé vers une page de finalisation de commande / page de 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. entier / chaîne de caractères |
secret REQUIS | GUID secret de l'API fourni par Zonos. chaîne de caractères |
store REQUIS | Identifiant de magasin fourni par Zonos. entier |
Réponse HTTPS
Exemple de réponse réussie
1
2
3
{
"success": "Updated Order: 99999 with new merchantOrderId: 12-34567"
}
Exemple de réponse d'erreur
1
2
3
{
"error": "Could not retrieve order to updateMerchantOrderId for orderId: 99999"
}
Réponses d'erreur HTTP
| Code d'erreur | Définition |
|---|---|
| 406 - Non acceptable | Entité HTML. L'en-tête HTTP "Accept" est invalide. |
| 415 - Type de média non supporté | Entité HTML. L'en-tête HTTP "Content-Type" est invalide. |
| 200 | "error": "impossible d'analyser l'entrée" |
| 200 | "error": "Le paramètre orderId est requis pour traiter l'updateMerchantOrderId" |
| 200 | "error": "Le paramètre merchantOrderId est requis pour mettre à jour l'updateMerchantOrderId." |
| 200 | "error": "orderId: 999-99999 n'est pas un orderId valide" |
| 200 | "error": "Impossible de récupérer la commande pour mettre à jour l'updateMerchantOrderId pour orderId: 999-99999" |
| 200 | "error": "Impossible de traiter la mise à jour de l'identifiant de commande du marchand." |
| 200 | "error": "Informations d'identification de sécurité invalides" |
Définitions JSON de réponse
| Message | Définition |
|---|---|
error | Ce paramètre ne sera présent dans la réponse que lorsqu'une erreur s'est produite et contiendra une description de la cause. string |
success | Ce paramètre contiendra un résumé de la mise à jour. string |
Mettre à jour le numéro de commande
Découvrez comment fonctionne l'endpoint pour mettre à jour un numéro de commande.
L'endpoint
updateMerchantOrderIdest utilisé pour mettre à jour une commande dans le système Zonos avec l'identifiant de commande de votre magasin pour une meilleure réconciliation, communication et audit.