DOCS

Update order number

/

Bestellnummer aktualisieren

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

Der Endpunkt updateMerchantOrderId wird verwendet, um eine Bestellung im Zonos-System mit der Bestellnummer Ihres Geschäfts zu aktualisieren, um eine bessere Abstimmung, Kommunikation und Prüfung zu ermöglichen.

Endpunkt 

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

HTTPS-Anfrage

FeldHinweise
HTTP-MethodePOST
Endpunkt-URLhttps://api.iglobalstores.com/v1/updateMerchantOrderId
ProtokollHTTPS
NachrichtenformatJSON
Akzeptieren HTTP-HeaderAkzeptieren: application/json
Content-Type HTTP-HeaderContent-Type: application/json

JSON-Schlüssel/Wert-Paare im Anfragekörper

Beispiel

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

Anforderungs-JSON-Definitionen

FeldHinweise
merchantOrderId ERFORDERLICHDieser Parameter wird verwendet, um die interne Bestellnummer Ihres Geschäfts an die Bestellung im Zonos-System zu übergeben. Dies wird empfohlen für eine bessere Abstimmung, Kommunikation und Überprüfung. string
orderId ERFORDERLICHDie Zonos-Bestellnummer - kann mit oder ohne Ihre Geschäftsnummer und Bindestrich übergeben werden (Beispiel: 123-45678 oder 45678). Hinweis: Nach Abschluss der Bestellung und Zahlung wird der Kunde auf eine Bestellabschluss-/Dankesseite auf Ihrer Domain weitergeleitet. Die URL enthält einen Abfragezeichenparameter "orderId", der diesen Wert enthält. integer / string
secret ERFORDERLICHAPI-Geheimcode GUID bereitgestellt von Zonos. string
store ERFORDERLICHGeschäfts-ID bereitgestellt von Zonos. integer

HTTPS-Antwort

Beispiel einer erfolgreichen Antwort

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

Beispiel Fehlerantwort

1
2
3
{
  "error": "Could not retrieve order to updateMerchantOrderId for orderId: 99999"
}

HTTP-Fehlerantworten

FehlercodeDefinition
406 - Nicht akzeptabelHTML-Entity. Der HTTP-"Accept"-Header ist ungültig.
415 - Nicht unterstützter MedientypHTML-Entity. Der HTTP-"Content-Type"-Header ist ungültig.
200"error": "Eingabe konnte nicht geparst werden"
200"error": "Parameter orderId ist erforderlich, um updateMerchantOrderId zu verarbeiten"
200"error": "Parameter merchantOrderId ist erforderlich, um updateMerchantOrderId zu aktualisieren."
200"error": "orderId: 999-99999 ist keine gültige orderId"
200"error": "Konnte Bestellung nicht abrufen, um updateMerchantOrderId für orderId: 999-99999 durchzuführen"
200"error": "Konnte die Händlerbestellungs-ID nicht aktualisieren."
200"error": "Ungültige Sicherheitsanmeldeinformationen"

JSON-Antwortdefinitionen

NachrichtDefinition
errorDieser Parameter wird nur in der Antwort angezeigt, wenn ein Fehler aufgetreten ist, und enthält eine Beschreibung der Ursache. string
successDieser Parameter enthält eine Zusammenfassung des Updates. string

War diese Seite hilfreich?