Valeurs actuelles du statut de commande
Voici une liste actuelle des statuts de commande qu'une commande peut avoir.
Attention - Zonos peut ajouter d'autres statuts à tout moment ; votre système doit pouvoir gérer la présence de statuts supplémentaires.
Les statuts en production resteront en production. Zonos ne supprimera jamais les statuts existants.
Statut | Description | Défini par |
---|---|---|
IGLOBAL_FRAUD_REVIEW | La commande est actuellement en cours de révision pour fraude par iGlobal. | Zonos |
IGLOBAL_ORDER_IN_PROCESS | La commande est valide et prête pour le traitement. | Zonos |
IGLOBAL_ORDER_ON_HOLD | La commande est actuellement en attente d'un statut temporaire. | Zonos |
IGLOBAL_ORDER_CANCELLED | La commande a été annulée dans le système iGlobal. | Zonos |
VENDOR_PREPARING_ORDER | Le vendeur a marqué la commande en préparation. | Vendeur |
VENDOR_SHIPMENT_READY | Le vendeur a marqué la commande prête pour l'expédition. | Vendeur |
VENDOR_LABELS_PRINTED_DATE | Le vendeur a imprimé les étiquettes d'expédition. | Vendeur |
VENDOR_CANCELLATION_REQUEST | La commande a été demandée pour annulation. | Vendeur |
VENDOR_END_OF_DAY_COMPLETE | La commande est finalisée et complète. | 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 HTTP | POST |
URL du point de terminaison | https://api.iglobalstores.com/v1/updateVendorOrderStatus |
Protocole | HTTPS |
Format du message | JSON |
En-tête HTTP Accept | Accepter : application/json |
En-tête HTTP Content-Type | Content-Type : application/json |
Paires clé/valeur JSON dans le corps de la requête
Format du message : JSON
EXEMPLE
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"orderId": "999-9999",
"orderStatus": "VENDOR_END_OF_DAY_COMPLETE"
}
Définitions JSON de la requête
Champ | Remarques |
---|---|
orderId REQUIS | L'ID de commande Zonos peut être transmis avec ou sans l'ID de votre magasin 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 confirmation de commande / page de remerciement 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 REQUIS | Ce champ est utilisé pour mettre à jour le système Zonos avec le nouveau statut d'une commande. Les statuts de commande suivants peuvent être définis via cette API.- VENDOR_PREPARING_ORDER |
VENDOR_SHIPMENT_READY
VENDOR_LABELS_PRINTED
VENDOR_END_OF_DAY_COMPLETE
VENDOR_CANCELLATION_REQUEST``string
| |secret
REQUIS | GUID secret de l'API fourni par Zonos.string
| |store
REQUIS | ID de magasin fourni par Zonosinteger
|
Réponse HTTPS
Format du message: JSON
Exemple de réponse réussie
{
"success": "Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"
}
Exemple de réponse d'erreur
{
"error": "OrderId: 99999 cannot be moved to order status: VENDOR_PREPARING_ORDER while in status: IGLOBAL_FRAUD_REVIEW"
}
Réponses d'erreur HTTP
Codes de réponse HTTP | Exemple de corps de réponse/Description |
---|---|
406 - Non acceptable | Entité HTML. L'en-tête HTTP "Accept" n'est pas valide. |
415 - Type de média non supporté | Entité HTML. L'en-tête HTTP "Content-Type" n'est pas valide. |
200 | "error": "impossible d'analyser l'entrée" |
200 | "error": "Le paramètre orderId est requis pour updateVendorOrderStatus" |
200 | "error": "Le paramètre orderStatus est requis pour updateVendorOrderStatus." |
200 | "error": "orderId : 999-99999 n'est pas un orderId valide" |
200 | "error": "Impossible de récupérer la commande pour updateVendorOrderStatus à partir de l'orderId : 999-99999" |
200 | "error": "L'orderId : 999-99999 a déjà été annulé et le statut ne peut pas être mis à jour." |
200 | "error": "Impossible de mettre à jour le statut de la commande en statut : VENDOR_CANCELLATION_REQUEST" |
200 | "error": "Impossible de mettre à jour le statut de la commande en statut invalide : NEW_ORDER_STATUS" |
200 | "error": "L'orderId : 999-99999 a déjà le statut actuel : VENDOR_SHIPMENT_READY" |
200 | "error": "L'orderId : 999-99999 ne peut pas être déplacé vers le statut de commande : VENDOR_CANCELLATION_REQUEST alors qu'il est dans le statut : VENDOR_END_OF_DAY_COMPLETE" |
200 | "error": "Le nouveau statut : NEW_ORDER_STATUS n'est pas un statut de commande valide" |
200 | "error": "Impossible de traiter updateVendorOrderStatus." |
200 | "error": "Informations d'identification de sécurité invalides" |
Définitions JSON de réponse
Message | Définition |
---|---|
success | Ce paramètre contiendra un résumé de la mise à jour. string |
error | Ce paramètre ne sera présent que dans la réponse en cas d'erreur et contiendra une description de la cause. string |
Mettre à jour le statut de la commande
Découvrez comment fonctionne le point de terminaison pour mettre à jour le statut de la commande.
Le point de terminaison
updateVendorOrderStatus
est utilisé pour mettre à jour le statut de commande d'une commande dans le système Zonos. Cela sera utilisé pour mettre à jour de manière programmatique le statut d'expédition de la commande ou pour demander une annulation.