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.
Het 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 REQUIRED
Dit 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-responsecodes↕
Voorbeeld/beschrijving van de response body↕
406 - Not Acceptable
HTML Entity. HTTP "Accept"-header is ongeldig.
415 - Unsupported media type
HTML 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
Bericht↕
Definitie↕
success
Deze parameter bevat een samenvatting van de update.string
error
Deze parameter is alleen aanwezig in de response wanneer een fout is opgetreden en bevat een beschrijving van de oorzaak.string
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.
HTTPS-request
POST |
https://api.iglobalstores.com/v1/updateVendorOrderStatushttps://api.iglobalstores.com/v1/updateVendorOrderStatusJSON key/value-pairs in de request body
Message format: JSON
{"store": "999","secret": "f5bde245-f55e-414d-b722-80b25161c12c","orderId": "999-9999","orderStatus": "VENDOR_END_OF_DAY_COMPLETE"}Request JSON-definities
orderIdREQUIREDorderIDmet deze waarde.integer / stringorderStatusREQUIREDVENDOR_PREPARING_ORDERVENDOR_SHIPMENT_READYVENDOR_LABELS_PRINTEDVENDOR_END_OF_DAY_COMPLETEVENDOR_CANCELLATION_REQUEST``string| |secretREQUIRED | API secret GUID verstrekt door Zonos.string| |storeREQUIRED | Store-ID verstrekt door Zonosinteger|HTTPS-response
Message format: JSON
{"success": "Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"}Error HTTP-responses
Response JSON-definities
successstringerrorstringWas deze pagina nuttig?