Uppdatera beställningsstatus

Lär dig hur slutpunkten för att uppdatera beställningsstatus fungerar.

Den updateVendorOrderStatus slutpunkten används för att uppdatera beställningsstatusen för en beställning inom Zonos Systemet. Detta kommer att användas för att programmässigt uppdatera beställningens fraktstatus eller för att begära en avbokning.

Aktuella beställningsstatusvärden

Nedan finns en aktuell lista över beställningsstatusar som en beställning kan ha.

Varning - Zonos kan lägga till fler statusar när som helst; ditt system bör kunna hantera förekomsten av ytterligare statusar.

Statusarna i produktion kommer att förbli i produktion. Zonos kommer aldrig att ta bort befintliga statusar.

Status	Beskrivning	Kan ställas in av
IGLOBAL_FRAUD_REVIEW	Beställningen är för närvarande under bedömning för bedrägeri av iGlobal.	Zonos
IGLOBAL_ORDER_IN_PROCESS	Beställningen är giltig och redo för behandling.	Zonos
IGLOBAL_ORDER_ON_HOLD	Beställningen är för närvarande på en tillfällig statushållning.	Zonos
IGLOBAL_ORDER_CANCELLED	Beställningen har avbrutits i iGlobal Systemet.	Zonos
VENDOR_PREPARING_ORDER	Leverantören har markerat beställningen som under förberedelse.	Leverantör
VENDOR_SHIPMENT_READY	Leverantören har markerat beställningen som redo för frakt.	Leverantör
VENDOR_LABELS_PRINTED_DATE	Leverantören har skrivit ut fraktetiketter.	Leverantör
VENDOR_CANCELLATION_REQUEST	Beställningen har begärts för avbokning.	Leverantör
VENDOR_END_OF_DAY_COMPLETE	Beställningen är slutförd och komplett.	Leverantör

vendorOrderStatus kan inte uppdateras av leverantören medan beställningen är i en av följande beställningsstatusar:

IGLOBAL_LABELS_PROCESSINGIGLOBAL_ORDER_ON_HOLDIGLOBAL_FRAUD_REVIEWIGLOBAL_ORDER_CANCELLEDVENDOR_CANCELLATION_REQUESTVENDOR_END_OF_DAY_COMPLETE

HTTPS-förfrågan

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
Accept HTTP-header	Accept: application/json
Content-Type HTTP-header	Content-Type: application/json

JSON nyckel/värde-par i begärans kropp

Meddelandeformat: JSON

EXEMPEL

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

Begäran JSON-definitioner

Fält	Anteckningar
`orderId` KRÄVS	Zonos beställnings-ID kan skickas med eller utan din butik-ID och bindestreck (Exempel: 123-45678 eller 45678). Efter slutförande av beställningen och betalningen kommer kunden att omdirigeras till en beställningsslutförande / tack-sida som är värd på din domän. URL:en kommer att innehålla en querystring-parameter `orderID` som kommer att innehålla detta värde.`integer / string`
`orderStatus` KRÄVS	Detta fält används för att uppdatera Zonos systemet med den nya statusen för en beställning. Följande beställningsstatusar kan ställas in via detta API.- `VENDOR_PREPARING_ORDER`

VENDOR_SHIPMENT_READY
VENDOR_LABELS_PRINTED
VENDOR_END_OF_DAY_COMPLETE
VENDOR_CANCELLATION_REQUEST``string | | secret KRÄVS | API-hemlig GUID som tillhandahålls av Zonos.string | | store KRÄVS | Butik-ID som tillhandahålls av Zonosinteger |

HTTPS-svar

Meddelandets format: JSON

Exempel på framgångssvar

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

Exempel på felrespons

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

HTTP-felmeddelanden

HTTP-svarskoder	Exempel på svarskropp/Beskrivning
406 - Inte acceptabel	HTML-enhet. HTTP "Accept"-huvudet är ogiltigt.
415 - Ogiltig mediatyp	HTML-enhet. HTTP "Content-Type"-huvudet är ogiltigt.
200	“error”:“kunde inte analysera indata”
200	“error”:“Parameter orderId krävs för updateVendorOrderStatus”
200	“error”:“Parameter orderStatus krävs för updateVendorOrderStatus.”
200	“error”:“orderId: 999-99999 är inte ett giltigt orderId”
200	“error”:“Kunde inte hämta order för updateVendorOrderStatus från orderId: 999-99999”
200	“error”:“OrderId: 999-99999 har redan avbrutits och status kan inte uppdateras.”
200	“error”:“Kan inte uppdatera orderstatus till status: VENDOR_CANCELLATION_REQUEST”
200	“error”:“Kan inte uppdatera orderstatus till ogiltig status: NEW_ORDER_STATUS”
200	“error”:“OrderId: 999-99999 har redan nuvarande status: VENDOR_SHIPMENT_READY”
200	“error”:“OrderId: 999-99999 kan inte flyttas till orderstatus: VENDOR_CANCELLATION_REQUEST medan den är i status: VENDOR_END_OF_DAY_COMPLETE”
200	“error”:“Ny status: NEW_ORDER_STATUS är inte en giltig orderstatus”
200	“error”:“Kunde inte bearbeta updateVendorOrderStatus.”
200	“error”:“Ogiltiga säkerhetsuppgifter”

Svars-JOSN-definitioner

Meddelande	Definition
`success`	Denna parameter kommer att innehålla en sammanfattning av uppdateringen.`string`
`error`	Denna parameter kommer endast att finnas i svaret när ett fel har inträffat och kommer att innehålla en beskrivning av orsaken.`string`

Var den här sidan hjälpsam?

Frågor?

Kontakta oss.

Se Zonos

policyer och avtal