Scopri come funziona l'endpoint per aggiornare lo stato dell'ordine.
L'endpoint updateVendorOrderStatus viene utilizzato per aggiornare lo stato dell'ordine di un ordine all'interno del sistema Zonos. Verrà utilizzato per aggiornare programmaticamente lo stato di spedizione dell'ordine o per richiedere un annullamento.
Di seguito è riportato un elenco aggiornato degli stati che un ordine può avere.
Attenzione - Zonos potrebbe aggiungere ulteriori stati in qualsiasi momento; il tuo sistema dovrebbe essere in grado di gestire la presenza di stati aggiuntivi.
Gli stati in produzione rimarranno in produzione. Zonos non rimuoverà mai gli stati esistenti.
Stato↕
Descrizione↕
Impostabile da↕
IGLOBAL_FRAUD_REVIEW
L'ordine è attualmente sotto revisione antifrode da parte di iGlobal.
Zonos
IGLOBAL_ORDER_IN_PROCESS
L'ordine è valido e pronto per l'elaborazione.
Zonos
IGLOBAL_ORDER_ON_HOLD
L'ordine è attualmente in sospensione temporanea.
Zonos
IGLOBAL_ORDER_CANCELLED
L'ordine è stato annullato nel sistema iGlobal.
Zonos
VENDOR_PREPARING_ORDER
Il fornitore ha contrassegnato l'ordine come in preparazione.
Fornitore
VENDOR_SHIPMENT_READY
Il fornitore ha contrassegnato l'ordine come pronto per la spedizione.
Fornitore
VENDOR_LABELS_PRINTED_DATE
Il fornitore ha stampato le etichette di spedizione.
Fornitore
VENDOR_CANCELLATION_REQUEST
È stato richiesto l'annullamento dell'ordine.
Fornitore
VENDOR_END_OF_DAY_COMPLETE
L'ordine è finalizzato e completo.
Fornitore
vendorOrderStatus non può essere aggiornato dal fornitore mentre l'ordine si trova in uno dei seguenti stati:
Coppie chiave/valore JSON nel corpo della richiesta
Formato del messaggio: JSON
1{
2"store":"999",
3"secret":"f5bde245-f55e-414d-b722-80b25161c12c",
4"orderId":"999-9999",
5"orderStatus":"VENDOR_END_OF_DAY_COMPLETE"
6}
Definizioni JSON della richiesta
Campo↕
Note↕
orderId OBBLIGATORIO
L'ID d'ordine Zonos può essere passato con o senza l'ID del tuo negozio e il trattino (Esempio: 123-45678 o 45678). Dopo il completamento dell'ordine e il pagamento, il cliente verrà reindirizzato a una pagina di completamento ordine / pagina di ringraziamento ospitata sul tuo dominio. L'URL conterrà un parametro querystring orderID che conterrà questo valore.integer / string
orderStatus OBBLIGATORIO
Questo campo viene utilizzato per aggiornare il sistema Zonos con il nuovo stato di un ordine.I seguenti stati dell'ordine sono impostabili tramite questa API.- VENDOR_PREPARING_ORDER
VENDOR_SHIPMENT_READY
VENDOR_LABELS_PRINTED
VENDOR_END_OF_DAY_COMPLETE
VENDOR_CANCELLATION_REQUEST``string |
| secret OBBLIGATORIO | GUID segreto dell'API fornito da Zonos.string |
| store OBBLIGATORIO | ID del negozio fornito da Zonosinteger |
Risposta HTTPS
Formato del messaggio: JSON
1{
2"success":"Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"
3}
Risposte di errore HTTP
Codici di risposta HTTP↕
Esempio/descrizione del corpo della risposta↕
406 - Not Acceptable
Entità HTML. L'intestazione HTTP “Accept” non è valida.
415 - Unsupported media type
Entità HTML. L'intestazione HTTP “Content-Type” non è valida.
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”
Definizioni JSON della risposta
Messaggio↕
Definizione↕
success
Questo parametro conterrà un riepilogo dell'aggiornamento.string
error
Questo parametro sarà presente nella risposta solo quando si è verificato un errore e conterrà una descrizione della causa.string
Aggiornare lo stato dell'ordine
Aggiornare lo stato dell'ordine
Scopri come funziona l'endpoint per aggiornare lo stato dell'ordine.
L'endpoint
updateVendorOrderStatusviene utilizzato per aggiornare lo stato dell'ordine di un ordine all'interno del sistema Zonos. Verrà utilizzato per aggiornare programmaticamente lo stato di spedizione dell'ordine o per richiedere un annullamento.Valori attuali dello stato dell'ordine
Di seguito è riportato un elenco aggiornato degli stati che un ordine può avere.
Richiesta HTTPS
POST |
https://api.iglobalstores.com/v1/updateVendorOrderStatushttps://api.iglobalstores.com/v1/updateVendorOrderStatusCoppie chiave/valore JSON nel corpo della richiesta
Formato del messaggio: JSON
{"store": "999","secret": "f5bde245-f55e-414d-b722-80b25161c12c","orderId": "999-9999","orderStatus": "VENDOR_END_OF_DAY_COMPLETE"}Definizioni JSON della richiesta
orderIdOBBLIGATORIOorderIDche conterrà questo valore.integer / stringorderStatusOBBLIGATORIOVENDOR_PREPARING_ORDERVENDOR_SHIPMENT_READYVENDOR_LABELS_PRINTEDVENDOR_END_OF_DAY_COMPLETEVENDOR_CANCELLATION_REQUEST``string| |secretOBBLIGATORIO | GUID segreto dell'API fornito da Zonos.string| |storeOBBLIGATORIO | ID del negozio fornito da Zonosinteger|Risposta HTTPS
Formato del messaggio: JSON
{"success": "Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"}Risposte di errore HTTP
Definizioni JSON della risposta
successstringerrorstringQuesta pagina è stata utile?