DOCS

Oppdater ordrestatus

Lær hvordan endepunktet for å oppdatere ordrestatus fungerer.

Endepunktet updateVendorOrderStatus brukes til å oppdatere ordrestatus for en ordre i Zonos-systemet. Dette brukes til å programmatisk oppdatere ordrens fraktestatus eller be om en avbestilling.

Gjeldende ordrestatusverdier 

Nedenfor er en gjeldende liste over ordrestatusverdier som en ordre kan ha.

Forsiktig - Zonos kan legge til flere statuser når som helst; systemet ditt bør imøtekomme tilstedeværelsen av ytterligere statuser.

Statusene i produksjon vil forbli i produksjon. Zonos vil aldri fjerne eksisterende statuser.

Status↕Beskrivelse↕Kan angis av↕
IGLOBAL_FRAUD_REVIEWOrdren er for øyeblikket under svindelkontroll av iGlobal.Zonos
IGLOBAL_ORDER_IN_PROCESSOrdren er gyldig og klar for behandling.Zonos
IGLOBAL_ORDER_ON_HOLDOrdren er for øyeblikket på hold.Zonos
IGLOBAL_ORDER_CANCELLEDOrdren er blitt kansellert i iGlobal-systemet.Zonos
VENDOR_PREPARING_ORDERLeverandøren har merket ordren som under forberedelse.Leverandør
VENDOR_SHIPMENT_READYLeverandøren har merket ordren som klar for frakt.Leverandør
VENDOR_LABELS_PRINTED_DATELeverandøren har skrevet ut fraktetiketter.Leverandør
VENDOR_CANCELLATION_REQUESTOrdren har blitt bedt om avbestilling.Leverandør
VENDOR_END_OF_DAY_COMPLETEOrdren er ferdig og fullført.Leverandør

vendorOrderStatus kan ikke oppdateres av leverandøren mens ordren er i en av følgende ordrestatusverdier:

IGLOBAL_LABELS_PROCESSINGIGLOBAL_ORDER_ON_HOLDIGLOBAL_FRAUD_REVIEWIGLOBAL_ORDER_CANCELLEDVENDOR_CANCELLATION_REQUESTVENDOR_END_OF_DAY_COMPLETE

HTTPS-forespørsel

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

Felt↕Verdi↕
HTTP-metodePOST
Endepunkt-URLhttps://api.iglobalstores.com/v1/updateVendorOrderStatus
ProtokollHTTPS
MeldingsformatJSON
Accept HTTP-headerAccept: application/json
Content-Type HTTP-headerContent-Type: application/json

JSON nøkkel/verdi-par i forespørselsteksten

Meldingsformat: JSON

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

Definisjoner av forespørsel-JSON

Felt↕Merknader↕
orderId PÅKREVDZonos-ordre-ID-en kan sendes med eller uten butikk-ID-en og bindestrek (Eksempel: 123-45678 eller 45678).Etter at bestilling og betaling er fullført, blir kunden omdirigert til en bestillingsfullføring / takksikside som er vert på domenet ditt. URL-en vil inneholde en spørringsstrengparameter orderID som vil inneholde denne verdien.integer / string
orderStatus PÅKREVDDette feltet brukes til å oppdatere Zonos-systemet med den nye statusen for en ordre.Følgende ordrestatusverdier kan angis via denne API-en.- VENDOR_PREPARING_ORDER
  • VENDOR_SHIPMENT_READY
  • VENDOR_LABELS_PRINTED
  • VENDOR_END_OF_DAY_COMPLETE
  • VENDOR_CANCELLATION_REQUEST``string | | secret PÅKREVD | API-hemmelighet GUID gitt av Zonos.string | | store PÅKREVD | Butikk-ID gitt av Zonosinteger |

HTTPS-respons

Meldingsformat: JSON

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

Feil HTTP-responser

HTTP-responsekoder↕Eksempel på respons-tekst/Beskrivelse↕
406 - Not AcceptableHTML Entity. HTTP "Accept"-header er ugyldig.
415 - Unsupported media typeHTML Entity. HTTP "Content-Type"-header er ugyldig.
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"

Definisjoner av respons-JSON

Melding↕Definisjon↕
successDenne parameteren vil inneholde et sammendrag av oppdateringen.string
errorDenne parameteren vil bare være til stede i responsen når en feil har oppstått og vil inneholde en beskrivelse av årsaken.string
Bestill en demo

Var denne siden nyttig?