DOCS

Recuperare un ordine

Recuperare un ordine

Recupera un elenco di numeri d'ordine o informazioni dettagliate su un ordine.

Questo endpoint API “Retrieve an Order” viene utilizzato per recuperare i dati di un ordine completato all'interno del sistema Zonos. 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.

Endpoint 

Numeri d'ordine

Recupera un elenco di numeri d'ordine.

Dettagli dell'ordine

Recupera informazioni dettagliate su un ordine.

Utilizzo dell'endpoint API Retrieve an Order

Esistono due modi comuni per utilizzare questi endpoint.

  1. (Parte 1 + Parte 2) – Utilizza una pagina di conferma/successo dell'ordine personalizzata sul tuo dominio per attivare la chiamata del tuo sistema all'endpoint orderDetail e importare un ordine completato. Inoltre, chiama regolarmente l'endpoint orderNumbers per riconciliare eventuali ordini presenti nel sistema Zonos ma non importati nel tuo sistema.
  2. (Solo Parte 2) – Utilizza la pagina di conferma/successo dell'ordine di base di Zonos oppure una pagina statica sul tuo dominio per indicare al cliente il completamento dell'ordine. Pianifica il tuo sistema affinché chiami 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'endpoint orderDetail per ottenere i dati relativi a tali 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 di pagina di successo dell'ordine. L'ID dell'ordine completato verrà aggiunto all'URL di reindirizzamento come query string. L'URL della pagina di successo dell'ordine deve essere fornito a Zonos. L'URL può anche essere passato come parametro nell'endpoint createTempCart durante la creazione del carrello temporaneo nel sistema Zonos.

Esempio: http://www.examplestore.com/internationalThankYou?orderId=999-99999

Quando un cliente viene reindirizzato a questa pagina, il tuo sistema dovrà analizzare il valore di orderId dall'URL. Utilizzerai quindi orderId per chiamare l'endpoint orderDetail e recuperare i dati dell'ordine.

Parte 2: Utilizzare un job pianificato

Oltre a richiedere i dettagli dell'ordine quando viene attivata la pagina di successo, ti consigliamo di impostare una chiamata pianificata per tutti gli ordini e i relativi dettagli come rete di sicurezza. In questo modo puoi recuperare eventuali ordini completati nel sistema Zonos che non sono ancora stati importati nel tuo sistema.

Questo processo dovrebbe essere un job/script pianificato, come un job Cron, eseguito una volta all'ora/turno/giorno/ecc. (pianifica la frequenza necessaria in base ai processi della tua attività). Lo script dovrebbe richiedere tutti gli ordini e i relativi dettagli verificatisi dall'ultima chiamata per gli ordini. L'endpoint orderNumbers consente di recuperare gli ordini sinceOrderId o sinceDate, come dimostrato nella API test GUI disponibile qui. Tutti gli ordini recuperati tramite questa chiamata pianificata dovrebbero poi essere riconciliati con gli ordini inseriti nel tuo sistema ogni volta che è stata attivata la pagina di successo. Gli ordini non ancora presenti nel tuo sistema dovrebbero essere inseriti e trattati 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 la revisione antifrode verranno inizializzati con orderStatus : IGLOBAL_ORDER_IN_PROCESS. Un ordine in questo stato è pronto per essere elaborato e spedito.

Gli ordini che richiedono la revisione antifrode verranno inizializzati con orderStatus : IGLOBAL_FRAUD_REVIEW. Un ordine in questo stato è attualmente sotto controllo e revisione per sospetta frode. Ti consigliamo di porre questo ordine in uno stato di revisione o sospensione nel tuo sistema e di continuare a chiamare l'endpoint orderDetail finché l'ordine non supera il processo di revisione antifrode di Zonos.

Una volta completato il processo di screening antifrode di Zonos, l'ordine passerà a uno dei seguenti stati:

  • L'ordine supera lo screening antifrode

    • L'ordine passerà a orderStatus : IGLOBAL_ORDER_IN_PROCESS e potrà procedere verso la spedizione.
  • L'ordine non supera lo screening antifrode

    • L'ordine passerà a orderStatus : IGLOBAL_ORDER_CANCELLED e dovrà essere annullato nel tuo sistema.

API test GUI

Per le credenziali del tuo account, contatta il supporto.

Questa pagina è stata utile?