DOCS

Update order status

/

Bestelstatus bijwerken

Leer hoe het eindpunt voor het bijwerken van de bestelstatus werkt.

De updateVendorOrderStatus eindpunt wordt gebruikt om de bestelstatus van een bestelling binnen het Zonos Systeem bij te werken. Dit zal worden gebruikt om programmatic de verzendstatus van de bestelling bij te werken of om een annulering aan te vragen.

Huidige waarden voor bestelstatus 

Hieronder staat een actuele lijst van bestelstatussen die een bestelling kan hebben.

Voorzichtigheid - Zonos kan op elk moment meer statussen toevoegen; uw systeem moet rekening houden met de aanwezigheid van extra statussen.

De statussen in productie blijven in productie. Zonos zal nooit bestaande statussen verwijderen.

StatusBeschrijvingInstelbaar door
IGLOBAL_FRAUD_REVIEWDe bestelling is momenteel onder fraudeonderzoek door iGlobal.Zonos
IGLOBAL_ORDER_IN_PROCESSDe bestelling is geldig en klaar voor verwerking.Zonos
IGLOBAL_ORDER_ON_HOLDDe bestelling staat momenteel op een tijdelijke statusstop.Zonos
IGLOBAL_ORDER_CANCELLEDDe bestelling is geannuleerd in het iGlobal Systeem.Zonos
VENDOR_PREPARING_ORDERDe leverancier heeft de bestelling in voorbereiding gemarkeerd.Leverancier
VENDOR_SHIPMENT_READYDe leverancier heeft de bestelling klaar voor verzending gemarkeerd.Leverancier
VENDOR_LABELS_PRINTED_DATEDe leverancier heeft verzendlabels afgedrukt.Leverancier
VENDOR_CANCELLATION_REQUESTDe bestelling is aangevraagd voor annulering.Leverancier
VENDOR_END_OF_DAY_COMPLETEDe bestelling is afgerond en compleet.Leverancier

vendorOrderStatus kan niet door de leverancier worden bijgewerkt terwijl de bestelling zich in een van de volgende bestelstatussen bevindt:

IGLOBAL_LABELS_PROCESSINGIGLOBAL_ORDER_ON_HOLDIGLOBAL_FRAUD_REVIEWIGLOBAL_ORDER_CANCELLEDVENDOR_CANCELLATION_REQUESTVENDOR_END_OF_DAY_COMPLETE

HTTPS-verzoek

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

VeldWaarde
HTTP-methodePOST
Eindpunt-URLhttps://api.iglobalstores.com/v1/updateVendorOrderStatus
ProtocolHTTPS
BerichtformaatJSON
Accept HTTP-headerAccept: application/json
Content-Type HTTP-headerContent-Type: application/json

JSON sleutel/waarde paren in de aanvraagbody

Berichtformaat: JSON

VOORBEELD

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

Verzoek JSON-definities

VeldOpmerkingen
orderId VERPLICHTDe Zonos order-ID kan met of zonder uw winkel-ID en koppelteken worden doorgegeven (Voorbeeld: 123-45678 of 45678). Na voltooiing van de bestelling en betaling wordt de klant omgeleid naar een pagina voor het voltooien van de bestelling / bedankpagina voor de bestelling die op uw domein is gehost. De URL bevat een querystringparameter orderID die deze waarde bevat.integer / string
orderStatus VERPLICHTDit veld wordt gebruikt om het Zonos systeem bij te werken met de nieuwe status van een bestelling. De volgende bestelstatussen zijn instelbaar via deze API.- VENDOR_PREPARING_ORDER
  • VENDOR_SHIPMENT_READY
  • VENDOR_LABELS_PRINTED
  • VENDOR_END_OF_DAY_COMPLETE
  • VENDOR_CANCELLATION_REQUEST``string | | secret VERPLICHT | API geheim GUID verstrekt door Zonos.string | | store VERPLICHT | Winkel-ID verstrekt door Zonosinteger |

HTTPS-respons

Berichtformaat: JSON

Voorbeeld van een succesvolle respons

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

Voorbeeld foutrespons

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

Fout HTTP-antwoorden

HTTP AntwoordcodesVoorbeeld/Omschrijving van het Antwoordlichaam
406 - Niet AcceptabelHTML-entiteit. HTTP “Accept”-header is ongeldig.
415 - Ongesteunde mediatypeHTML-entiteit. HTTP “Content-Type”-header is ongeldig.
200“error”:“kon invoer niet parseren”
200“error”:“Parameter orderId vereist voor updateVendorOrderStatus”
200“error”:“Parameter orderStatus vereist voor updateVendorOrderStatus.”
200“error”:“orderId: 999-99999 is geen geldige orderId”
200“error”:“Kon order niet ophalen om updateVendorOrderStatus uit orderId: 999-99999”
200“error”:“OrderId: 999-99999 is al geannuleerd en status kan niet worden bijgewerkt.”
200“error”:“Kan orderstatus niet bijwerken naar status: VENDOR_CANCELLATION_REQUEST”
200“error”:“Kan orderstatus niet bijwerken naar ongeldige status: NEW_ORDER_STATUS”
200“error”:“OrderId: 999-99999 heeft al de huidige status: VENDOR_SHIPMENT_READY”
200“error”:“OrderId: 999-99999 kan niet worden verplaatst naar orderstatus: VENDOR_CANCELLATION_REQUEST terwijl in status: VENDOR_END_OF_DAY_COMPLETE”
200“error”:“Nieuwe Status: NEW_ORDER_STATUS is geen geldige orderstatus”
200“error”:“Kon updateVendorOrderStatus niet verwerken.”
200“error”:“Ongeldige beveiligingsreferenties”

Antwoord JSON-definities

BerichtDefinitie
successDeze parameter bevat een samenvatting van de update.string
errorDeze parameter is alleen aanwezig in het antwoord wanneer er een fout is opgetreden en bevat een beschrijving van de oorzaak.string

Was deze pagina nuttig?