Endpoint
Numeri d'ordine
Recupera un elenco di numeri d'ordine.
Dettagli dell'ordine
Recupera informazioni dettagliate per un ordine.
Utilizzo dell'endpoint API Recupera un ordine
Ci sono due modi comuni per utilizzare questi endpoint.
- (Parte 1 + Parte 2) – Utilizza una pagina di conferma / successo dell'ordine personalizzata sul tuo dominio per attivare il tuo sistema a chiamare l'endpoint
orderDetail
e importare un ordine completato. Inoltre, chiama regolarmente l'endpointorderNumbers
per riconciliare eventuali ordini nel Zonos Sistema non importati nel tuo sistema. - (Solo Parte 2) – Utilizza la pagina di conferma / successo dell'ordine di base di Zonos o una pagina statica sul tuo dominio per indicare il completamento dell'ordine al cliente. Pianifica il tuo sistema per chiamare regolarmente l'endpoint
orderNumbers
per determinare quando un nuovo ordine è pronto per essere importato nel tuo sistema. Quando viene trovato un ordine in sospeso, chiama l'endpointorderDetail
per i dati su quegli ordini.
Parte 1: Pagina di successo sul tuo dominio
Ogni volta che un acquirente completa un ordine nel Zonos Checkout, viene immediatamente reindirizzato a un URL della pagina di successo dell'ordine. L'ID dell'ordine completato sarà aggiunto all'URL di reindirizzamento come stringa di query. L'URL della pagina di successo dell'ordine deve essere fornito a Zonos. L'URL può anche essere passato come parametro nell'endpoint createTempCart
quando si crea il carrello temporaneo nel Zonos Sistema.
Esempio: http://www.examplestore.com/internationalThankYou?orderId=999-99999
Quando un cliente viene reindirizzato a questa pagina, il tuo sistema dovrà analizzare il valore per orderId
dall'URL. Utilizzerai quindi l'orderId
per chiamare l'endpoint orderDetail
per recuperare i dati dell'ordine.
Parte 2: Utilizza un lavoro programmato
Oltre a chiamare i dettagli dell'ordine quando viene attivata la pagina di successo, ti consigliamo di impostare una chiamata programmata per tutti gli ordini e i loro dettagli come una rete di sicurezza. In questo modo, puoi recuperare eventuali ordini completati nel Zonos Sistema che non sono ancora stati importati nel tuo sistema.
Questo processo dovrebbe essere un lavoro/script programmato, come un lavoro Cron, eseguito una volta all'ora/turno/giorno/ecc. (pianifica quanto più spesso il tuo processo aziendale ritenga necessario). Lo script dovrebbe chiamare tutti gli ordini e i loro dettagli che si sono verificati dall'ultima chiamata per gli ordini. L'endpoint orderNumbers
consente di recuperare ordini sinceOrderId
o sinceDate
come dimostrato nell'interfaccia di test API situata qui. Tutti gli ordini recuperati tramite questa chiamata programmata dovrebbero quindi essere riconciliati con gli ordini inseriti nel tuo sistema ogni volta che è stata attivata la pagina di successo. Qualsiasi ordine non già presente nel tuo sistema dovrebbe essere inserito nel tuo sistema e trattato come ordini legittimi.
Stato iniziale dell'ordine
IGLOBAL_ORDER_IN_PROCESS
o IGLOBAL_FRAUD_REVIEW
Quando chiami l'endpoint orderDetail
, ti consigliamo che il tuo sistema controlli prima la proprietà orderStatus
dei dati dell'ordine.
Gli ordini che non richiedono revisione per frode si inizializzeranno con orderStatus
: IGLOBAL_ORDER_IN_PROCESS
. Un ordine in questo stato è pronto per essere elaborato e spedito.
Gli ordini che richiedono revisione per frode si inizializzeranno in orderStatus
: IGLOBAL_FRAUD_REVIEW
. Un ordine in questo stato è attualmente in fase di screening e revisione per sospetta frode. Ti consigliamo di mettere questo ordine in uno stato di revisione o di attesa nel tuo sistema e continuare a chiamare l'endpoint orderDetail
fino a quando l'ordine non progredisce oltre il processo di revisione per frode di Zonos.
Una volta completato il processo di screening per frode di Zonos, l'ordine passerà a uno dei seguenti stati:
-
L'ordine supera lo screening per frode
- L'ordine passerà a
orderStatus
:IGLOBAL_ORDER_IN_PROCESS
e potrà continuare verso la spedizione.
- L'ordine passerà a
-
L'ordine non supera lo screening per frode
- L'ordine passerà a
orderStatus
:IGLOBAL_ORDER_CANCELLED
e dovrebbe essere annullato nel tuo sistema.
- L'ordine passerà a
Interfaccia di test API
Si prega di contattare il supporto per le credenziali del tuo account.
Recupera un ordine
Recupera un elenco di numeri d'ordine o informazioni dettagliate su un ordine.
Questo endpoint API “Recupera un Ordine” è utilizzato per recuperare dati per un ordine completato all'interno del Zonos Sistema. La risposta conterrà un oggetto JSON, che rappresenta tutte le informazioni disponibili per l'ordine, inclusi indirizzi di fatturazione e spedizione, metodo di spedizione, totali dell'ordine e stato.