DOCS

Mettre à jour le statut de commande

Découvrez le fonctionnement du point de terminaison de mise à jour du statut de commande.

Le point de terminaison updateVendorOrderStatus met à jour le statut de commande d'une commande dans le système Zonos. Il sert à mettre à jour par programmation le statut d'expédition de la commande ou à demander une annulation.

Valeurs actuelles du statut de commande 

Voici la liste actuelle des statuts de commande qu'une commande peut avoir.

Attention — Zonos peut ajouter d'autres statuts à tout moment ; votre système doit prendre en charge la présence de statuts supplémentaires.

Les statuts en production resteront en production. Zonos ne supprimera jamais les statuts existants.

Statut↕Description↕Définissable par↕
IGLOBAL_FRAUD_REVIEWLa commande est actuellement en cours de vérification de fraude par iGlobal.Zonos
IGLOBAL_ORDER_IN_PROCESSLa commande est valide et prête à être traitée.Zonos
IGLOBAL_ORDER_ON_HOLDLa commande est actuellement en attente temporaire.Zonos
IGLOBAL_ORDER_CANCELLEDLa commande a été annulée dans le système iGlobal.Zonos
VENDOR_PREPARING_ORDERLe vendeur a marqué la commande en préparation.Vendeur
VENDOR_SHIPMENT_READYLe vendeur a marqué la commande prête à l'expédition.Vendeur
VENDOR_LABELS_PRINTED_DATELe vendeur a imprimé les étiquettes d'expédition.Vendeur
VENDOR_CANCELLATION_REQUESTLa commande a fait l'objet d'une demande d'annulation.Vendeur
VENDOR_END_OF_DAY_COMPLETELa commande est finalisée et terminée.Vendeur

vendorOrderStatus ne peut pas être mis à jour par le vendeur lorsque la commande se trouve dans l'un des statuts de commande suivants :

IGLOBAL_LABELS_PROCESSINGIGLOBAL_ORDER_ON_HOLDIGLOBAL_FRAUD_REVIEWIGLOBAL_ORDER_CANCELLEDVENDOR_CANCELLATION_REQUESTVENDOR_END_OF_DAY_COMPLETE

Requête HTTPS

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

Champ↕Valeur↕
Méthode HTTPPOST
URL du point de terminaisonhttps://api.iglobalstores.com/v1/updateVendorOrderStatus
ProtocoleHTTPS
Format du messageJSON
En-tête HTTP AcceptAccept: application/json
En-tête HTTP Content-TypeContent-Type: application/json

Paires clé/valeur JSON dans le corps de la requête

Format du message : JSON

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

Définitions JSON de la requête

Champ↕Notes↕
orderId REQUIREDL'ID de commande Zonos peut être transmis avec ou sans l'ID de votre boutique et le tiret (exemple : 123-45678 ou 45678).Après la finalisation de la commande et le paiement, le client sera redirigé vers une page de finalisation / remerciement de commande hébergée sur votre domaine. L'URL contiendra un paramètre de chaîne de requête orderID qui contiendra cette valeur.integer / string
orderStatus REQUIREDCe champ sert à mettre à jour le système Zonos avec le nouveau statut d'une commande.Les statuts de commande suivants sont définissables via cette API.- VENDOR_PREPARING_ORDER
  • VENDOR_SHIPMENT_READY
  • VENDOR_LABELS_PRINTED
  • VENDOR_END_OF_DAY_COMPLETE
  • VENDOR_CANCELLATION_REQUEST``string | | secret REQUIRED | GUID secret API fourni par Zonos.string | | store REQUIRED | ID de boutique fourni par Zonosinteger |

Réponse HTTPS

Format du message : JSON

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

Réponses HTTP d'erreur

Codes de réponse HTTP↕Exemple / description du corps de réponse↕
406 - Not AcceptableEntité HTML. L'en-tête HTTP « Accept » est invalide.
415 - Unsupported media typeEntité HTML. L'en-tête HTTP « Content-Type » est invalide.
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 »

Définitions JSON de la réponse

Message↕Définition↕
successCe paramètre contiendra un résumé de la mise à jour.string
errorCe paramètre ne sera présent dans la réponse qu'en cas d'erreur et contiendra une description de la cause.string
Réserver une démo

Cette page vous a-t-elle été utile?