DOCS

Orderstatus bijwerken

Orderstatus bijwerken

Leer hoe het endpoint voor het bijwerken van orderstatus werkt.

Het updateVendorOrderStatus-endpoint wordt gebruikt om de orderstatus van een order in het Zonos-systeem bij te werken. Dit wordt gebruikt om programmatisch de verzendstatus van de order bij te werken of een annulering aan te vragen.

Huidige orderstatuswaarden 

Hieronder staat een actuele lijst van orderstatussen die een order kan hebben.

Let op - Zonos kan op elk moment meer statussen toevoegen; uw systeem moet rekening houden met extra statussen.

De statussen in productie blijven in productie. Zonos verwijdert nooit bestaande statussen.

StatusDescriptionSettable by
IGLOBAL_FRAUD_REVIEWDe order wordt momenteel beoordeeld op fraude door iGlobal.Zonos
IGLOBAL_ORDER_IN_PROCESSDe order is geldig en klaar voor verwerking.Zonos
IGLOBAL_ORDER_ON_HOLDDe order heeft momenteel een tijdelijke statushold.Zonos
IGLOBAL_ORDER_CANCELLEDDe order is geannuleerd in het iGlobal-systeem.Zonos
VENDOR_PREPARING_ORDERDe vendor heeft de order gemarkeerd als in voorbereiding.Vendor
VENDOR_SHIPMENT_READYDe vendor heeft de order gemarkeerd als klaar voor verzending.Vendor
VENDOR_LABELS_PRINTED_DATEDe vendor heeft verzendlabels afgedrukt.Vendor
VENDOR_CANCELLATION_REQUESTEr is een annulering aangevraagd voor de order.Vendor
VENDOR_END_OF_DAY_COMPLETEDe order is afgerond en voltooid.Vendor

vendorOrderStatus kan niet door de vendor worden bijgewerkt terwijl de order in een van de volgende orderstatussen staat:

IGLOBAL_LABELS_PROCESSINGIGLOBAL_ORDER_ON_HOLDIGLOBAL_FRAUD_REVIEWIGLOBAL_ORDER_CANCELLEDVENDOR_CANCELLATION_REQUESTVENDOR_END_OF_DAY_COMPLETE

HTTPS-request

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

FieldValue
HTTP methodPOST
Endpoint URLhttps://api.iglobalstores.com/v1/updateVendorOrderStatus
ProtocolHTTPS
Message formatJSON
Accept HTTP headerAccept: application/json
Content-Type HTTP headerContent-Type: application/json

JSON key/value-pairs in de request body

Message format: JSON

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

Request JSON-definities

FieldNotes
orderId REQUIREDHet Zonos order-ID kan worden doorgegeven met of zonder uw store-ID en streepje (voorbeeld: 123-45678 of 45678). 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
orderStatus REQUIREDDit veld wordt gebruikt om het Zonos-systeem bij te werken met de nieuwe status van een order.De volgende orderstatussen kunnen via deze API worden ingesteld.- VENDOR_PREPARING_ORDER
  • VENDOR_SHIPMENT_READY
  • VENDOR_LABELS_PRINTED
  • VENDOR_END_OF_DAY_COMPLETE
  • VENDOR_CANCELLATION_REQUEST``string | | secret REQUIRED | API secret GUID verstrekt door Zonos.string | | store REQUIRED | Store-ID verstrekt door Zonosinteger |

HTTPS-response

Message format: JSON

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

Error HTTP-responses

HTTP Response CodesResponse Body Example/Description
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 required for updateVendorOrderStatus"
200"error":"Parameter orderStatus required for updateVendorOrderStatus."
200"error":"orderId: 999-99999 is not a valid orderId"
200"error":"Could not retrieve order to updateVendorOrderStatus from orderId: 999-99999"
200"error":"OrderId: 999-99999 has already been cancelled and status cannot be updated."
200"error":"Cannot update order status to status: VENDOR_CANCELLATION_REQUEST"
200"error":"Cannot update order status to invalid status: NEW_ORDER_STATUS"
200"error":"OrderId: 999-99999 already has current status: VENDOR_SHIPMENT_READY"
200"error":"OrderId: 999-99999 cannot be moved to order status: VENDOR_CANCELLATION_REQUEST while in status: VENDOR_END_OF_DAY_COMPLETE"
200"error":"New Status: NEW_ORDER_STATUS is not a valid order status"
200"error":"Could not process updateVendorOrderStatus."
200"error":"Invalid security credentials"

Response JSON-definities

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

Was deze pagina nuttig?