DOCS

Update order status

/

Opdater ordrestatus

Lær hvordan endepunktet til opdatering af ordrestatus fungerer.

updateVendorOrderStatus endepunktet bruges til at opdatere ordrestatus for en ordre inden for Zonos Systemet. Dette vil blive brugt til programmatisk at opdatere ordres forsendelsesstatus eller til at anmode om en annullering.

Nuværende ordrestatus værdier 

Nedenfor er en aktuel liste over ordrestatusser, som en ordre kan have.

Advarsel - Zonos kan tilføje flere statusser når som helst; dit system bør kunne rumme tilstedeværelsen af yderligere statusser.

Statusserne i produktion vil forblive i produktion. Zonos vil aldrig fjerne eksisterende statusser.

StatusBeskrivelseKan sættes af
IGLOBAL_FRAUD_REVIEWOrdren er i øjeblikket under svindelgennemgang af iGlobal.Zonos
IGLOBAL_ORDER_IN_PROCESSOrdren er gyldig og klar til behandling.Zonos
IGLOBAL_ORDER_ON_HOLDOrdren er i øjeblikket på en midlertidig statushold.Zonos
IGLOBAL_ORDER_CANCELLEDOrdren er blevet annulleret i iGlobal Systemet.Zonos
VENDOR_PREPARING_ORDERLeverandøren har markeret ordren som under forberedelse.Leverandør
VENDOR_SHIPMENT_READYLeverandøren har markeret ordren som klar til forsendelse.Leverandør
VENDOR_LABELS_PRINTED_DATELeverandøren har printet forsendelseslabels.Leverandør
VENDOR_CANCELLATION_REQUESTOrdren er blevet anmodet om annullering.Leverandør
VENDOR_END_OF_DAY_COMPLETEOrdren er afsluttet og komplet.Leverandør

vendorOrderStatus kan ikke opdateres af leverandøren, mens ordren er i en af følgende ordrestatusser:

IGLOBAL_LABELS_PROCESSINGIGLOBAL_ORDER_ON_HOLDIGLOBAL_FRAUD_REVIEWIGLOBAL_ORDER_CANCELLEDVENDOR_CANCELLATION_REQUESTVENDOR_END_OF_DAY_COMPLETE

HTTPS anmodning

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

FeltVærdi
HTTP metodePOST
Endepunkt URLhttps://api.iglobalstores.com/v1/updateVendorOrderStatus
ProtokolHTTPS
BeskedformatJSON
Accept HTTP headerAccept: application/json
Content-Type HTTP headerContent-Type: application/json

JSON nøgle/værdi par i anmodningskroppen

Beskedformat: JSON

EKSEMPEL

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

Anmodning JSON definitioner

FeltNoter
orderId PÅKRÆVETID'en for Zonos ordren kan sendes med eller uden din butik ID og bindestreg (Eksempel: 123-45678 eller 45678). Efter ordreafgivelse og betaling vil kunden blive omdirigeret til en ordreafslutnings-/ordretakkside, der er hostet på dit domæne. URL'en vil indeholde en forespørgselsparameter orderID, der vil indeholde denne værdi.integer / string
orderStatus PÅKRÆVETDette felt bruges til at opdatere Zonos systemet med den nye status for en ordre. Følgende ordrestatusser kan indstilles via denne API.- VENDOR_PREPARING_ORDER
  • VENDOR_SHIPMENT_READY
  • VENDOR_LABELS_PRINTED
  • VENDOR_END_OF_DAY_COMPLETE
  • VENDOR_CANCELLATION_REQUEST``string | | secret PÅKRÆVET | API hemmelig GUID leveret af Zonos.string | | store PÅKRÆVET | Butik ID leveret af Zonosinteger |

HTTPS svar

Beskedformat: JSON

Eksempel på succes svar

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

Eksempel på fejlrespons

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

HTTP fejlmeddelelser

HTTP svarkoderEksempel på svarindhold/beskrivelse
406 - Ikke acceptabelHTML-enhed. HTTP "Accept"-header er ugyldig.
415 - Ustøttet medietypeHTML-enhed. HTTP "Content-Type"-header er ugyldig.
200“error”:“kunne ikke analysere input”
200“error”:“Parameter orderId kræves for updateVendorOrderStatus”
200“error”:“Parameter orderStatus kræves for updateVendorOrderStatus.”
200“error”:“orderId: 999-99999 er ikke et gyldigt orderId”
200“error”:“Kunne ikke hente ordre for at opdatereVendorOrderStatus fra orderId: 999-99999”
200“error”:“OrderId: 999-99999 er allerede blevet annulleret, og status kan ikke opdateres.”
200“error”:“Kan ikke opdatere ordrestatus til status: VENDOR_CANCELLATION_REQUEST”
200“error”:“Kan ikke opdatere ordrestatus til ugyldig status: NEW_ORDER_STATUS”
200“error”:“OrderId: 999-99999 har allerede nuvæ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 sikkerhedsgodkendelser”

Svar JSON-definitioner

BeskedDefinition
successDenne parameter vil indeholde et resumé af opdateringen.string
errorDenne parameter vil kun være til stede i svaret, når der er opstået en fejl, og vil indeholde en beskrivelse af årsagen.string

Var denne side nyttig?