DOCS

Ordernummer bijwerken

Leer hoe het endpoint voor het bijwerken van een ordernummer werkt.

Het updateMerchantOrderId-endpoint wordt gebruikt om een order in het Zonos-systeem bij te werken met het order-ID van uw winkel voor betere reconciliatie, communicatie en auditing.

Endpoint 

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

HTTPS-request

VeldOpmerkingen
HTTP-methodePOST
Endpoint-URLhttps://api.iglobalstores.com/v1/updateMerchantOrderId
ProtocolHTTPS
BerichtformaatJSON
Accept HTTP-headerAccept: application/json
Content-Type HTTP-headerContent-Type: application/json

JSON key/value-pairs in de request body

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

Request JSON-definities

VeldOpmerkingen
merchantOrderId VEREISTDeze parameter wordt gebruikt om het interne order-ID van uw winkel door te geven aan de order in het Zonos-systeem. Dit wordt aanbevolen voor betere reconciliatie, communicatie en auditing.string
orderId VEREISTHet Zonos order-ID - kan worden doorgegeven met of zonder uw store-ID en streepje (voorbeeld: 123-45678 of 45678).Opmerking: Na orderafronding en betaling wordt de klant doorgestuurd naar een orderafrondings-/bedankpagina op uw domein. De URL bevat een querystringparameter "orderId" met deze waarde.integer / string
secret VEREISTAPI secret GUID verstrekt door Zonos.string
store VEREISTStore-ID verstrekt door Zonosinteger

HTTPS-response

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

Error HTTP-responses

FoutcodeDefinitie
406 - Not AcceptableHTML Entity. HTTP "Accept"-header is ongeldig.
415 - Unsupported media typeHTML Entity. HTTP "Content-Type"-header is ongeldig.
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"

Response JSON-definities

BerichtDefinitie
errorDeze parameter is alleen aanwezig in de response wanneer een fout is opgetreden en bevat een beschrijving van de oorzaak.string
successDeze parameter bevat een samenvatting van de update.string
Boek een demo

Was deze pagina nuttig?