Oppdater bestillingsstatus

Lær hvordan endepunktet for oppdatering av bestillingsstatus fungerer.

updateVendorOrderStatus endepunktet brukes til å oppdatere bestillingsstatusen til en bestilling inne i Zonos Systemet. Dette vil bli brukt til å programmatisk oppdatere bestillingens fraktstatus eller for å be om en avbestilling.

Nåværende bestillingsstatusverdier

Nedenfor er en nåværende liste over bestillingsstatusene som en bestilling kan ha.

Forsiktig - Zonos kan legge til flere statusser når som helst; systemet ditt bør kunne håndtere tilstedeværelsen av ekstra statusser.

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

Status	Beskrivelse	Kan settes av
IGLOBAL_FRAUD_REVIEW	Bestillingen er for øyeblikket under svindelgjennomgang av iGlobal.	Zonos
IGLOBAL_ORDER_IN_PROCESS	Bestillingen er gyldig og klar for behandling.	Zonos
IGLOBAL_ORDER_ON_HOLD	Bestillingen er for øyeblikket på en midlertidig status hold.	Zonos
IGLOBAL_ORDER_CANCELLED	Bestillingen har blitt avbestilt i iGlobal Systemet.	Zonos
VENDOR_PREPARING_ORDER	Leverandøren har merket bestillingen som under forberedelse.	Leverandør
VENDOR_SHIPMENT_READY	Leverandøren har merket bestillingen klar for frakt.	Leverandør
VENDOR_LABELS_PRINTED_DATE	Leverandøren har skrevet ut fraktetiketter.	Leverandør
VENDOR_CANCELLATION_REQUEST	Bestillingen har blitt bedt om avbestilling.	Leverandør
VENDOR_END_OF_DAY_COMPLETE	Bestillingen er ferdigstilt og komplett.	Leverandør

vendorOrderStatus kan ikke oppdateres av leverandøren mens bestillingen er i en av følgende bestillingsstatusser:

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-metode	POST
Endepunkt-URL	`https://api.iglobalstores.com/v1/updateVendorOrderStatus`
Protokoll	HTTPS
Meldingsformat	JSON
Accept HTTP-header	Accept: application/json
Content-Type HTTP-header	Content-Type: application/json

JSON nøkkel/verdi-par i forespørselens kropp

Meldingsformat: JSON

EKSEMPEL

{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "orderId": "999-9999",
  "orderStatus": "VENDOR_END_OF_DAY_COMPLETE"
}

Forespørsel JSON-definisjoner

Felt	Notater
`orderId` PÅKREVES	Zonos bestillings-ID kan sendes med eller uten butikk-ID og bindestrek (Eksempel: 123-45678 eller 45678). Etter fullføring av bestillingen og betaling, vil kunden bli omdirigert til en side for fullføring av bestilling / takk for bestilling som er vert på ditt domene. URL-en vil inneholde en spørringsparameter `orderID` som vil inneholde denne verdien.`integer / string`
`orderStatus` PÅKREVES	Dette feltet brukes til å oppdatere Zonos systemet med den nye statusen til en bestilling. Følgende bestillingsstatusser kan settes via dette API-et.- `VENDOR_PREPARING_ORDER`

VENDOR_SHIPMENT_READY
VENDOR_LABELS_PRINTED
VENDOR_END_OF_DAY_COMPLETE
VENDOR_CANCELLATION_REQUEST``string | | secret PÅKREVES | API-hemmelig GUID gitt av Zonos.string | | store PÅKREVES | Butikk-ID gitt av Zonosinteger |

HTTPS-svar

Meldingsformat: JSON

Eksempel på vellykket svar

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

Eksempel på feilmelding

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

HTTP-feilrespons

HTTP-responskoder	Eksempel/Beskrivelse av responskropp
406 - Ikke akseptabel	HTML-enhet. HTTP "Accept"-header er ugyldig.
415 - Ugyldig mediatype	HTML-enhet. HTTP "Content-Type"-header er ugyldig.
200	“error”:“kunne ikke analysere input”
200	“error”:“Parameter orderId kreves for updateVendorOrderStatus”
200	“error”:“Parameter orderStatus kreves for updateVendorOrderStatus.”
200	“error”:“orderId: 999-99999 er ikke en gyldig orderId”
200	“error”:“Kunne ikke hente ordre for updateVendorOrderStatus fra orderId: 999-99999”
200	“error”:“OrderId: 999-99999 har allerede blitt kansellert og status kan ikke oppdateres.”
200	“error”:“Kan ikke oppdatere ordrestatus til status: VENDOR_CANCELLATION_REQUEST”
200	“error”:“Kan ikke oppdatere ordrestatus til ugyldig status: NEW_ORDER_STATUS”
200	“error”:“OrderId: 999-99999 har allerede nåværende status: VENDOR_SHIPMENT_READY”
200	“error”:“OrderId: 999-99999 kan ikke flyttes til ordrestatus: VENDOR_CANCELLATION_REQUEST mens den er i status: VENDOR_END_OF_DAY_COMPLETE”
200	“error”:“Ny status: NEW_ORDER_STATUS er ikke en gyldig ordrestatus”
200	“error”:“Kunne ikke behandle updateVendorOrderStatus.”
200	“error”:“Ugyldige sikkerhetslegitimasjoner”

Respons JSON-definisjoner

Melding	Definisjon
`success`	Denne parameteren vil inneholde et sammendrag av oppdateringen.`string`
`error`	Denne parameteren vil kun være til stede i responsen når det har oppstått en feil og vil inneholde en beskrivelse av årsaken.`string`

Var denne siden nyttig?

Spørsmål?

Kontakt oss.

Se Zonos

retningslinjer og avtaler