Aggiorna stato dell'ordine

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. Questo sarà utilizzato per aggiornare programmaticamente lo stato di spedizione dell'ordine o per richiedere una cancellazione.

Valori attuali dello stato dell'ordine

Di seguito è riportato un elenco attuale degli stati dell'ordine che un ordine può avere.

Attenzione - Zonos può 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 stati esistenti.

Stato	Descrizione	Impostabile da
IGLOBAL_FRAUD_REVIEW	L'ordine è attualmente sotto revisione frode da iGlobal.	Zonos
IGLOBAL_ORDER_IN_PROCESS	L'ordine è valido e pronto per l'elaborazione.	Zonos
IGLOBAL_ORDER_ON_HOLD	L'ordine è attualmente in attesa di uno stato temporaneo.	Zonos
IGLOBAL_ORDER_CANCELLED	L'ordine è stato cancellato nel sistema iGlobal.	Zonos
VENDOR_PREPARING_ORDER	Il fornitore ha contrassegnato l'ordine in preparazione.	Fornitore
VENDOR_SHIPMENT_READY	Il fornitore ha contrassegnato l'ordine pronto per la spedizione.	Fornitore
VENDOR_LABELS_PRINTED_DATE	Il fornitore ha stampato le etichette di spedizione.	Fornitore
VENDOR_CANCELLATION_REQUEST	L'ordine è stato richiesto per la cancellazione.	Fornitore
VENDOR_END_OF_DAY_COMPLETE	L'ordine è finalizzato e completo.	Fornitore

vendorOrderStatus non può essere aggiornato dal fornitore mentre l'ordine è in uno dei seguenti stati dell'ordine:

IGLOBAL_LABELS_PROCESSINGIGLOBAL_ORDER_ON_HOLDIGLOBAL_FRAUD_REVIEWIGLOBAL_ORDER_CANCELLEDVENDOR_CANCELLATION_REQUESTVENDOR_END_OF_DAY_COMPLETE

Richiesta HTTPS

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

Campo	Valore
Metodo HTTP	POST
URL dell'endpoint	`https://api.iglobalstores.com/v1/updateVendorOrderStatus`
Protocollo	HTTPS
Formato messaggio	JSON
Intestazione HTTP di accettazione	Accept: application/json
Intestazione HTTP Content-Type	Content-Type: application/json

Coppie chiave/valore JSON nel corpo della richiesta

Formato messaggio: JSON

ESEMPIO

{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "orderId": "999-9999",
  "orderStatus": "VENDOR_END_OF_DAY_COMPLETE"
}

Definizioni JSON della richiesta

Campo Note

orderId OBBLIGATORIO L'ID ordine di Zonos può essere passato con o senza il tuo ID 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 dell'ordine / pagina di ringraziamento per l'ordine ospitata sul tuo dominio. L'URL conterrà un parametro di querystring orderID che conterrà questo valore.integer / string

orderStatus OBBLIGATORIO Questo campo viene utilizzato per aggiornare il sistema di Zonos con il nuovo stato di un ordine. I seguenti stati dell'ordine possono essere impostati tramite questa API.- VENDOR_PREPARING_ORDER

Campo	Note
`orderId` OBBLIGATORIO	L'ID ordine di Zonos può essere passato con o senza il tuo ID 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 dell'ordine / pagina di ringraziamento per l'ordine ospitata sul tuo dominio. L'URL conterrà un parametro di querystring `orderID` che conterrà questo valore.`integer / string`
`orderStatus` OBBLIGATORIO	Questo campo viene utilizzato per aggiornare il sistema di Zonos con il nuovo stato di un ordine. I seguenti stati dell'ordine possono essere impostati 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 API fornito da Zonos.string | | store OBBLIGATORIO | ID negozio fornito da Zonosinteger |

Risposta HTTPS

Formato del messaggio: JSON

Esempio di risposta di successo

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

Esempio di risposta di errore

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

Risposte HTTP di errore

Codici di risposta HTTP	Esempio/Descrizione del corpo della risposta
406 - Non accettabile	Entità HTML. L'intestazione HTTP “Accept” non è valida.
415 - Tipo di media non supportato	Entità HTML. L'intestazione HTTP “Content-Type” non è valida.
200	“error”:“impossibile analizzare l'input”
200	“error”:“Parametro orderId richiesto per updateVendorOrderStatus”
200	“error”:“Parametro orderStatus richiesto per updateVendorOrderStatus.”
200	“error”:“orderId: 999-99999 non è un orderId valido”
200	“error”:“Impossibile recuperare l'ordine per updateVendorOrderStatus da orderId: 999-99999”
200	“error”:“OrderId: 999-99999 è già stato annullato e lo stato non può essere aggiornato.”
200	“error”:“Impossibile aggiornare lo stato dell'ordine a stato: VENDOR_CANCELLATION_REQUEST”
200	“error”:“Impossibile aggiornare lo stato dell'ordine a stato non valido: NEW_ORDER_STATUS”
200	“error”:“OrderId: 999-99999 ha già lo stato attuale: VENDOR_SHIPMENT_READY”
200	“error”:“OrderId: 999-99999 non può essere spostato allo stato dell'ordine: VENDOR_CANCELLATION_REQUEST mentre è in stato: VENDOR_END_OF_DAY_COMPLETE”
200	“error”:“Nuovo stato: NEW_ORDER_STATUS non è uno stato dell'ordine valido”
200	“error”:“Impossibile elaborare updateVendorOrderStatus.”
200	“error”:“Credenziali di sicurezza non valide”

Definizioni JSON di 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`

Questa pagina è stata utile?

Domande?

Contattaci.

Vedi Zonos

politiche e accordi