API cliente
Collega direttamente il tuo sistema ERP a Feronix — REST, JSON su HTTPS, legato al tenant, con idempotenza e pre-validazione.
I dati trasmessi tramite API vengono sdoganati da Feronix sotto la propria EORI e i propri conti di dilazione. Tu come cliente trasmetti i dati di consegna e di spedizione; Feronix effettua la dichiarazione doganale come dichiarante e rappresentante. Le merci vengono consegnate direttamente al magazzino Feronix.
Quando usare l'API
L'API cliente è la via per il trasferimento automatizzato dai sistemi ERP (SAP, Microsoft Dynamics, Odoo, Oracle) e per tutti gli scenari di integrazione in cui vuoi trasferire consegne, manifesti di colli, dati di spedizione e documenti automaticamente. Sostituisce l'immissione manuale nel portale e consente l'automazione end-to-end dall'ERP alla dogana. Le consegne trasmesse sono destinate al magazzino Feronix; Feronix agisce come dichiarante e rappresentante nel procedimento doganale.
Formati di input supportati
- Payload REST strutturati — JSON su HTTPS
- JSON — per dati singoli e bundle più piccoli
- CSV — per l'importazione di dati massivi
- Bundle di consegna NOVA-POSHTA — nel formato NOVA, le righe articolo vengono consolidate per numero di pacco in pacchi fisici e nelle relative posizioni merce sottostanti
I dati master dei pacchi in conflitto, le assegnazioni duplicate o mancanti, importi, pesi, codici HS e componenti di indirizzo non validi vengono rilevati prima della creazione.
Autenticazione
curl -H 'X-Api-Key:' \ -H 'Accept-Language: de' \ https://atlas.feronix.tech/customer/me
La chiave determina il tenant lato server. Un customer_id
nel body non deve mai estendere questo ambito. Lingue supportate:
de, en, fr, es, zh, ru, uk.
Cosa puoi controllare tramite l'API
- Creare consegna
- Trasmettere dati di consegna e trasporto
- Importare lista colli o manifesto basato su articoli
- Consolidare pacchi e posizioni merce
- Caricare e assegnare fatture, prove del valore, T1 e altri documenti
- Recuperare la validazione
- Inviare la dichiarazione IMPOST esplicitamente
- Interrogare stato, errori, messaggi e documenti
- Correggere dati errati e reinviare con un nuovo numero di messaggio
Sequenza consigliata
- Definire il caso T1 — se esiste una procedura di transito
esistente, prima
POST /warehouse/delivery-documents/t1. Se deve essere creato un nuovo T1, impostaret1_mode=createnella consegna. - Creare consegna —
POST /warehouse/delivery-manifestsper la consegna inclusa scadenza e lista colli completa. - Caricare prova del valore —
POST /warehouse/value-evidenceper fattura/prova del valore. - Pre-validazione —
POST /customer/shipments/validateper il pre-check. Una validazione riuscita non invia nulla alla dogana. - Creare spedizione —
POST /customer/shipmentsper creare/inviare secondo il payload. - Monitorare lo stato —
GET /customer/shipments/{lrn}e processo doganale tramiteGET /customer/declarations/{lrn}. - Generare T1 — con
t1_mode=createdopo l'inserimento completo, generare il T1 tramitePOST /warehouse/deliveries/{delivery_number}/t1-xml.
Idempotenza
Le chiavi di idempotenza impediscono la creazione duplicata in caso di ripetizioni di rete o scanner. Un tentativo logicamente identico deve usare la stessa riferimento esterno o identificatore di idempotenza. Un reinvio corretto riceve un nuovo numero di messaggio ATLAS. Il timeout non è uguale al rifiuto — prima di riprovare, verifica se la richiesta è stata accettata e solo la risposta è andata persa.
Endpoint principali
| Metodo | Endpoint | Scopo |
|---|---|---|
| POST | /warehouse/delivery-manifests | Creare consegna e pacchi atomicamente (consegna al magazzino Feronix) |
| POST | /warehouse/value-evidence | Caricare prova del valore |
| POST | /customer/shipments/validate | Pre-validazione (non invia nulla alla dogana) |
| POST | /customer/shipments | Creare/inviare spedizione |
| GET | /customer/shipments/{lrn} | Stato della spedizione |
| GET | /customer/shipments/{lrn}/impost-xml | Esportare IMPOST-XML (ICOMDA) |
| GET | /customer/shipments/{lrn}/standard-clearance/dossier.pdf | Fascicolo doganale PDF |
| GET | /customer/shipments/{lrn}/standard-clearance/dossier.zip | Fascicolo doganale ZIP |
| POST | /customer/shipments/{lrn}/standard-clearance/atlas-xml | Generare DECDFA-XML |
| GET | /customer/declarations/{lrn} | Processo doganale con messaggi e decisione |
| POST | /customer/declarations/{lrn}/resubmit | Reinvio corretto |
| POST | /customer/suma/xml | Esportare SumA-XML |
| POST | /warehouse/transit-orders | Creare ordine di transito |
| POST | /warehouse/transit-orders/{id}/xml | Generare T1-XML (DETPDD) |
| POST | /customer/customs-xml/validate | Convalidare XML rispetto all'XSD originale |
| GET | /customer/me | Profilo tenant |
| GET | /customer/me/identities | Identità doganali (EORI/NL) — identità doganali di Feronix, sotto le quali Feronix agisce come dichiarante, non le tue |
| GET | /customer/me/mandates | Mandati di rappresentanza — mandati sotto i quali Feronix agisce per te come rappresentante nel procedimento doganale |
| GET | /customer/reference/hs-search | Ricerca codice HS |
Codici di errore
Gli errori API contengono stato HTTP, un codice di errore stabile, testo localizzato e, ove possibile, il percorso del campo interessato.
| Stato | Significato | Azione |
|---|---|---|
| 400 | Richiesta tecnicamente illeggibile | Verificare JSON, charset o file |
| 401 | Chiave API mancante o non valida | Inviare l'X-Api-Key del tenant corretto |
| 403 | Permesso mancante | Verificare il ruolo utente o l'approvazione API |
| 404 | Oggetto non trovato nel tenant | Verificare LRN, numero di consegna, codice a barre e tenant |
| 409 | Conflitto logico | Correggere stato, unicità o dati dipendenti |
| 422 | Campo/dipendenza obbligatorio violato | Elaborare completamente gli indizi specifici per campo |
| 500/502/503 | Errore tecnico | Non reinviare alla cieca — riprovare con la stessa chiave di idempotenza |