Vad är syftet med API-slutpunkten updateVendorOrderStatus?

Den här API-slutpunkten används för att uppdatera en orders status i Zonos System. Den används för att programmatiskt uppdatera orderns leveransstatus eller begära en annullering.

Vilka är de aktuella orderstatusvärdena?

De aktuella orderstatusvärdena omfattar IGLOBAL_FRAUD_REVIEW, IGLOBAL_ORDER_IN_PROCESS, IGLOBAL_ORDER_ON_HOLD, IGLOBAL_ORDER_CANCELLED, VENDOR_PREPARING_ORDER, VENDOR_SHIPMENT_READY, VENDOR_LABELS_PRINTED_DATE, VENDOR_CANCELLATION_REQUEST och VENDOR_END_OF_DAY_COMPLETE.

Vilket format har HTTPS-begäran för API-slutpunkten updateVendorOrderStatus?

HTTPS-begäran omfattar HTTP-metod, slutpunkts-URL, protokoll, meddelandeformat, HTTP-huvudet Accept och HTTP-huvudet Content-Type. JSON-nyckel/värde-paren i begärandetexten omfattar orderId, orderStatus, secret och store.

Vilka HTTP-felsvar är möjliga?

Möjliga HTTP-felsvar omfattar 406 - Not Acceptable, 415 - Unsupported media type och olika 200-svar med olika felmeddelanden.

Checkout•

HemAPI-referens Checkout REST API Uppdatera orderstatus

Uppdatera orderstatus

Lär er hur slutpunkten för uppdatering av orderstatus fungerar.

Slutpunkten updateVendorOrderStatus används för att uppdatera orderstatusen för en order i Zonos System. Den kan användas för att programmatiskt uppdatera orderns leveransstatus eller begära en annullering.

Aktuella orderstatusvärden

Nedan finns en aktuell lista över de orderstatusar en order kan ha.

Varning – Zonos kan när som helst lägga till fler statusar. Ert system bör kunna hantera ytterligare statusar.

Statusar i produktion förblir i produktion. Zonos tar aldrig bort befintliga statusar.

Status↕	Beskrivning↕	Kan anges av↕
IGLOBAL_FRAUD_REVIEW	Ordern granskas för närvarande för bedrägeri av iGlobal.	Zonos
IGLOBAL_ORDER_IN_PROCESS	Ordern är giltig och klar för behandling.	Zonos
IGLOBAL_ORDER_ON_HOLD	Ordern har för närvarande en tillfällig statusspärr.	Zonos
IGLOBAL_ORDER_CANCELLED	Ordern har annullerats i iGlobal System.	Zonos
VENDOR_PREPARING_ORDER	Leverantören har markerat ordern som under förberedelse.	Leverantör
VENDOR_SHIPMENT_READY	Leverantören har markerat ordern som klar för leverans.	Leverantör
VENDOR_LABELS_PRINTED_DATE	Leverantören har skrivit ut fraktetiketter.	Leverantör
VENDOR_CANCELLATION_REQUEST	En annullering av ordern har begärts.	Leverantör
VENDOR_END_OF_DAY_COMPLETE	Ordern är slutförd och färdig.	Leverantör

vendorOrderStatus kan inte uppdateras av leverantören medan ordern har någon av följande orderstatusar:

IGLOBAL_LABELS_PROCESSINGIGLOBAL_ORDER_ON_HOLDIGLOBAL_FRAUD_REVIEWIGLOBAL_ORDER_CANCELLEDVENDOR_CANCELLATION_REQUESTVENDOR_END_OF_DAY_COMPLETE

HTTPS-begäran

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

Fält↕	Värde↕
HTTP-metod	POST
Slutpunkts-URL	`https://api.iglobalstores.com/v1/updateVendorOrderStatus`
Protokoll	HTTPS
Meddelandeformat	JSON
HTTP-huvud Accept	Accept: application/json
HTTP-huvud Content-Type	Content-Type: application/json

JSON-nyckel/värde-par i begärandetexten

Meddelandeformat: JSON

1{

2 "store": "999",

3 "secret": "f5bde245-f55e-414d-b722-80b25161c12c",

4 "orderId": "999-9999",

5 "orderStatus": "VENDOR_END_OF_DAY_COMPLETE"

6}

Definitioner för JSON-begäran

Fält↕	Anmärkningar↕
`orderId` OBLIGATORISKT	Zonos-order-ID:t kan skickas med eller utan ert butiks-ID och bindestreck (exempel: 123-45678 eller 45678). Efter orderns slutförande och betalning omdirigeras kunden till en orderbekräftelse-/tacksida på er domän. URL:en innehåller frågesträngsparametern `orderID` med detta värde.`integer / string`
`orderStatus` OBLIGATORISKT	Det här fältet används för att uppdatera Zonos-systemet med en orders nya status. Följande orderstatusar kan anges via detta API: `VENDOR_PREPARING_ORDER`

VENDOR_SHIPMENT_READY
VENDOR_LABELS_PRINTED
VENDOR_END_OF_DAY_COMPLETE
VENDOR_CANCELLATION_REQUEST``string | | secret OBLIGATORISKT | API-hemlighetens GUID tillhandahålls av Zonos.string | | store OBLIGATORISKT | Butiks-ID tillhandahålls av Zonos.integer |

HTTPS-svar

Meddelandeformat: JSON

1{

2 "success": "Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"

3}

HTTP-felsvar

HTTP-svarskoder↕	Exempel/beskrivning av svarstext↕
406 - Not Acceptable	HTML-entitet. HTTP-huvudet ”Accept” är ogiltigt.
415 - Unsupported media type	HTML-entitet. HTTP-huvudet ”Content-Type” är ogiltigt.
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”

Definitioner för JSON-svar

Meddelande↕	Definition↕
`success`	Den här parametern innehåller en sammanfattning av uppdateringen.`string`
`error`	Den här parametern finns endast i svaret när ett fel har uppstått och innehåller en beskrivning av orsaken.`string`

Boka en demo