Endpunkt
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
HTTPS-Anfrage
| Feld | Hinweise |
|---|---|
| HTTP-Methode | POST |
| Endpunkt-URL | https://api.iglobalstores.com/v1/updateMerchantOrderId |
| Protokoll | HTTPS |
| Nachrichtenformat | JSON |
| Akzeptieren HTTP-Header | Akzeptieren: application/json |
| Content-Type HTTP-Header | Content-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
| Feld | Hinweise |
|---|---|
merchantOrderId ERFORDERLICH | Dieser 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 ERFORDERLICH | Die 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 ERFORDERLICH | API-Geheimcode GUID bereitgestellt von Zonos. string |
store ERFORDERLICH | Geschä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
| Fehlercode | Definition |
|---|---|
| 406 - Nicht akzeptabel | HTML-Entity. Der HTTP-"Accept"-Header ist ungültig. |
| 415 - Nicht unterstützter Medientyp | HTML-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
| Nachricht | Definition |
|---|---|
error | Dieser Parameter wird nur in der Antwort angezeigt, wenn ein Fehler aufgetreten ist, und enthält eine Beschreibung der Ursache. string |
| success | Dieser Parameter enthält eine Zusammenfassung des Updates. string |
Bestellnummer aktualisieren
Erfahren Sie, wie der Endpunkt zur Aktualisierung einer Bestellnummer funktioniert.
Der Endpunkt
updateMerchantOrderIdwird 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.