DOCS

Bestellnummer aktualisieren

Erfahren Sie, wie der Endpunkt zur Aktualisierung einer Bestellnummer funktioniert.

Der updateMerchantOrderId-Endpunkt wird verwendet, um eine Bestellung im Zonos-System mit der Bestell-ID Ihres Shops zu aktualisieren – für bessere Abstimmung, Kommunikation und Prüfung.

Endpunkt 

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

HTTPS-Anfrage

Feld↕Hinweise↕
HTTP-MethodePOST
Endpunkt-URLhttps://api.iglobalstores.com/v1/updateMerchantOrderId
ProtokollHTTPS
NachrichtenformatJSON
Accept-HTTP-HeaderAccept: application/json
Content-Type-HTTP-HeaderContent-Type: application/json

JSON-Schlüssel/Wert-Paare im Anfrage-Body

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

Definitionen der Anfrage-JSON

Feld↕Hinweise↕
merchantOrderId REQUIREDDieser Parameter wird verwendet, um die interne Bestell-ID Ihres Shops an die Bestellung im Zonos-System zu übergeben. Dies wird für eine bessere Abstimmung, Kommunikation und Prüfung empfohlen.string
orderId REQUIREDDie Zonos-Bestell-ID – kann mit oder ohne Ihre Shop-ID und den Bindestrich übergeben werden (Beispiel: 123-45678 oder 45678).Hinweis: Nach Abschluss der Bestellung und Zahlung wird der Kunde auf eine Bestellabschluss-/Dankeseite auf Ihrer Domain weitergeleitet. Die URL enthält einen Query-String-Parameter „orderId“, der diesen Wert enthält.integer / string
secret REQUIREDVon Zonos bereitgestellte API-Secret-GUID.string
store REQUIREDVon Zonos bereitgestellte Shop-IDinteger

HTTPS-Antwort

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

Fehlerhafte HTTP-Antworten

Fehlercode↕Bedeutung↕
406 - Not AcceptableHTML-Entität. HTTP-„Accept“-Header ist ungültig.
415 - Unsupported media typeHTML-Entität. HTTP-„Content-Type“-Header ist ungültig.
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“

Definitionen der Antwort-JSON

Feld↕Hinweise↕
errorDieser Parameter ist nur in der Antwort vorhanden, wenn ein Fehler aufgetreten ist, und enthält eine Beschreibung der Ursache.string
successDieser Parameter enthält eine Zusammenfassung der Aktualisierung.string

War diese Seite hilfreich?