DOCS

Update order status

/

Bestellstatus aktualisieren

Erfahren Sie, wie der Endpunkt zum Aktualisieren des Bestellstatus funktioniert.

Der Endpunkt updateVendorOrderStatus wird verwendet, um den Bestellstatus einer Bestellung im Zonos System zu aktualisieren. Dies wird verwendet, um den Versandstatus der Bestellung programmgesteuert zu aktualisieren oder eine Stornierung anzufordern.

Aktuelle Bestellstatuswerte 

Hier ist eine aktuelle Liste von Bestellstatus, die eine Bestellung haben kann.

Vorsicht - Zonos kann jederzeit weitere Status hinzufügen; Ihr System sollte auf zusätzliche Status vorbereitet sein.

Die Status in der Produktion bleiben in der Produktion. Zonos wird bestehende Status niemals entfernen.

StatusBeschreibungSetzbar von
IGLOBAL_FRAUD_REVIEWDie Bestellung wird derzeit von iGlobal auf Betrugsüberprüfung überprüft.Zonos
IGLOBAL_ORDER_IN_PROCESSDie Bestellung ist gültig und bereit zur Bearbeitung.Zonos
IGLOBAL_ORDER_ON_HOLDDie Bestellung befindet sich derzeit in einem vorübergehenden Status.Zonos
IGLOBAL_ORDER_CANCELLEDDie Bestellung wurde im iGlobal System storniert.Zonos
VENDOR_PREPARING_ORDERDer Lieferant hat die Bestellung zur Vorbereitung markiert.Lieferant
VENDOR_SHIPMENT_READYDer Lieferant hat die Bestellung als versandbereit markiert.Lieferant
VENDOR_LABELS_PRINTED_DATEDer Lieferant hat Versandetiketten gedruckt.Lieferant
VENDOR_CANCELLATION_REQUESTDie Bestellung wurde zur Stornierung angefordert.Lieferant
VENDOR_END_OF_DAY_COMPLETEDie Bestellung ist abgeschlossen und vollständig.Lieferant

vendorOrderStatus kann vom Lieferanten nicht aktualisiert werden, solange die Bestellung einen der folgenden Bestellstatus hat:

IGLOBAL_LABELS_PROCESSINGIGLOBAL_ORDER_ON_HOLDIGLOBAL_FRAUD_REVIEWIGLOBAL_ORDER_CANCELLEDVENDOR_CANCELLATION_REQUESTVENDOR_END_OF_DAY_COMPLETE

HTTPS-Anfrage

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

FeldWert
HTTP-MethodePOST
Endpunkt-URLhttps://api.iglobalstores.com/v1/updateVendorOrderStatus
ProtokollHTTPS
NachrichtenformatJSON
Akzeptieren HTTP-HeaderAkzeptieren: application/json
Inhaltstyp-HTTP-HeaderInhaltstyp: application/json

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

Nachrichtenformat: JSON

BEISPIEL

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

Anforderungs-JSON-Definitionen

FeldHinweise
orderId ERFORDERLICHDie Zonos Bestell-ID kann mit oder ohne Ihre Geschäfts-ID und Bindestrich übergeben werden (Beispiel: 123-45678 oder 45678). Nach Abschluss der Bestellung und Zahlung wird der Kunde auf eine Bestellabschluss-/Dankeseite auf Ihrer Domain weitergeleitet. Die URL enthält einen Abfragezeichenparameter orderID, der diesen Wert enthält. integer / string
orderStatus ERFORDERLICHDieses Feld wird verwendet, um das Zonos-System mit dem neuen Status einer Bestellung zu aktualisieren. Die folgenden Bestellstatus können über diese API gesetzt werden.- VENDOR_PREPARING_ORDER
  • VENDOR_SHIPMENT_READY
  • VENDOR_LABELS_PRINTED
  • VENDOR_END_OF_DAY_COMPLETE
  • VENDOR_CANCELLATION_REQUEST``string | | secret ERFORDERLICH | API-Geheimcode GUID bereitgestellt von Zonos.string | | store ERFORDERLICH | Geschäfts-ID bereitgestellt von Zonosinteger |

HTTPS-Antwort

Nachrichtenformat: JSON

Beispiel für erfolgreiche Antwort

1
2
3
{
  "success": "Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"
}

Beispiel Fehlerantwort

1
2
3
{
  "error": "OrderId: 99999 cannot be moved to order status: VENDOR_PREPARING_ORDER while in status: IGLOBAL_FRAUD_REVIEW"
}

HTTP-Fehlerantworten

HTTP-AntwortcodesBeispiel/Beschreibung des Antwortkörpers
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 erforderlich für updateVendorOrderStatus"
200"error": "Parameter orderStatus erforderlich für updateVendorOrderStatus."
200"error": "orderId: 999-99999 ist keine gültige orderId"
200"error": "Bestellung konnte nicht abgerufen werden, um updateVendorOrderStatus von orderId: 999-99999 durchzuführen"
200"error": "OrderId: 999-99999 wurde bereits storniert und der Status kann nicht aktualisiert werden."
200"error": "Bestellstatus kann nicht auf Status: VENDOR_CANCELLATION_REQUEST aktualisiert werden"
200"error": "Bestellstatus kann nicht auf ungültigen Status: NEW_ORDER_STATUS aktualisiert werden"
200"error": "OrderId: 999-99999 hat bereits den aktuellen Status: VENDOR_SHIPMENT_READY"
200"error": "OrderId: 999-99999 kann nicht in den Bestellstatus: VENDOR_CANCELLATION_REQUEST verschoben werden, während er sich im Status: VENDOR_END_OF_DAY_COMPLETE befindet"
200"error": "Neuer Status: NEW_ORDER_STATUS ist kein gültiger Bestellstatus"
200"error": "updateVendorOrderStatus konnte nicht verarbeitet werden."
200"error": "Ungültige Sicherheitsanmeldeinformationen"

Definitionen der JSON-Antworten

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

War diese Seite hilfreich?