Eindpunt
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
HTTPS-verzoek
| Veld | Opmerkingen |
|---|---|
| HTTP-methode | POST |
| Eindpunt-URL | https://api.iglobalstores.com/v1/updateMerchantOrderId |
| Protocol | HTTPS |
| Berichtformaat | JSON |
| Accept HTTP-header | Accept: application/json |
| Content-Type HTTP-header | Content-Type: application/json |
JSON sleutel/waarde paren in de aanvraagbody
Voorbeeld
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"orderId": "999-9999",
"merchantOrderId": "12-34567"
}
Verzoek JSON-definities
| Veld | Opmerkingen |
|---|---|
merchantOrderId VERPLICHT | Deze parameter wordt gebruikt om de interne order-ID van uw winkel door te geven aan de bestelling in het Zonos-systeem. Dit wordt aanbevolen voor betere reconciliatie, communicatie en auditing.string |
orderId VERPLICHT | De Zonos-order-ID - kan worden doorgegeven met of zonder uw winkel-ID en koppelteken (Voorbeeld: 123-45678 of 45678).Opmerking: Na voltooiing van de bestelling en betaling wordt de klant omgeleid naar een pagina voor Order Voltooiing / Bedankpagina voor de Bestelling die op uw domein is gehost. De URL bevat een querystringparameter “orderId” die deze waarde bevat.integer / string |
secret VERPLICHT | API geheime GUID verstrekt door Zonos.string |
store VERPLICHT | Winkel-ID verstrekt door Zonosinteger |
HTTPS-respons
Voorbeeld van een succesvolle respons
1
2
3
{
"success": "Updated Order: 99999 with new merchantOrderId: 12-34567"
}
Voorbeeld foutrespons
1
2
3
{
"error": "Could not retrieve order to updateMerchantOrderId for orderId: 99999"
}
Fout HTTP-antwoorden
| Foutcode | Definitie |
|---|---|
| 406 - Niet Acceptabel | HTML-entiteit. HTTP “Accept”-header is ongeldig. |
| 415 - Ongeldig mediatype | HTML-entiteit. HTTP “Content-Type”-header is ongeldig. |
| 200 | “error”:”kon invoer niet parseren” |
| 200 | “error”:”Parameter orderId is vereist om processUpdateMerchantOrderId uit te voeren” |
| 200 | “error”:”Parameter merchantOrderId is vereist om updateMerchantOrderId uit te voeren.” |
| 200 | “error”:”orderId: 999-99999 is geen geldige orderId” |
| 200 | “error”:”Kon bestelling niet ophalen om updateMerchantOrderId uit te voeren voor orderId: 999-99999” |
| 200 | “error”:”Kon update merchant order id niet verwerken.” |
| 200 | “error”:”Ongeldige beveiligingsreferenties” |
Reactie JSON-definities
| Bericht | Definitie |
|---|---|
error | Deze parameter zal alleen aanwezig zijn in de reactie wanneer er een fout is opgetreden en zal een beschrijving van de oorzaak bevatten.string |
success | Deze parameter zal een samenvatting van de update bevatten.string |
Bestelnummer bijwerken
Leer hoe het eindpunt voor het bijwerken van een bestelnummer werkt.
Het
updateMerchantOrderIdeindpunt wordt gebruikt om een bestelling in het Zonos systeem bij te werken met de bestel-id van uw winkel voor betere reconciliatie, communicatie en auditing.