Guida alle API Qapla’
Le API forniscono la possibilità di integrare Qapla’ sia in lettura che in scrittura con il tuo sistema di ecommerce proprietario o per il quale non è stato ancora implementato un plugin o un connector.
L’integrazione consente operazioni sia in lettura che in scrittura, permettendo una gestione completa di:
- Ordini
- Spedizioni
- Tracking
- Etichette
- Corrieri
- Canali
- Help
Per poter utilizzare le API è necessario essere a conoscenza delle API Key Private assegnate al/ai tuo/i canale/i, che si trovano sul Control Panel nella sezione:
Impostazioni > Canali [Nome canale] > Configura > Canale > API KEY Private
Attenzione: la chiave API Key Private deve essere protetta e mantenuta segreta.
Ordini
Le seguenti API permettono di gestire i propri ordini:
- pushOrder per caricare uno o più ordini.
- getOrder per recuperare le informazioni di un ordine.
- getOrders per ottenere la lista degli ordini importati.
- updateOrder per aggiornare un ordine.
- deleteOrder per eliminare un ordine.
- undeleteOrder per ripristinare un ordine eliminato.
- detectOrderCourier permette di ottenere il corriere da assegnare all’ordine, seguendo regole preimpostate (impostazioni da configurare sul Control Panel).
Spedizioni
Le seguenti API permettono di gestire le proprie spedizioni:
- pushShipment per caricare una o più spedizioni.
- getShipment per recuperare le informazioni e leggere lo stato di una spedizione.
- getShipments per ricevere la lista delle spedizioni importate.
- updateShipment per aggiornare spedizione.
- deleteShipment per eliminare una spedizione.
- undeleteShipment per ripristinare una spedizione eliminata.
Tracking
Le seguenti API permettono di recuperare informazioni e monitorare lo stato delle spedizioni:
- getShipment per recuperare le informazioni e leggere lo stato di una spedizione.
- trackingByTimeFrame permette di ottenere l’elenco delle spedizioni che hanno subìto un aggiornamento dello stato del tracking compreso nel range richiesto.
- Tracking Script configurando e inserento il Tracking Scritp di Qapla’ all’interno del tuo sito, puoi visualizzare lo storico del tracking di una spedizione in formato HTML, direttamente sulla tua piattaforma.
Per una gestione completa e sincronizzata dello stato di avanzamento delle spedizioni consigliamo di valutare anche l’uso del Webhook, nello specifico Shipments webhook.
Platforms
- fetchPlatformOrders permette di ricevere la lista degli ordini presenti su una platform (CMS/Marketplace). Per l’uso di questa API è necessario che il CMS e/Marketplace sia configurato.
- updatePlatformOrder permette di aggiornare gli ordini presenti su una platform. Per l’uso di questa API è necessario che il CMS e/Marketplace sia configurato.
Etichette
- createLabel permette di creare una spedizione e ottenere l’etichetta, l’equivalente della generazione sul pannello di controllo “Crea” e “Stampa”.
- confirmLabel permette di trasmettere al corriere le spedizione create per concludere la generazione della spedizione. La risposta restituisce la distinta di carico (borderò/manifest) in formato PDF.
createLabel e confirmLabel prevedono un costo e un’attivazione. Se già acquistato il prodotto, richiedere l’attivazione scrivendo a success@qapla.it.
- getLabel per ottenere un’etichettta precedentemente creata su Qapla’ nel formato etichette nel formato originale del corriere (PDF, JPG o ZPL).
- checkLabel per verificare lo stato di un’etichettta precedentemente creata su Qapla’.
- deleteLabel per eliminare un’etichetta creata con createLabel.
Corrieri
- getCouriers permette di richiedere l’elenco dei corrieri sia totale, sia per singola nazione/ragione.
- detectCourier cerca di determinare il corriere dal tracking number fornito, rispondendo con un elenco di corrieri.
- getPudos permette di richiedere l’elenco dei PUDO (Pick Up Drop Off points, OOH) di più corrieri contemporaneamente. Richiedere l’attivazione al Customer Care scrivendo a support@qapla.it
- getQuotes permette di richiedere preventivi di spedizione a più corrieri per più servizi contemporaneamente. Richiedere l’attivazione al Customer Care scrivendo a support@qapla.it
Virtual Courier
- apiVirtual permette di aggiornare lo stato di una spedizione del corriere virtuale.
Canali
- getChannel permette di ottenere informazioni sul canale collegato all’API Key e all’azienda che lo ha creato.
- checkChannel permette di verificare le connessioni con la piattaforma e i marketplace configurati sul canale.
- createChannel permette di creare un nuovo canale.
- updateChannel permette di modificare alcune impostazioni del canale.
- deleteChannel permette di eliminare uno specifico canale.
Stati Qapla’
- getQaplaStatus permette di ottenere l’elenco dettagliato degli stati spedizione Qapla’.
Help
- Qapla’ Status è l’interpretazione dello stato della spedizione con dei valori che Qapla’ assegna a ciascun possibile stato del corriere.
- Courier’s codes elenco dei codici Qapla’ per corriere, in ordine alfabetico.
Hai bisogno di supporto?
Se desideri assistenza contatta il Customer Care Qapla‘ scrivendo a support@qapla.it
