EN
RESTful JSON API Ver. 1.2
rel. 1.2.141
Qapla' srl   •   06492420481

Introduzione

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.

Versioni precedenti
Le precedenti versioni di questa API sono mantenute ancora attive, ma considerate deprecate.
Webhook
Qapla' ha anche un servizio Webhook che è parte integrante delle API.

API Key

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 \ [NOME_CANALE]

Questa chiave API deve essere protetta e mantenuta segreta.

API Key

Endpoint

https://api.qapla.it/[API_VERSION]/[ENDPOINT]
[API_VERSION]È il valore di versione dell'API.
[ENDPOINT]È l'endpoint che devi chiamare.

Response

La risposta JSON ad una Request utilizza questo formato standard

    
[API_NAME]Il nome dell'API consumata
[OK/KO]OK in caso di risposta positiva, KO In caso di errore
[ERROR_MESSAGE]È null in caso di OK e conterrà l'errore in caso di KO

Limiti di utilizzo

Il sistema utilizza l'algoritmo TokenBucket con i seguenti parametri:

Bucket capacity 120 Maximum of 120 requests
Tokens per second 2 Refilling at a rate of 2 per second
Attenzione
Una request multipla (es: pushShipment o pushOrder con 100 spedizioni od ordini) viene valutata come 100 token.
HTTP Response Status Codes
Un superamento del limite porterà al seguente response HTTP
429 Too Many Requests
e al seguente errore di risposta da parte di qualunque API coinvolta
"error": "Too Many Requests"
Abuse
L'abuso dell'utilizzo porterà ad un BAN dell'API Key.

Sandbox

Non esiste un ambiente di Sandbox vero e proprio. È sufficiente utilizzare il campo sandbox direttamente nelle chiamate API che lo supportano per utilizzare l'infrastrutture di test senza avere effetti operativi (come costi, richieste di presa al corriere, ecc..)

Test

Una volta ottenuta l'API Key è possibile effettuare immediatamente un test di connessione utilizzado l'API getChannel.

Postman Collection

Postman Una Postman Collection è disponibile.

Spedizioni

La chiave primaria per identificare una spedizione è:

pushShipment

pushShipment permette di caricare una o più spedizioni tramite una POST dei dati in formato JSON.

In combinazione con il Webhook crea un sistema integrato di gestione delle spedizioni.

POSThttps://api.qapla.it/1.2/pushShipment/
Request

In questo esempio vengono caricate due spedizioni, una in formato "minimo" e una "completo".



            
Parametri

Esistono 3 tipi di modalità di caricamento delle spedizioni.

  1. "minimo" contenente 3 campi obbligatori*
  2. "necessario" per attivare i servizi aggiuntivi di comunicazione al cliente come Email transazionali, ecc.
  3. "completo" con sempre i primi 3 campi obbligatori, ma che contiene tutte le informazioni

*Parametro obbligatorio

Parametro necessario per attivare email transazionali e/o SMS


Il numero massimo di spedizioni inviabili per ogni singola request è 100.
apiKey(string) La API Key assegnata al canale nel quale si desidera importare le spedizioni
pushShipment(array)

È un array di massimo 100 spedizioni da caricare.

trackingNumber*(string) Il tracking number / numero di spedizione / lettera di vettura del corriere
courier*(string) Il codice corriere di Qapla'
shipDate*(string) Data spedizione
reference(string) Riferimento ordine
platformOrderID(string) Eventuale ID numerico o alfanumerico, utilizzato come riferimento aggiuntivo per l'ordine
orderDate(string) Data dell'ordine
weight(float) Eventuale peso della spedizione
parcels(int) Eventuali colli della spedizione
length(float) Eventuali misure: lunghezza
width(float) Eventuali misure: profondità
height(float) Eventuali misure: altezza
name(string) Nome del destinatario
street(string) Indirizzo del destinatario
city(string) Città del destinatario
ZIP(string) CAP del destinatario
state(string) Provincia del destinatario
country(string) La nazione del destinatario in formato ISO 3166-1 alpha-2 (Esempio: IT)
email(string) Email del destinatario
telephone(string) Telefono del destinatario
agent(string) Indirizzo email di un contatto commerciale del cliente
amount(string) Eventuale importo della spedizione (da comunicare al cliente. Es: contrassegno)
pod(boolean) È true se la spedizione è in contrassegno
shipping(string) Eventuale costo della spedizione
custom1(string) Valore custom 1
custom2(string) Valore custom 2
custom3(string) Valore custom 3
note(string) Una nota relativa alla spedizione (max 255 char)
language(string) Lingua della spedizione (ISO 639-1, es: 'fr').
Un valore nullo o non riconosciuto indicherà la spedizione come 'it'.
origin(string) Origine della spedizione, valori ammessi:
amazon, carrefour_es, cdiscount, ebay, ecwid, eprice, ibs, magento, magento2, manomano_de, manomano_es, manomano_fr, manomano_gb, manomano_it, prestashop, privalia_es, privalia_it, shopify, spartoo_be, spartoo_cn, spartoo_de, spartoo_es, spartoo_fr, spartoo_gb, spartoo_gr, spartoo_it, spartoo_nl, spartoo_pl, spartoo_pt, storeden, vtex, woocommerce, worten_es, worten_pt, mediaMarkt_de
isReturnable(bool) Se è true indica la possibilità di reso dell'intera spedizione.
deliveryDate(string) Eventuale data richiesta consegna
tag(string) Una "tag" per identificare spedizioni appartenenti ad un gruppo.
isTrackingNumber(bool) È true quando posto nel campo trackingNumber è il tracking number reale della spedizione.
rows

È un array di "righe ordine".

Non è obbligatorio, ma se popolato ha alcuni dati che lo sono.

sku*(string) Codice articolo
name*(string) Descrizione articolo
qty*(int) Quantità
weight(float) Eventuale peso dell'articolo
url(float) La url specifica del prodotto
imageUrl(string) La url dell'immagine del prodotto
price*(string) Prezzo
total(string) Prezzo totale
isReturnable(bool) Se è true indica la possibilità di reso del singolo articolo
Response Body200


                
Errori

In caso di errore invece ogni riga di spedizione verrà segnalata:


        

getShipment

getShipment permette di leggere lo stato di una spedizione tramite il tracking number, il riferimento ordine o l'ID.

Per una gestione totale ed integrata del ciclo di aggiornamento delle spedizioni valuta anche il Webhook.

🛈
Ricorda i limiti di utilizzo e di valutare anche il Webhook.
GEThttps://api.qapla.it/1.2/getShipment/?apiKey=[API_KEY]&trackingNumber=[TRACKING_NUMBER]
GEThttps://api.qapla.it/1.2/getShipment/?apiKey=[API_KEY]&reference=[ORDER_REFERENCE]
GEThttps://api.qapla.it/1.2/getShipment/?apiKey=[API_KEY]&id=[SHIPMENT_ID]
GEThttps://api.qapla.it/1.2/getShipment/?apiKey=[API_KEY]&custom1=[CUSTOM1]
Parametri
Parametro Descrizione
apiKey*(string) la API Key assegnata al canale che vogliamo interrogare
Parametri esclusivi
trackingNumber(string) il tracking number interessato
reference(string) il riferimento ordine
id(int) ID della spedizione
custom1, custom2, custom3(string) i campi custom1, custom2, custom3
Parametri opzionali
lang La lingua dei nomi degli stati Qapla' (it, en, es), default: it.

Esempio:

&lang=en
data

Il flag data specifica quali e quanti dati vogliamo ricevere, di default torna dei dati minimi sullo stato di avanzamento della spedizione.
Può avere i seguenti valori:

Parametro Descrizione
se non viene specificato nessun parametro verranno ritornati i dati minimi
all dati minimi + tutti i dati a seguire
consignee dati minimi + i dati del destinatario
children dati minimi + i dati delle spedizioni figlio, se esistenti
parent dati minimi + i dati della spedizione padre, se esistente
flag dati minimi + i dati relativi alla segnalazione della spedizione, se esistenti
notifications dati minimi + i dati delle notifiche (email sms, webhook, qaplAPP)
history dati minimi + la tracking history della spedizione
rows dati minimi + gli eventuali prodotti

Il parametro può essere combinato separato da virgole, ad esempio

&data=consignee,history
per ottenere solo questi dati.
Response Body200


            
Descrizione
result Il risultato dell'operazione: OK o KO in caso di errore
error L'errore in caso di result: KO
version La versione dell'API
lang La lingua richiesta / passata come parametro (default: it)
count Quante spedizioni sono presenti
shipments

È un array che può contenere più di una spedizione

id ID della spedizione
hash L'hash della spedizione, utilizzato per esempio dalla pagina di tracking
url Indirizzo della pagina di tracking di questa spedizione
reference Il riferimento ordine
trackingNumber Il tracking number
isDeleted è true (valore boolean) se la spedizione è cancellata
isArchived è true (valore boolean) se la spedizione è archiviata
origin L'origine della spedizione se caricata (es: magento, prestashop, amazon, ecc)
courier
code Codice del corriere
name Nome del corriere
icon URL dell'icona del corriere
note Eventuali note del corriere sulla spedizione
estimatedDeliveryDate Eventuale data stimata di prevista consegna
url L'indirizzo url del corriere
trackingURL L'indirizzo url del tracking del corriere per questa spedizione
status

Lo stato attuale della spedizione

date La data dello stato, come riportata dal corriere
dateISO La versione ISO YYYY-MM-DD HH:MM:SS della data comunicata dal corriere
status Lo stato comunicato dal corriere
place Il luogo comunicato dal corriere
qaplaStatus

La "traduzione" dello stato del corriere negli stati di Qapla'

id L'ID dello stato
status La decrizione
detailID L'ID dell'eventuale dettaglio
detail La descrizione dell'eventuale dettaglio
color Il colore assegnato da Qapla' allo stato
icon L'icona dello stato
dateUpd La data in cui lo stato della spedizione è stata aggiornata su Qapla'
lastCheck La data dell'ultimo controllo dello stato della spedizione
shipDate La data di spedizione comunicataci al caricamento della spedizione
orderDate La data dell'ordine comunicataci al caricamento della spedizione
dateIns La data di caricamento della spedizione
consignee

I dati del destinatario

name Nome del destinatario
address L'indirizzo del destinatario
city La città del destinatario
state La provincia del destinatario
country La nazione del destinatario
email L'email del destinatario
isAmazon È true (valore boolean) se la email del destinatario è di Amazon
phone Il telefono del destinatario
language La lingua in cui "parlerà" la spedizione quando verranno inviate notifiche come email o SMS
newTrackingNumber L'eventuale nuovo tracking number assegnato alla spedizione
oldTrackingNumber L'eventuale vecchio tracking number in caso venga popolato il campo newTrackingNumber
hasNewTrackingNumber È true (valore boolean) se la spedizione ha ottenuto un nuovo tracking number
isTrackingNumber È true (valore boolean) se il valore trackingNumber contiene il vero tracking number
trueTrackingNumber Contiene l'eventuale "vero" tracking number
altTrackingNumber Contiene un eventuale tracking number alternativo nel caso la spedizione lo abbia cambiato a parità di corriere in corso di viaggio
returnTrackingNumber Indica l'eventuale tracking number di ritorno se diverso da quello di andata
isReturnShipment È true (valore boolean) se la spedizione è una spedizione di reso / ritorno
isCOD È true (valore boolean) se la spedizione è in constrassegno
amountText L'importo testuale della spedizione
amount L'importo come numero float
isDelivered È true (valore boolean) se la spedizione è consegnata
isChild È true (valore boolean) se la spedizione è "figlia" di un'altra spedizione, in questo caso verrà popolato il campo "parent"
parent

La spedizione "padre"

id Id della spedizione
reference Il riferimento ordine della spedizione
trackingNumber Il tracking number ordine della spedizione
courier Il codice corriere della spedizione
url La URL a questa stessa API per richiamare la spedizione padre
hasChildren È true (valore boolean) se la spedizione ha dei "figli", in questo caso verrà popolato il campo "children"
children

È un array di spedizioni "child"

id Id della spedizione
reference Il riferimento ordine della spedizione
trackingNumber Il tracking number ordine della spedizione
courier Il codice corriere della spedizione
url La URL a questa stessa API per richiamare la spedizione
custom1 Il valore custom1 come importato
custom2 Il valore custom2 come importato
custom3 Il valore custom3 come importato
deliveryMode Può assumere i valori "home" per una consegna direttamente al destinatario o "pickup" per una consegna diretta ad un punto di ritiro (Pickup point)
hasFlag È true (valore boolean) se la spedizione è stata "segnalata", in questo caso viene popolato il campo "flag"
flag
Description La descrizione del flag
Note L'eventuale nota
notifications

Tutte le notifiche inviate per stato per questa spedizione. Ottenibile utilizzando il parametro data=notifications ed incluso se data=all

email

È un array di email inviate

result È OK se la email è andata a buon fine e KO in caso contrario
statusID Lo stato Qapla' per il quale è stata inviata la email
status La descrizione dello stato inviato
date La data di invio
error L'eventuale errore
isOpened È true (valore boolean) se la email è stata aperta / letta
sms

È un array di SMS inviati

result È OK se l'SMS è anadato a buon fine e KO in caso contrario
statusID Lo stato Qapla' per il quale è stato inviato l'SMS
status La descrizione dello stato inviato
date La data di invio
webhook

È un array di webhook inviate.

result È OK se la email è andata a buon fine e KO in caso contrario
statusID Lo stato Qapla' per il quale è stato inviato il webhook
status La descrizione dello stato inviato
date La data di invio
qaplAPP

È un array di notifiche inviate a qaplAPP

result È OK se la email è andata a buon fine e KO in caso contrario
statusID Lo stato Qapla' per il quale è stato inviato la notifica a qaplAPP
status La descrizione dello stato inviato
date La data di notifica
trackingHistory

È un array dei seguenti elementi

date La data dello stato come comunicata dal corriere
dateISO La versione ISO YYYY-MM-DD HH:MM:SS della data comunicata dal corriere
status Lo stato comunicato dal corriere
place Il luogo
qaplaStatus

La "traduzione" dello stato del corriere negli stati di Qapla'

id L'ID dello stato
status La decrizione
detailID L'ID dell'eventuale dettaglio
detail La descrizione dell'eventuale dettaglio
color Il colore assegnato da Qapla' allo stato
icon L'icona dello stato
Errori
In caso di errore il campo "result" conterrà "KO" ed il error la descrizione dell'errore.
{
"getShipment": {
    "result": "KO",
    "error": "[ERROR_MESSAGE]"
}
}

getShipments

getShipments permette di ricevere la lista delle spedizioni importate da Qapla' per data di inserimento, data di spedizione, data ordine.
GEThttps://api.qapla.it/1.2/getShipments/?apiKey=[API_KEY]&[DATE]
Parametri
ParametroDescrizione
apiKeyla API Key assegnata al canale che vogliamo interrogare
[DATE]*
shipDatedata spedizione in formato ISO 8601 "YYYY-MM-DD"
orderDatedata ordine in formato ISO 8601 "YYYY-MM-DD"
dateInsdata di caricamento in formato ISO 8601 "YYYY-MM-DD"
*Se nessun parametro viene valorizzato di default verrà utilizzato dateIns e la data corrente.
Response Body200


            
Descrizione
result(string) Il risultato dell'operazione: OK o KO in caso di errore
error(string) L'errore in caso di result: KO
version(string) La versione dell'API
search(string) Il parametro imputato come ricerca
count(int) Quante spedizioni sono presenti
shipments(array) È un array che può contenere più di una spedizione
id(int) ID numerico della spedizione
getShipment(string) La url alla API getShipment per questa spedizione
reference(string) Il riferimento ordine
trackingNumber(string) Il tracking number
isDeleted(bool) È true (valore boolean) se la spedizione è cancellata
isArchived(bool) È true (valore boolean) se la spedizione è archiviata
origin(string) Piattaforma di origine della spedizione
courier(string) Il codice corriere della spedizione
statusID(int) Lo stato Qapla' della spedizione
statusDetailID(int) Eventuale stato Qapla' di dettaglio
shipDate(string) Data di spedizione
orderDate(string) Data ordine
dateIns(string) Data di caricmaneto su Qapla'
language(string) Linguaggio della spedizione
custom1(string) Valore custom1
custom2(string) Valore custom2
custom3(string) Valore custom3
Errori

        

updateShipment

updateShipment permette di aggiornare una spedizione.
PUThttps://api.qapla.it/1.2/updateShipment/


            
Parametri

Si inviano gli stessi parametri della pushShipment tenendo conto che la chiave primaria è composta da

  • trackingNumber
  • courier
Response Body200

        

deleteShipment

deleteShipment permette di eliminare una spedizione.
DELETEhttps://api.qapla.it/1.2/deleteShipment/


            
Parametri
Parametro Descrizione
apiKey*(string) la API Key assegnata al canale che vogliamo interrogare
courier*(string) il codice corriere della spedizione
trackingNumber*(string) il tracking number della spedizione
Response Body200

        

undeleteShipment

undeleteShipment permette di ripristinare una spedizione.
PATCHhttps://api.qapla.it/1.2/undeleteShipment/


            
Parametri
Parametro Descrizione
apiKey*(string) la API Key assegnata al canale che vogliamo interrogare
courier*(string) il codice corriere della spedizione
trackingNumber*(string) il tracking number della spedizione
Response Body200

        

trackingByTimeFrame

trackingByTimeFrame permette di ottenere l'elenco delle spedizioni che hanno subito un aggiornamento dello stato del tracking compreso nel timeframe dateFrom / dateTo.
GEThttps://api.qapla.it/1.2/trackingByTimeFrame/
Parametri
Parametro Descrizione
apiKey*(string) la API Key assegnata al canale che vogliamo interrogare
Parametri opzionali
dateFrom(timestamp) default: un'ora fa. In formato ISO 8601 "yyyy-mm-dd hh:mm:ss"
dateTo(timestamp) in formato ISO 8601 "yyyy-mm-dd hh:mm:ss"
lang La lingua dei nomi degli stati Qapla' (it, en, es), default: it.

Esempio:

&lang=en
Response Body200


            
Descrizione
result Il risultato dell'operazione: OK o KO in caso di errore
error L'errore in caso di result: KO
version La versione dell'API
lang La lingua richiesta / passata come parametro (default: it)
count Quante spedizioni sono presenti
shipments La descrizione della spedizione

Ordini

La chiave primaria per identificare un ordine è:

L'aggiornamento di un ordine avviene se durante una pushOrder, la data di aggiornamento "updatedAt" è maggiore di quella registrata.

pushOrder

pushOrder permette di caricare uno o più ordini tramite una POST dei dati in formato JSON.
POSThttps://api.qapla.it/1.2/pushOrder/


            
Parametri

*Parametro obbligatorio


Il numero massimo di ordini inviabile per ogni singola request è 100.
apiKey*(string) La API Key assegnata al canale che vogliamo interrogare
origin(string) Origine dell'ordine, valori ammessi:
amazon, carrefour_es, cdiscount, ebay, ecwid, eprice, ibs, magento, magento2, manomano_de, manomano_es, manomano_fr, manomano_gb, manomano_it, prestashop, privalia_es, privalia_it, shopify, spartoo_be, spartoo_cn, spartoo_de, spartoo_es, spartoo_fr, spartoo_gb, spartoo_gr, spartoo_it, spartoo_nl, spartoo_pl, spartoo_pt, storeden, vtex, woocommerce, worten_es, worten_pt, mediaMarkt_de
pushOrder(array)

È un array di massimo 100 ordini da caricare.

reference*(string) Il riferimento alfanumerico dell'ordine
orderID(int) Eventuale riferimento numerico dell'ordine
courier(string) Il codice corriere di Qapla'
courierService*(string) Eventuale tipo del servizio del corriere; per esempio può essere il codice contratto di GLS Italy
status(string) Lo stato dell'ordine (processing, complete, ecc)
createdAt*(YYYY-MM-DD HH:MM:S) Data di creazione ordine
updatedAt*(YYYY-MM-DD HH:MM:SS) Data di aggiornamento ordine.
Attenzione
Questa data viene usata per stabilire se aggiornare l'ordine su Qapla', ovvero se l'ordine è stato già importato da Qapla'. Un valore più recente di questo campo farà sì che Qapla' lo consideri come "ordine aggiornato" e quindi aggiorni tutti i dati precedentemente importati.
name*(string) Nome del destinatario
street*(string) Indirizzo del destinatario
city*(string) Città del destinatario
state*(string) Provincia del destinatario
postCode*(string) CAP del destinatario
country*(string) La nazione del destinatario in formato ISO 3166-1 alpha-2 (Esempio: IT)
email(string) Email del destinatario
telephone(string) Telefono del destinatario
amount(float) Importo della spedizione
currencyCode(string) Codice valuta ISO 4217 (default: EUR)
payment Tipo di pagamento
isCOD(boolean) È true se il pagamento è in contrassegno
notes(string) Eventuali note dell'ordine
weight(float) Eventuale peso dell'ordine
parcels(int) Eventuali colli dell'ordine
length(float) Eventuali misure: lunghezza
width(float) Eventuali misure: profondità
height(float) Eventuali misure: altezza
isReturnable(bool) Se è true indica la possibilità di reso dell'intero ordine.
shippingCODPaymentOption(string) La modalità di pagamento dell'eventuale contrassegno se diversa dalle impostazioni di default (da concordarsi)
shippingInsurance(float)

Eventuale importo assicurato

ALL-IN: valorizzare il campo "shippingDeliveryOptions" inserendo la stringa: ALLIN

Per la generazione diretta con SDA, il valore va passato sotto forma di stringa, specificando uno dei seguenti codici:

Codice Tipo di assicurazione
Se non viene specificato nessun parametro, non verrà indicato alcun tipo di assicurazione
AS01 FINO A EURO 258,23
AS02 FINO A EURO 516,46
AS03 FINO A EURO 1.549,37
AS04 FINO A EURO 2.582,28
AS05 ASSICURATA INTERNAZIONALE FINO A EURO 1.500,00i
AS12 ASSICURATA ROAD EUROPE
AS13 ASSICURATA EXPORT BOX
shippingDeliveryOptions(string | JSON)



In caso si vogliano utilizzare due valori, questi devono essere separati da virgola
Esempio: A,P oppure 22,07

Per il corriere PTI bisogna usare un JSON strutturato come i seguenti esempi


                                                
shippingRequiredDeliveryDate(YYYY-MM-DD) La data in formato YYYY-MM-DD di richiesta consegna
pickUpDate(YYYY-MM-DD) La data in formato YYYY-MM-DD di ritiro richiesta al corriere
custom1,1,3(string) Eventuali campi custom
pickupPoint(string) Eventuale codice di un pickup point
content(string) Il contenuto della merce che potrà essere presente sull'etichetta(dipende dal corriere)
rows(array)

È un array di "righe ordine".

Non è obbligatorio, ma se popolato ha alcuni dati che lo sono.

sku*(string) Codice articolo
name*(string) Descrizione articolo
qty*(int) Quantità
price*(string) Prezzo
total(string) Prezzo totale
weight(float) Eventuale peso dell'articolo
url(float) La url specifica del prodotto
imageUrl(string) La url dell'immagine del prodotto
notes(string) Eventuale note prodotto
assemblyTypes(array)

Eventuale elenco di tipologie di montaggio, una per prodotto, per i corrieri che supportano questa informazioni

code*(string) Il codice della tipologia di montaggio scelta

Disponibile per il "courierService" 20 (HD). Deve essere specificato un elemento per ogni elemento di rows.

I valori disponibili per "code":

Code Descrizione
5 Attivazione Elettrodomestici
09 Incasso forni/piano cottura con dichiaraz. Conf.
08 Incasso frigoriferi
07 Incasso lavastoviglie e lavatrici
11 Install. Clima DUAL con tubazione da predisporre
14 Install. Clima DUAL con tubazione già predisposta
10 Install. Clima MONO con tubazione da predisporre
13 Install. Clima MONO con tubazione già predisposta
12 Install. Clima TRIAL con tubazione da predisporre
15 Install. Clima TRIAL con tubazione già predisposta
K Installazione base HD
Z Installazione complessa HD
Y Installazione media HD
W Installazione semplice HD
06 Installazione TV a muro
20 Montaggio 30
17 Montaggio Cyclette
18 Montaggio Ellittica
4 Montaggio Strutture Multifunzione
16 Montaggio Tapis Roulant
1 Montaggio Tapis-Cyclette-Ellittica
2 Montaggio Tavoli Ping-Pong
3 Montaggio Vogatori
sender

È il mittente della spedizione se diverso dall'intestatario del contratto.

code*(string) Il codice da assegnare al mittente per una migliore identificazione
businessName(string) Ragione sociale
street(string) Indirizzo
city(string) Città
state(string) Provincia
postCode(string) CAP
country(string) Nazione in formato ISO 3166-1 alpha-2 (Esempio: IT)
email(string) Email del mittente
telephone(string) Telefono del mittente
referent(string) Referente del mittente
isDefault(bool) È true se il mittente verrà salvato come default per tutte le altre spedizioni
PUDO(object)

Permette di impostare un punto di Pick-up o Drop-off del ritiro della merce. Ogni campo va compilato in base alla necessità del corriere. Far riferimento alle tabelle poco sotto

id*(string) Identificativo del PUDO
type(string) Tipologia Servizio
name(string) Nome del servizio
address(string) Indirizzo del punto di Pick-up o Drop-off
city(string) Città del punto Pick-up o Drop-off
state(string) Provincia del punto di Pick-up o Drop-off
country(string) Nazione del punto di Pick-up o Drop-off
postalCode(string) CAP del punto di Pick-up o Drop-off
description(string) Descrizione
harmonisedId(string) Id numerico aggiuntivo del punto di Pick-up o Drop-off, ricavabile dalla getPudos. Es. 104
keyword(string) Keyword del punto di Pick-up o Drop-off, ricavabile dalla getPudos. Es 'DHL Servicepoint'
psfKey(string) PsfKey del punto di Pick-up o Drop-off, ricavabile dalla getPudos. Es 'ES-0004240'
postnumber(string) Postnumber del punto di Pick-up o Drop-off, se di tipo 'packstation'. E' un codice che il cliente finale possiede personalmente
DHL / BRT / INPOST / FEDEX
Attributo Valore
id*(string) Codice o identificativo del PUDO
TNT ITA / GLS-ITA
Attributo Valore
id*(string) Valori possibili:
  • TNT: Codice identificativo del TNT point/Locker;
  • GLS-IT: Codice identificativo chiamato SHOP_ID;
type*(string) Valori possibili:
  • TNT: 3 (TNT point) o 5 (TNT Locker);
  • GLS-IT: Codice identificativo chiamato PARTNER_SHOP_ID;
PTI(Poste Italiane)
Attributo Valore
id*(string) Codice o identificativo del PUDO
type*(string) Valori possibili:
  • ConsegnaPuntoPoste
  • ConsegnaUfficioPostale
  • ConsegnaLocker
  • ConsegnaPUDOUPS
name*(string) Nome del PUDO
UPS
Attributo Valore
id*(string) Codice o identificativo
address*(string) Indirizzo
city*(string) Città
country*(string) Nazione
name*(string) Name
postalCode*(string) CAP
state*(string) Provincia
SDA
Attributo Valore
id*(string) Codice o identificativo
address*(string) Indirizzo
city*(string) Città
name*(string) Nome
postalCode*(string) CAP
state*(string) Provincia
DHLPARCEL-ES
Attributo Valore
id*(string) Codice o identificativo
address*(string) Indirizzo
city*(string) Città
country*(string) Nazione
postalCode*(string) CAP
harmonisedId*(string) Harmonized Id
keyword*(string) Keyword
psfKey*(string) PsfKey
postnumber(string) PostNumber
invoice(object)

Permette di impostare le informazioni relative alla fattura associata alla spedizione, utile per le spedizioni che devono passare la dogana.
Obbligatorio per DHL

number*(string) Numero della fattura
Response Body200


            
Descrizione
version(string) Il numero di versione di questa API
result(string) È "OK" se la trasmissione è andata a buon fine, "KO" in caso di errore
error(string) L'eventuale messaggio di errore in caso di result "KO"
count(int) Quanti ordini inviati nella richiesta
orders(array)

È un array che corrisponde al numero di ordini inviati nella richiesta.

row(int) Numero di riga
reference(string) Il riferimento dell'ordine inviato nella richiesta
orderID(int) L'eventuale id numerico dell'ordine inviato nella richiesta
action(string) Prevede i seguenti valori:
  • imp: ordine importato
  • upd: ordine aggiornato
  • del: ordine cancellato
  • skp: nessuna azione intrapresa
  • ext: ordine già esistente
  • err: segnala un errore
error(string) L'eventuale errore nel caricamento di questo ordine
imported(int) Contatore degli ordini importati
updated(int) Contatore degli ordini aggiornati
deleted(int) Contatore degli ordini cancellati
skipped(int) Contatore degli ordini saltati
existing(int) Contatore degli ordini già esistenti
Errori
Il messaggio di errore viene riportato nel campo "error".

        

getOrder

getOrder permette di recuperare un ordine.
GEThttps://api.qapla.it/1.2/getOrder/?apiKey=[API_KEY]&reference=[ORDER_REFERENCE]
Parametri
Parametro Descrizione
apiKey*(string) la API Key assegnata al canale che vogliamo interrogare
reference*(string) il riferimento ordine
Response Body200

        

getOrders

getOrders permette di ricevere la lista degli ordini importati da Qapla'.
GEThttps://api.qapla.it/1.2/getOrders/?apiKey=[API_KEY]&[DATE]
Parametri
Parametro Descrizione
apiKey*(string) la API Key assegnata al canale che vogliamo interrogare
[DATE]
updatedAt data aggiornamento ordine in formato ISO 8601 "YYYY-MM-DD"
createdAt data ordine in formato ISO 8601 "YYYY-MM-DD"
dateIns data di caricamento in formato ISO 8601 "YYYY-MM-DD"
dateFrom / dateTo forbice di date per il valore "updatedAt" in formato ISO 8601 "yyyy-mm-dd hh:mm:ss"
Se non viene passato nessun parametro [DATE] il default è dateFrom = 1 ora fa alle 00.
Response Body200

        

deleteOrder

deleteOrder permette di eliminare un ordine.
DELETEhttps://api.qapla.it/1.2/deleteOrder/


            
Parametri
Parametro Descrizione
apiKey*(string) la API Key assegnata al canale che vogliamo interrogare
reference*(string) il riferimento ordine
Response Body200

        

updateOrder

updateOrder è sopperita dall' impostazione pushOrder e si utilizza il parametro updatedAt per stabilire se l'ordine debba essere aggiornato.
updatedAt*(YYYY-MM-DD HH:MM:SS) Data di aggiornamento ordine.
Attenzione
Questa data viene usata per stabilire se aggiornare l'ordine su Qapla', ovvero se l'ordine è stato già importato da Qapla'. Un valore più recente di questo campo farà sì che Qapla' lo consideri come "ordine aggiornato" e quindi aggiorni tutti i dati precedentemente importati.

undeleteOrder

undeleteOrder permette di ripristinare un ordine eliminato.
PATCHhttps://api.qapla.it/1.2/undeleteOrder/


            
Parametri
Parametro Descrizione
apiKey*(string) la API Key assegnata al canale che vogliamo interrogare
reference*(string) il riferimento ordine
Response Body200

        

detectOrderCourier

Attenzione
Questa API è attualmente in test. Richiedere l'attivazione al Customer Care.
detectOrderCourier permette di ottenere il corriere da assegnare all'ordine, seguendo regole preimpostate (impostazioni da configurare sul Control Panel).

Utile prima di una createLabel per identificare preventivamente il corriere da utilizzare.

È basata su 3 regole per identificare il corriere in base a peso, eventuale importo in contrassegno ed il CAP di destinazione.

Se si è in possesso di chiare regole come ad esempio le seguenti:

PesoCODCAP
minore o uguale a 3KgGLS
maggiore di 3Kgminore di 100€BRT
maggiore di 3Kgmaggiore di 100€minore di 70000 (nord)GLS
maggiore di 3Kgmaggiore di 100€maggiore di 70000 (sud)BRT

è possibile predeterminare e preassegnare il corriere all'ordine prima che l'etichetta venga creata, ad esempio con la createLabel.

POSThttps://api.qapla.it/1.2/detectOrderCourier/
Request


            
Parametri

*Parametro obbligatorio

Parametro Descrizione
apiKey*(string) La API Key del canale
country*(string) La nazione del destinatario in formato ISO 3166-1 alpha-2 (Esempio: IT)
weight*(float) Eventuale peso dell'ordine
cod(float) Importo della spedizione, se la spedizione è in constrassegno
postCode(string) CAP del destinatario
Response Body200


            
Parametro Descrizione
courier(json) Contiene id, codice e nome del corriere identificato
rule(json) Contiene id, e nome della regola identificata
request(json) I parametri della request
Errori
In caso di errore il campo "result" conterrà "KO" ed il campo "error" la descrizione dell'errore.

Platforms

Una serie di tool per colloquiare direttamente con la propria piattaforma / marketplace già configurata sul canale, senza passare da Qapla'

fetchPlatformOrders

fetchPlatformOrders permette di ricevere la lista degli ordini presenti su una platform.
GEThttps://api.qapla.it/1.2/fetchPlatformOrders/?apiKey=[API_KEY]&platform=[PLATFORM]&orderformat=[ORDERFORMAT]&skip
Parametri
Parametro Descrizione
apiKey*(string) La API Key assegnata al canale che vogliamo interrogare
platform(string) La platform associata, per esempio un marketplace. Se non viene indicata, viene considerata la platform associata al canale.
Valori ammessi:
amazon, carrefour, cdiscount, ebay, ecwid, eprice, ibs, magento, magento2, manomano, prestashop, privalia, shopify, spartoo, storeden, vtex, woocommerce, worten, leroymerlin, greenweez, maisondumonde, mediamarkt
dateFrom / dateTo(timestamp) Forbice di date per il valore "updatedAt" in formato ISO 8601 "yyyy-mm-dd hh:mm:ss"
orderFormat(string) Se viene passato il valore (platform) verranno restituiti gli ordini in formato originale. Nel caso in cui non venga passato alcun valore i risultati verranno restituiti in formato standard (qapla).
skip(string) Se viene passato il parametro &skip (senza un valore) gli ordini verranno analizzati e saltati in caso lo stato ordine sia indicato come tra quelli da non considerare.
Response Body200


            
Errori
In caso di errore il campo "result" conterrà "KO" ed il error la descrizione dell'errore.
{
"fetchPlatformOrders": {
    "result": "KO",
    "error": "[ERROR_MESSAGE]"
}
}

updatePlatformOrder

updatePlatformOrder permette di aggiornare gli ordini presenti su una platform.
PUThttps://api.qapla.it/1.2/updatePlatformOrder/


            
Autenticazione

L'autenticazione avviene tramite l'apiKey del canale, passando Q-API-Key nell'header della request

Parametro Descrizione
Q-API-Key*(string) L' API Key del canale.
Parametri
Parametro Descrizione
platform*(string) La platform associata, per esempio un marketplace. Se non viene indicata, viene considerata la platform associata al canale.
Valori ammessi:
magento, magento2, prestashop, shopify, woocommerce, amazon, ibs, manomano, spartoo, carrefour, leroymerlin, greenweez, maisondumonde, mediamarkt
reference(string) Il riferimento alfanumerico dell'ordine. Da inserire, se richiesto, in base alla platform specifica utilizzata.
orderID(int) Riferimento numerico dell'ordine. Da inserire, se richiesto, in base alla platform specifica utilizzata.
courier*(string) Il codice corriere di Qapla'
trackingNumber*(string) Il tracking number dell'ordine da aggiornare
setShipped(bool) E' true se è impostata la spedizione. Da utilizzare a seconda delle peculiarità della platform utilizzata.
setDelivered(bool) E' true se è impostata la consegna. Da utilizzare a seconda delle peculiarità della platform utilizzata.
storeCode(string) Il codice nazione in formato iso 2 del marketplace. (se richiesto)
Response Body200

        

Etichette

createLabel

createLabel permette di creare una etichetta in formato PDF o ZPL (impostazioni da configurare sul Control Panel).
Attenzione
Richiedere l'attivazione al Customer Care.
POSThttps://api.qapla.it/1.3/createLabel/
Test
È possibile ottenere una "dummy label" di test utilizzando il corriere avente codice GENERIC.
Request

            
Parametri

*Parametro obbligatorio

Parametro Descrizione
apiKey*(string) La API Key del canale
sandbox(boolean) È true se si vuole utilizzare la sandbox (modalità test)
Attenzione: questo parametro funziona se il corriere è già stato correttamente impostato sul canale.
Rivolgersi al Customer Care di Qapla'.
origin(string) Origine della spedizione, valori ammessi:
amazon, carrefour_es, cdiscount, ebay, ecwid, eprice, ibs, magento, magento2, manomano_de, manomano_es, manomano_fr, manomano_gb, manomano_it, prestashop, privalia_es, privalia_it, shopify, spartoo_be, spartoo_cn, spartoo_de, spartoo_es, spartoo_fr, spartoo_gb, spartoo_gr, spartoo_it, spartoo_nl, spartoo_pl, spartoo_pt, storeden, vtex, woocommerce, worten_es, worten_pt, mediaMarkt_de
reference*(string) Il riferimento alfanumerico dell'ordine
orderID(string) Eventuale riferimento numerico dell'ordine
courier*(string) Il codice corriere di Qapla'
courierService*(string) Eventuale tipo del servizio del corriere; per esempio può essere il codice contratto di GLS Italy
name*(string) Nome del destinatario
address*(string) Indirizzo del destinatario
city*(string) Città del destinatario
state*(string) Provincia del destinatario
postCode*(string) CAP del destinatario
country*(string) La nazione del destinatario in formato ISO 3166-1 alpha-2 (Esempio: IT)
email(string) Email del destinatario
telephone(string) Telefono del destinatario
amount(float) Importo della spedizione
isCOD(boolean) È true se il pagamento è in constrassegno
payment(string) Eventuale metodo di pagamento dell'ordine. Può essere impostato su CONTRASSEGNO solo se anche isCOD è impostato a true
notes(string) Eventuali note dell'ordine
weight(float) Eventuale peso dell'ordine
parcels(int) Eventuali colli dell'ordine
length(float) Eventuali misure: lunghezza
width(float) Eventuali misure: profondità
height(float) Eventuali misure: altezza
shippingCODPaymentOption(string) La modalità di pagamento dell'eventuale contrassegno se diversa dalle impostazioni di default (da concordarsi)
shippingInsurance(float)

Eventuale importo assicurato

ALL-IN: valorizzare il campo "shippingDeliveryOptions" inserendo la stringa: ALLIN

Per la generazione diretta con SDA, il valore va passato sotto forma di stringa, specificando uno dei seguenti codici:

Codice Tipo di assicurazione
Se non viene specificato nessun parametro, non verrà indicato alcun tipo di assicurazione
AS01 FINO A EURO 258,23
AS02 FINO A EURO 516,46
AS03 FINO A EURO 1.549,37
AS04 FINO A EURO 2.582,28
AS05 ASSICURATA INTERNAZIONALE FINO A EURO 1.500,00i
AS12 ASSICURATA ROAD EUROPE
AS13 ASSICURATA EXPORT BOX
shippingDeliveryOptions(string | JSON)



In caso si vogliano utilizzare due valori, questi devono essere separati da virgola
Esempio: A,P oppure 22,07

Per il corriere PTI bisogna usare un JSON strutturato come i seguenti esempi


                                    
shippingRequiredDeliveryDate(YYYY-MM-DD) La data in formato YYYY-MM-DD di richiesta consegna
pickupDate(YYYY-MM-DD) La data in formato YYYY-MM-DD di ritiro richiesta al corriere

Per il corriere SDA, se questo campo non viene specificato in fase di creazione dell'etichetta, in fase di trasmissione verrà automaticamente assegnato il giorno lavorativo successivo a quello della trasmissione
gSpedPrinterID(int) Eventuale id stampante (user_id) per la Labeling Machine di Gsped (da concordarsi)
printNodePrinterID(int | string) Eventuale id o nome della stampante da utilizzare con PrintNode (da concordarsi)
forceReprint(int) Se impostato a 1 forza nuovamente la stampa dell'etichetta tramite PrintNode; valido se utilizzato con "printNodePrinterID"
content(string) Il contenuto della merce che potrà essere presente sull'etichetta(dipende dal corriere)
custom1(string) Campo personalizzato
custom2(string) Campo personalizzato
custom3(string) Campo personalizzato
sender

È il mittente della spedizione se diverso dall'intestatario del contratto.

Attenzione
Se il mittente è gia stato creato sul Control Panel o già inviato precedentemente questo viene codificato e sarà sufficiente inviare il solo codice.
"sender": "codicedelsender"
code*(string) Il codice da assegnare al mittente per una migliore identificazione
businessName(string) Ragione sociale
street(string) Indirizzo
city(string) Città
state(string) Provincia
postCode(string) CAP
country(string) Nazione in formato ISO 3166-1 alpha-2 (Esempio: IT)
email(string) Email del mittente
telephone(string) Telefono del mittente
referent(string) Referente del mittente
isDefault(bool) È true se il mittente verrà salvato come default per tutte le altre spedizioni
tradeDocuments(array)

Documenti elettronici da trasmettere al corriere. È possibile caricare più di un file per spedizione. Il peso massimo di ogni file è 5 MB.

Per il momento disponibile solo per i corrieri DHL, FedEx e UPS.

Trasmesso come un array di oggetti, con tre elementi obbligatori ciascuno:
type(string) Il tipo del file, che varia a seconda del corriere (vedi tabella)
name(string) Il nome del file
content(string) Contenuto del file in codifica base64
  FEDEX DHL UPS
AUTHORIZATION_FORM  
CERTIFICATE_OF_ORIGIN
COMMERCIAL_INVOICE
DECLARATION  
EXPORT_ACCOMPANYING_DOCUMENT  
EXPORT_LICENSE  
IMPORT_PERMIT  
NAFTA_CERTIFICATE_OF_ORIGIN  
ONE_TIME_NAFTA  
OTHER
OTHER_DOCUMENT  
PACKING_LIST  
POWER_OF_ATTORNEY  
PRO_FORMA_INVOICE  
SED_DOCUMENT  
SHIPPER_LETTER_OF_INSTRUCTION  
rows(array)

È un array di "righe ordine".

Non è obbligatorio, ma se popolato ha alcuni dati che lo sono.

sku*(string) Codice articolo
name*(string) Descrizione articolo
qty*(int) Quantità
price*(string) Prezzo
total(string) Prezzo totale
weight(float) Eventuale peso dell'articolo
url(float) La url specifica del prodotto
imageUrl(string) La url dell'immagine del prodotto
notes(string) Eventuale note prodotto
isReturnable(bool) Prodotto abilitato per il reso. Se non impostato è true
assemblyTypes(array)

Eventuale elenco di tipologie di montaggio, una per prodotto, per i corrieri che supportano questa informazioni

code*(string) Il codice della tipologia di montaggio scelta

Disponibile per il "courierService" 20 (HD). Deve essere specificato un elemento per ogni elemento di rows.

I valori disponibili per "code":

Code Descrizione
5 Attivazione Elettrodomestici
09 Incasso forni/piano cottura con dichiaraz. Conf.
08 Incasso frigoriferi
07 Incasso lavastoviglie e lavatrici
11 Install. Clima DUAL con tubazione da predisporre
14 Install. Clima DUAL con tubazione già predisposta
10 Install. Clima MONO con tubazione da predisporre
13 Install. Clima MONO con tubazione già predisposta
12 Install. Clima TRIAL con tubazione da predisporre
15 Install. Clima TRIAL con tubazione già predisposta
K Installazione base HD
Z Installazione complessa HD
Y Installazione media HD
W Installazione semplice HD
06 Installazione TV a muro
20 Montaggio 30
17 Montaggio Cyclette
18 Montaggio Ellittica
4 Montaggio Strutture Multifunzione
16 Montaggio Tapis Roulant
1 Montaggio Tapis-Cyclette-Ellittica
2 Montaggio Tavoli Ping-Pong
3 Montaggio Vogatori
PUDO(object)

Permette di impostare un punto di Pick-up o Drop-off del ritiro della merce. Ogni campo va compilato in base alla necessità del corriere. Far riferimento alle tabelle poco sotto

id*(string) Identificativo del PUDO
type(string) Tipologia Servizio
name(string) Nome del servizio
address(string) Indirizzo del punto di Pick-up o Drop-off
city(string) Città del punto Pick-up o Drop-off
state(string) Provincia del punto di Pick-up o Drop-off
country(string) Nazione del punto di Pick-up o Drop-off
postalCode(string) CAP del punto di Pick-up o Drop-off
description(string) Descrizione
harmonisedId(string) Id numerico aggiuntivo del punto di Pick-up o Drop-off, ricavabile dalla getPudos. Es. 104
keyword(string) Keyword del punto di Pick-up o Drop-off, ricavabile dalla getPudos. Es 'DHL Servicepoint'
psfKey(string) PsfKey del punto di Pick-up o Drop-off, ricavabile dalla getPudos. Es 'ES-0004240'
postnumber(string) Postnumber del punto di Pick-up o Drop-off, se di tipo 'packstation'. E' un codice che il cliente finale possiede personalmente
DHL / BRT / INPOST / FEDEX
Attributo Valore
id*(string) Codice o identificativo del PUDO
TNT ITA / GLS-ITA
Attributo Valore
id*(string) Valori possibili:
  • TNT: Codice identificativo del TNT point/Locker;
  • GLS-IT: Codice identificativo chiamato SHOP_ID;
type*(string) Valori possibili:
  • TNT: 3 (TNT point) o 5 (TNT Locker);
  • GLS-IT: Codice identificativo chiamato PARTNER_SHOP_ID;
PTI(Poste Italiane)
Attributo Valore
id*(string) Codice o identificativo del PUDO
type*(string) Valori possibili:
  • ConsegnaPuntoPoste
  • ConsegnaUfficioPostale
  • ConsegnaLocker
  • ConsegnaPUDOUPS
name*(string) Nome del PUDO
UPS
Attributo Valore
id*(string) Codice o identificativo
address*(string) Indirizzo
city*(string) Città
country*(string) Nazione
name*(string) Name
postalCode*(string) CAP
state*(string) Provincia
SDA
Attributo Valore
id*(string) Codice o identificativo
address*(string) Indirizzo
city*(string) Città
name*(string) Nome
postalCode*(string) CAP
state*(string) Provincia
DHLPARCEL-ES
Attributo Valore
id*(string) Codice o identificativo
address*(string) Indirizzo
city*(string) Città
country*(string) Nazione
postalCode*(string) CAP
harmonisedId*(string) Harmonized Id
keyword*(string) Keyword
psfKey*(string) PsfKey
postnumber(string) PostNumber
invoice(object)

Permette di impostare le informazioni relative alla fattura associata alla spedizione, utile per le spedizioni che devono passare la dogana.
Obbligatorio per DHL

number*(string) Numero della fattura
dangerousGoods(JSON)

Per il corriere FEDEX bisogna usare un JSON strutturato come segue

parcel: rappresenta il numero del parcel che contiene i dangerous good (nell'esempio una spedizione con 3 parcels di cui solo il primo e il terzo contengono dangerous goods)

type: battery

batteryPackingType: può assumere 2 valori

  • CONTAINED_IN_EQUIPMENT
  • PACKED_WITH_EQUIPMENT
batteryMaterialType: può assumere 2 valori
  • LITHIUM_METAL
  • LITHIUM_ION

                                    
Response Body200

            
Parametro Descrizione
isShipped(boolean) È true se l'ordine è già stato etichettato e restituisce l'etichetta già creata.
id(int) L'id della spedizione. Importante per invocare altre API.
trackingNumber(string) Il tracking number della spedizione.
returnTrackingNumber(string) Se richiesta etichetta di reso contestuale
format(string) Il formato dell'etichetta
  • PDF (base64)
  • JPG (base64)
  • ZPL
labels(array) Un array con il base64 delle etichette ottenute (potrebbero esserci più etichette per più colli o resi, ecc.).

Oppure

Lo ZPL per la stampa su Zebra, come configurato sul Control Panel.
Errori
In caso di errore il campo "result" conterrà "KO" ed il campo "error" la descrizione dell'errore.

deleteLabel

deleteLabel permette di eliminare un'etichetta creata con createLabel.
Attenzione
Questa API è attualmente in test. Richiedere l'attivazione al Customer Care.
DELETEhttps://api.qapla.it/1.2/deleteLabel/

            
Parametri
Parametro Descrizione
apiKey*(string) la API Key assegnata al canale che vogliamo interrogare
id*(int) L'id dell'etichetta tornato da createLabel
Response Body200

        

getLabel

getLabel permette scaricare un'etichettta precedentemente creata su Qapla' nel formato originale del corriere (PDF, JPG o ZPL).

Attenzione: la getLabel NON funziona con le dummy label create con il corriere GENERIC (anche con la createLabel).

GEThttps://api.qapla.it/1.2/getLabel/?apiKey=[API_KEY]&trackingNumber=[TRACKING_NUMBER]
GEThttps://api.qapla.it/1.2/getLabel/?apiKey=[API_KEY]&reference=[ORDER_REFERENCE]
GEThttps://api.qapla.it/1.2/getLabel/?apiKey=[API_KEY]&id=[SHIPMENT_ID]
Parametri
Parametro Descrizione
apiKey*(string) la API Key assegnata al canale che vogliamo interrogare
Parametri esclusivi
trackingNumber(string) il tracking number interessato
reference(string) il riferimento ordine
parcel(int) Il numero del collo (default = 1) - Disponibile solo per le etichette in formato PDF
id(int) l'id della spedizione
json(string) se passato (es: &json) forza la response come JSON
getReturnLabel(string) se passato (es: &getReturnLabel) restituisce l'etichetta di reso contestuale
Response Body200
L'etichetta con il corretto content type (JPG, PDF o testo per la ZPL)

Oppure, se usato il parametro &json



            
Errori
In caso di errore il campo "result" conterrà "KO" ed il error la descrizione dell'errore.

confirmLabel

confirmLabel permette di confermare e trasmettere al corriere le etichette create con createLabel e di ottenere la Distinta di carico (borderò/manifest) in formato PDF .
Attenzione
Richiedere l'attivazione al Customer Care.
POSThttps://api.qapla.it/1.2/confirmLabel/
Request


            
Parametri
Attenzione Utilizzare "labelCreationDate" oppure "labelID".

*Parametro obbligatorio

Parametro Descrizione
apiKey*(string) La API Key del canale
courier*(string) Il codice corriere di Qapla'
labelCreationDate*(date) La data della creazione etichette in formato ISO 8601 "YYYY-MM-DD"
labelID*(array) Un array degli ID delle spedizioni ottenuto con createLabel
Response Body200


            
Parametro Descrizione
courier(string) Il codice del corriere
number(string) Il numero della conferma
date(string) La data di conferma
shipments(int) Il numero di spedizioni confermate
manifest(string) Il manifest in PDF codificato Base&4
Errori
In caso di errore il campo "result" conterrà "KO" ed il campo "error" la descrizione dell'errore.

Corrieri

getCouriers

getCouriers permette di richiedere l'elenco dei corrieri sia totale, sia per singola nazione /ragione.
GEThttps://api.qapla.it/1.2/getCouriers/?apiKey=[API_KEY]&country=[COUNTRY_LIST]&code=[COURIER_CODE]
Parametri
Parametro Descrizione
apiKey la API Key assegnata al canale che vogliamo interrogare
Parametri opzionali
country vuoto per tutti i corrieri, o un elenco di valori nazione separati da virgola
country=it,fr,global
I valori disponibili sono:
AustriaatAustria
BelgiobeBelgio
SvizzerachSvizzera
CinacnCina
CiprocyCipro
Repubblica CecaczRepubblica Ceca
GermaniadeGermania
DanimarcadkDanimarca
EstoniaeeEstonia
SpagnaesSpagna
eu
FinlandiafiFinlandia
FranciafrFrancia
Regno UnitogbRegno Unito
global
GreciagrGrecia
Hong KonghkHong Kong
CroaziahrCroazia
UngheriahuUngheria
IrlandaieIrlanda
ItaliaitItalia
Corea del SudkrCorea del Sud
LituanialtLituania
LettonialvLettonia
MaltamtMalta
MalaysiamyMalaysia
Paesi BassinlPaesi Bassi
PoloniaplPolonia
PortogalloptPortogallo
RussiaruRussia
SveziaseSvezia
SloveniasiSlovenia
USAusUSA
Sud AfricazaSud Africa
code Il codice Qapla' del corriere
code=BRT
Response Body200
Il seguente URL
GEThttps://api.qapla.it/1.2/getCouriers/?apiKey=[API_KEY]&country=global
darà come risultato:

        

detectCourier

detectCourier cerca di determinare il corriere dal tracking number fornito, rispondendo con un elenco di corrieri.
GEThttps://api.qapla.it/1.2/detectCourier/?apiKey=[API_KEY]&trackingNumber=[TRACKING_NUMBER]
Parametri
Parametro Descrizione
apiKey la API Key assegnata al canale che vogliamo interrogare
trackingNumber Il tracking number da identificare
Response Body200

        

apiVirtual

apiVirtual permette di aggiornare lo stato di una spedizione del corriere virtuale.
POSThttps://api.qapla.it/virtual/


            
Parametri

*Parametro obbligatorio

apiKey*(string) La API Key assegnata al canale che vogliamo interrogare
apiVirtual(array)

È un array che può contenere massimo 100 aggiornamenti.

trackingNumber*(string) Il tracking number della spedizione da aggiornare
statusID / statusDetailID*(float) L'ID dello stato della spedizione e l'eventuale statusDetailID
status(string) La descrizione testuale dello stato della spedizione
place(string) La località dove si trova la spedizione
date(YYYY-MM-DD HH:MM:S) La data in formato ISO 8601 "yyyy-mm-dd hh:mm:ss"
note(string) Eventuali note della spedizione
Response Body200

            
Errori
In caso di errore il campo "result" conterrà "KO" ed il error la descrizione dell'errore.

Canali

getChannel

getChannel permette di ottenere informazioni sul canale collegato all'API Key e alla azienda che lo ha creato.
GEThttps://api.qapla.it/1.2/getChannel/?apiKey=[API_KEY]
Parametri
Parametro Descrizione
apiKey la API Key assegnata al canale che vogliamo interrogare
Parametri opzionali
data Ottiene informazioni sulla configurazione del canale rispetto alla piattaforma e/o ai marketplace.

Valori possibili (all, platform, marketplaces)

Response Body200

        

Misc

getCredits

getCredits permette di ottenere i crediti rimanenti sul proprio account premium.
GEThttps://api.qapla.it/1.2/getCredits/?apiKey=[API_KEY]
Parametri
Parametro Descrizione
apiKey la API Key assegnata al canale che vogliamo interrogare
Response Body200


            
Descrizione
result(string) Il risultato dell'operazione: OK o KO in caso di errore
error(string) L'errore in caso di result: KO
credits(int) I crediti rimanenti
date(string) La data di aggiornamento del conteggio

getQaplaStatus

getQaplaStatus permette di ottenere l'elenco dettagliato degli stati spedizione Qapla'.
GEThttps://api.qapla.it/1.2/getQaplaStatus/?apiKey=[API_KEY]&lang=[LANG]&id=[ID]
Parametri
Parametro Descrizione
apiKey(string) la API Key assegnata al canale che vogliamo interrogare
Parametri opzionali
lang(string) La lingua dei nomi degli stati Qapla' (it, en, es), default: it.

Esempio:

&lang=en
id(int) Eventuale id del quale si vuole ottenere informazioni

Esempio:

&id=3
Response Body200

            
result(string) Il risultato dell'operazione: OK o KO in caso di errore
error(string) L'errore in caso di result: KO
version(string) La versione dell'API
qaplaStatus(array) È un array di stati
statusID(int) Lo stato Qapla'
status(string) Il nome dello stato
statusDescription(string) La descrizione dello stato
color(string) Il colore assegnato allo stato
icon(string) L'icona assegnata allo stato
statusDetailID(int) L'eventuale dettaglio dello stato
statusDetail(string) Il nome del dettaglio
statusDetailDescription(string) La descrizione del dettaglio

getPudos

getPudos permette di richiedere l'elenco dei PUDO (Pick Up Drop Off points) di più corrieri contemporaneamente.
Attenzione
Richiedere l'attivazione al Customer Care.
POSThttps://api.qapla.it/1.2/getPudos/?apiKey=[API_KEY]
Request

            
Parametri

*Parametro obbligatorio

Parametro Descrizione
apiKey*(string) La API Key del canale
postCode*(string) CAP della località di cui si intende cercare i PUDO
country*(string) Codice ISO 3166-2 della nazione in cui è localizzato il postCode. Non viene effettuato un controllo sulla qualità del codice
couriers*(array) Elenco dei “Codici corriere” di Qapla' di cui si vuole conoscere i PUDO. I codici corriere validi sono BRT, DHL, DHLPARCEL-ES, FEDEX, FERMOPOINT, GLS, INPOST, PTI e UPS
province(string) Provincia della località oggetto di ricerca
city(string) Città/comune della località oggetto di ricerca
street(string) Indirizzo, completo di eventuale numero civico
radius(number) Raggio, espresso in KM, entro il quale limitare la ricerca dei PUDO. Specificare un valore ≤ 0 equivale a non specificare nessun raggio
limit(number) Numero di PUDO restituiti per ogni corriere. Specificare un valore ≤ 0 equivale a non specificare nessun limite, in questo caso il corriere restituirà il suo default
Response Body200

            
Parametro Descrizione
result(string) Indica se l'operazione è andata a buon fine, i valori possibili sono “OK” e “KO”
error(string) Contiene la descrizione dell'eventuale errore che è stato sollevato, vuoto se result = “OK”
data(array)

Array di oggetti contenenti l'elenco dei PUDO. Ogni elemento dell'array corrisponde alla risposta ottenuta da un corriere

statusCode(int)

Codice di Errore, esito dell'interrogazione effettuata nei confronti del corriere

200(int) OK/No error
404(int) NOT FOUND; il webservice del corriere ha restituito un elenco vuoto di PUDO
408(int) TIMEOUT; il webservice del corriere ha impiegato troppo tempo a rispondere
500(int) GENERIC ERROR;
501(int) EMPTY RESPONSE; il webservice del corriere non ha restituito una risposta
522(int) UNPROCESSABLE RESPONSE; il webservice del corriere ha restituito un output che non è stato possibile interpretare (es. JSON o XML non valido)
599(int) CUSTOM ERROR; il webservice ha risposto con un errore specifico per il corriere interrogato, maggiori informazioni sull'errore si possono trovare nel campo "error"
courier(string) Codice del corriere interrogato (es. GLS, DHL, PTI, ecc.)
error(string) Eventuale descrizione dell'errore se ne è stato sollevato uno durante l'interrogazione del singolo corriere
servicePointList(array)

Array di oggetti contenenti l'elenco dei PUDO. Ogni elemento dell'array corrisponde alla risposta ottenuta da un corriere

ID(string) Identificativo interno utilizzato dal corriere
name(string) Nome dell'esercizio/negozio/locker
type(string) Identifica la tipologia del PUDO: SHOP = negozio, POSTOFFICE = ufficio postale, LOCKER = locker, SHOPINSHOP = negozio all'interno di un altro negozio (usato da GLS)
telephone(string) Numero di telefono
street(string) Indirizzo del PUDO
postCode(string) CAP del PUDO
city(string) Città/comune del PUDO
province(string) Provincia del PUDO
country(string) Codice nazione del PUDO (2 caratteri)
coordinates(oggetto) Contiene due attributi, “latitude” e “longitude”, di tipo float, che contengono rispettivamente latitudine e longitudine del punto geografico in cui si trova il PUDO
distance(float) La distanza in Km dall'indirizzo/località che è stato oggetto di ricerca
notes(string) Eventuali note/indicazioni
businessDays(array) Indica i giorni e gli orari di apertura del PUDO, si veda il paragrafo dedicato
availableServices(array) Array di oggetti formati da due attributi “serviceCode” e “serviceDescription”, entrambi di tipo string; rappresentano i servizi disponibili presso il PUDO; il campo “serviceCode” potrebbe essere assente se non previsto dal corriere
courierSpecific(array) Array di oggetti formati da due attributi “name” e “value”, entrambi di tipo string; rappresentano campi specifici per un determinato corriere (es. harmonizedId per DHLPARCEL-ES)
holidays(array di oggetti) Array di oggetti formati da due attributi “startDate” e “endDate”, entrambi di tipo string e rappresentati rispettivamente data di inizio e data di fine di periodi di chiusura previsti. Le date sono nel formato “yyyy-mm-dd”
pushOrderPUDO(oggetto) Oggetto JSON che può essere passato alla API "pushOrder" e può prevedere campi diversi a seconda del corriere. Per maggiori informazioni vedere pushOrder
Business Days

Un oggetto dell'array businessDays rappresenta un giorno di apertura settimanale e presenta diversi attributi:

Parametro Descrizione
day(int) Indica il numero del giorno della settimana secondo la codifica ISO 8601 ( 1 = Lunedì…7 = Domenica)
dayName(string) Il nome del giorno della settimana in inglese
dayNameIT(string) Il nome del giorno della settimana in italiano
businessHours(array) Array di oggetti formati da due attributi, “open” e “close”, entrambi di tipo string, rappresentanti un orario nel formato “hh:mm”

Script

Tramite gli script JavaScript è possibile interrogare le API di Qapla' efficientemente.

Tracking Script

Inserendo e configurando il nostro Tracking Script, è possibile ottenere il tracking in qualunque parte del sito.

<!-- Place this code after <body> tag -->
<script type="text/javascript">
    let apiKey = "7b1b7235"; // your channel's public API Key
    let reference = "104"; // your order's reference
    // let noCSS = true;
    // let compact = true;
    // let lang = "en";
</script>

<script type="text/javascript" src="https://api.qapla.it/js/1.2/qapla-tracking.min.js"></script>

<!-- Place this element where you want to display the Qapla' Tracking -->
<div id="qapla-tracking"></div>
Parametri
ParametroDescrizione
apiKey*(string)La API KEY “pubblica” presente nella configurazione del canale di vendita sul Control Panel (CP) di Qapla’.
reference*/ trackingNumber*(string)Tracciare per riferimento ordine o per tracking number.
noCSS(bool)se true non include il css standard, permettendo un override.
compact(bool)se true visualizza una versione compatta, senza gli stati propri del corriere.
lang(string)

se impostato mostra gli stati del corriere nella lingua selezionata. Se non impostato viene utilizzato il default ('it')

lang(string)

Lingue in cui è possibile visualizzare gli stati corriere

it(string) Italiano
en(string) Inglese
de(string) Tedesco
fr(string) Francese
es(string) Spagnolo
pt(string) Portoghese
zh(string) Cinese
ru(string) Russo
jp(string) Giapponese
cs(string) Ceco
rn(string) Romeno
hu(string) Ungherese
ar(string) Arabo
sk(string) Slovacco
pl(string) Polacco
kr(string) Coreano
Risultato
Il risultato è un HTML che verrà inserito dentro l'elemento con id qapla-tracking avente il seguente contenuto. tracking

Help

Qapla' Status

È l'interpretazione dello stato della spedizione con dei valori che Qapla' assegna a ciascun possibile stato del corriere.

iddetailIDNomeDescrizione
0 ATTESA ELABORAZIONE La gestione automatica di interrogazione del corriere non è ancora stata eseguita.
1 IN SOSPESO La spedizione è stata trovata ma non ci sono ancora notizie da parte del corriere.
2 ATTESA RITIRO Il corriere non ha ancora ritirato la spedizione.
20 PARTITO La spedizione è partita.
3 IN TRANSITO La merce è in transito.
50 IN LAVORAZIONE Spedizione in lavorazione
50 1 IN LAVORAZIONE • DOGANA
4 IN CONSEGNA Spedizione in consegna.
5 TENTATIVO DI CONSEGNA FALLITO La consegna è fallita. Pre-allarme per possibili problemi.
8 RITARDO La spedizione sta subendo dei ritardi.
6 ECCEZIONE Viene segnalato un qualche problema che può essere generico o spiegato da ulteriori icone.
6 1 ECCEZIONE • GIACENZA La spedizione è in giacenza
6 2 ECCEZIONE • SPEDIZIONE IN RIENTRO / RIFIUTATA La spedizione è stata rifiutata e la merce è in rientro.
6 3 ECCEZIONE • DANNEGGIAMENTO Il corriere segnala che la merce risulta danneggiata.
6 4 ECCEZIONE • SMARRIMENTO Il corriere segnala che la merce risulta smarrita.
6 5 ECCEZIONE • CONSEGNA PARZIALE
10 PUNTO DI RITIRO La spedizione è stata consegnata in un Punto di Ritiro.
95 RIENTRATO La spedizione è rientrata al mittente.
99 CONSEGNATO La spedizione è stata consegnata al destinatario.

Corrieri

Elenco dei codici Qapla' per corriere, in ordine alfabetico.
CodiceNomeURL
FOURPX FOURPX 4PX http://express.4px.com/ CN
AG-LOGISTICA AG-LOGISTICA AG Logistica http://www.aglogisticasrl.it/ IT
AIR-EXPRESS-IT AIR-EXPRESS-IT Air Express https://airexpress.it/ IT
ALIEXPRESS ALIEXPRESS Aliexpress https://www.aliexpress.com/‎ CN
ALPI ALPI Alpi World https://www.alpiworld.com/ GLOBAL
AMATI-JR AMATI-JR Amati JR http://www.amatijrtrasporti.it/ IT
AMAZON-SHIPPING AMAZON-SHIPPING Amazon Shipping https://shipping.amazon.co.uk/ IT
AN-POST AN-POST An Post https://www.anpost.com/ IE
APP2DELIVERY APP2DELIVERY App2delivery IT
ARAMEX ARAMEX Aramex http://www.aramex.com GLOBAL
ARCO ARCO Arco Spedizioni http://www.arco.it/ IT
ASENDIA ASENDIA Asendia Europe https://www.asendia.com EU
ASENDIA-DE ASENDIA-DE ASENDIA Germany http://www.asendia.de/ DE
ASENDIA-USA ASENDIA-USA ASENDIA USA http://www.asendiausa.com/ US
ASM ASM ASM http://www.asmred.com ES
AUSTRALIA-POST AUSTRALIA-POST Australia Post https://auspost.com.au/ AU
AUSTRIAN-POST AUSTRIAN-POST Austrian Post https://www.post.at AT
BETSERVICE BETSERVICE B&T Service http://www.betservice.net/ IT
BELPOCHTA BELPOCHTA Belpochta https://belpost.by/ BY
BIZ-COURIER BIZ-COURIER Biz Courier https://www.bizcourier.eu/ GR
BPOST BPOST BPost https://track.bpost.be BE
BRACCHI BRACCHI Bracchi https://www.bracchi.it/ IT
BRAZIL-CORREIOS BRAZIL-CORREIOS Brazil Correios http://correios.com.br/ BR
BRT BRT BRT http://www.brt.it IT
BULGARIAN-POSTS BULGARIAN-POSTS Bulgarian Posts https://www.bgpost.bg/en BG
CBL-LOGISTICA CBL-LOGISTICA CBL Logistica http://www.cbl-logistica.com ES
CELERITAS CELERITAS Celeritas https://celeritastransporte.com/ ES
CZECH-POST CZECH-POST Česká pošta https://www.ceskaposta.cz CZ
CEVA-LOGISTICS CEVA-LOGISTICS Ceva Logistics https://www.cevalogistics.com/ GLOBAL
CHINA-EMS CHINA-EMS China EMS http://www.11183.com.cn/english.html CN
CHINA-POST CHINA-POST China Post http://www.chinapost.com.cn/ CN
CHRONOPOST-FR CHRONOPOST-FR Chronopost France http://www.chronopost.fr/ FR
CNE-EXPRESS CNE-EXPRESS CNE Express http://www.cnexps.com/ CN
COLDLINE COLDLINE Coldline https://www.coldlinegroup.com/ IT
COLIS-PRIVE COLIS-PRIVE Colis Privé https://www.colisprive.com FR
COLISSIMO COLISSIMO Colissimo http://www.colissimo.fr FR
CORREOS CORREOS Correos http://www.correos.es ES
CORREOS-EXPRESS CORREOS-EXPRESS Correos Express https://www.correosexpress.com ES
COURIER-EXPRESS-IT COURIER-EXPRESS-IT Courier expres http://www.spacecomputer-web.it/web/courier IT
CRONO-PTI CRONO-PTI Crono Poste http://www.poste-impresa.it/online/pmi/postali/italia/crono-gamma.shtml IT
CRONO-REVERSE CRONO-REVERSE Crono Reverse https://business.poste.it/professionisti-imprese/prodotti/crono-reverse-gestione-resi-ecommerce.html IT
CTS_GROUP CTS_GROUP CTS GROUP https://www.ctsgroup.nl/en/ NL
CTT CTT CTT https://www.ctt.pt PT
CYPRUS-POST CYPRUS-POST Cyprus Post https://www.cypruspost.post/ CY
DAC-IT DAC-IT D.A.C https://dac-it.com/ IT
DBSCHENKER DBSCHENKER DB Schenker https://www.dbschenker.com/ GLOBAL
DEUTSCHE-POST DEUTSCHE-POST Deutsche Post https://www.deutschepost.de/ DE
DHL-DE DHL-DE Deutsche Post DHL http://www.dpdhl.com/ DE
DHL-ECOMMERCE DHL-ECOMMERCE DHL eCommerce http://webtrack.dhlglobalmail.com/ US
DHL DHL DHL Express http://www.dhl.com/ GLOBAL
DHL-FREIGHT DHL-FREIGHT DHL Freight https://www.logistics.dhl GLOBAL
DHL-PAKET DHL-PAKET DHL Paket https://www.dhl.de/ DE
DHLPARCEL-CONNECT DHLPARCEL-CONNECT DHL Parcel Connect http://www.dhl.com/ EU
DHLPARCEL-NL DHLPARCEL-NL DHL Parcel NL https://www.dhlparcel.nl/ NL
DHLPARCEL-ES DHLPARCEL-ES DHL Parcel Spain https://www.dhlparcel.es ES
DMM DMM DMM Network http://www.dmmnetwork.it/ IT
DPD DPD DPD http://www.dpd.com/ GLOBAL
DPD-FR DPD-FR DPD France http://www.dpd.fr FR
DPD-UK DPD-UK DPD UK http://www.dpd.co.uk/ GB
DSV DSV DSV http://www.dsv.com/ GLOBAL
ELTA-HELLENIC-POST ELTA-HELLENIC-POST ELTA Hellenic Post https://www.elta.gr GR
EMIRATES-POST EMIRATES-POST Emirates Post https://www.epg.gov.ae/ AE
ENERGO-LOGISTIC ENERGO-LOGISTIC Energo Logistic https://www.energologistic.it/ IT
ENVIALIA ENVIALIA Envialia http://www.envialia.com/ ES
FAST-WL FAST-WL FAST WORLD LOGISTIC http://www.fastwl.com/ FR
FEDEX FEDEX FedEx http://www.fedex.com/ GLOBAL
FERCAM FERCAM FERCAM Logistics http://www.fercam.com/ IT
FERMOPOINT FERMOPOINT Fermopoint https://www.fermopoint.it IT
FINESSO FINESSO Finesso https://www.finesso.it/ IT
GEODIS GEODIS Geodis https://geodis.com/ FR
GLOBALTR GLOBALTR Global Trasporti http://www.globaltrasporti.com/ IT
GLS-ITA GLS-ITA GLS http://www.gls-italy.com IT
GLS GLS GLS Europe https://gls-group.eu/ EU
GLS-EUROPE-WW GLS-EUROPE-WW GLS Europe WW https://gls-group.eu/GROUP/en/home GLOBAL
GLS-FR GLS-FR GLS France https://gls-group.eu/FR/fr/home FR
GLS-SPAIN GLS-SPAIN GLS Spain https://m.gls-spain.es/ ES
GO-EXPRESS GO-EXPRESS GO! Express & Logistics https://www.general-overnight.com DE
HERMES-DE HERMES-DE Hermes Germany https://www.myhermes.de DE
HERMES-IT HERMES-IT Hermes Italy http://www.hermes-italy.it/ IT
HERMES HERMES Hermes UK https://www.myhermes.co.uk GB
HONG-KONG-POST HONG-KONG-POST Hong Kong Post https://www.hongkongpost.hk/en/home/index.html HK
HRP HRP HR Parcel https://www.hrparcel.com/ IT
HRVATSKA-POSTA HRVATSKA-POSTA Hrvatska pošta https://www.posta.hr HR
INPOST INPOST InPost https://inpost.it/ IT
INSTALLO INSTALLO Installo https://www.installo.it/ IT
INTEGRA2 INTEGRA2 Integra2 https://www.integra2.es/ ES
JERSEY-POST JERSEY-POST Jersey Post https://www.jerseypost.com/ GB
KOREA-POST KOREA-POST Korea Post https://www.epost.go.kr KR
LA-POSTE LA-POSTE La Poste https://www.laposte.fr/ FR
LATVIJAS-PASTS LATVIJAS-PASTS Latvijas Pasts https://pasts.lv/ LV
LICCARDI LICCARDI Liccardi Trasporti https://www.liccarditrasporti.com/ IT
LIETUVOS-PASTAS LIETUVOS-PASTAS Lietuvos Paštas https://www.post.lt/ LT
LUXEMBOURG-POST LUXEMBOURG-POST Luxembourg Post https://www.post.lu LU
MAGYAR-POSTA MAGYAR-POSTA Magyar Posta https://www.posta.hu/ HU
MBE-IT MBE-IT Mail Boxes Etc. Italia https://www.mbe.it/ IT
MALTA-POST MALTA-POST Malta Post https://www.maltapost.com/ MT
MILKMAN MILKMAN Mlk Fresh Refrigerato https://www.milkman.it/ IT
MONDIALRELAY MONDIALRELAY Mondial Relay https://www.mondialrelay.fr FR
MRW-ES MRW-ES MRW http://www.mrw.es/ ES
NACEX-ES NACEX-ES Nacex https://www.nacex.es/ ES
NEXIVE NEXIVE Nexive http://www.nexive.it/ IT
NOPAR NOPAR Nopar Solutions http://noparsolutions.com/ ES
OMNIVA OMNIVA Omniva https://www.omniva.ee EE
ONEXP ONEXP One Express http://www.oneexpress.it IT
ONTRAC ONTRAC OnTrac http://www.ontrac.com GLOBAL
PAACK PAACK Paack GLOBAL
PACKETA PACKETA Packeta https://tracking.packeta.com/ GLOBAL
PALLETW PALLETW Palletways http://www.palletways.com EU
PALLEX PALLEX Pallex https://www.pallex.it/ IT
PARCEL-FORCE PARCEL-FORCE Parcel Force http://www.parcelforce.com GB
POCZTA-POLSKA POCZTA-POLSKA Poczta Polska http://www.poczta-polska.pl PL
PONYU PONYU PonyU GLOBAL
POS-MALAYSIA POS-MALAYSIA Pos Malaysia https://www.pos.com.my/ MY
POSTA-ROMANA POSTA-ROMANA Poșta Română https://www.posta-romana.ro/ RO
SLOVENIA-POST SLOVENIA-POST Pošta Slovenije https://www.posta.si SI
PTI PTI Poste Italiane http://www.poste.it IT
POSTEN-NORGE POSTEN-NORGE Posten Norge https://www.posten.no/ NO
POSTI POSTI Posti https://www.posti.fi/ FI
POSTNL-INT POSTNL-INT PostNL International http://www.postnl.post/ NL
POSTNL-3S POSTNL-3S PostNL International 3S https://www.internationalparceltracking.com NL
POSTNORD-DENMARK POSTNORD-DENMARK PostNord Denmark https://www.postnord.dk DK
POSTNORD-SWEDEN POSTNORD-SWEDEN PostNord Sweden https://www.postnord.se/ SE
QHD QHD QHD https://www.qhditalia.it/ GLOBAL
RDA RDA Ramoneda http://www.ramoneda.com/ ES
REDUR REDUR Redur ES
ROYAL-MAIL ROYAL-MAIL Royal Mail http://www.royalmail.com GB
RPOST RPOST RPost https://www.errepost.it/ IT
RUSSIAN-POST RUSSIAN-POST Russian Post https://www.pochta.ru RU
SF-EXPRESS SF-EXPRESS S.F. Express http://www.sf-express.com CN
SAILPOST SAILPOST Sailpost http://www.sailpost.it IT
SMM-IT SMM-IT San Marino Mail http://www.sanmarinomail.sm IT
SDA SDA SDA http://wwww.sda.it IT
SDA-RACCOMANDATA SDA-RACCOMANDATA SDA Raccomandata http://wwww.sda.it IT
SENDABOX SENDABOX Sendabox http://www.sendabox.it IT
SENDING SENDING Sending Transporte Urgente https://www.sending.es ES
SEUR SEUR Seur http://www.seur.com ES
SGT SGT SGT Corriere Espresso http://www.sgt.it/ IT
SINOTRANS SINOTRANS Sinotrans http://www.sinotrans-csc.com/ CN
SKYNET-ITA SKYNET-ITA SkyNet Italy http://www.skynetitaly.it IT
SKYNET SKYNET SkyNet Worldwide Express http://www.skynetwwe.com/ GLOBAL
SOUTH-AFRICAN-POST SOUTH-AFRICAN-POST South African Post https://www.postoffice.co.za ZA
SPEDIAMO SPEDIAMO Spediamo.it http://www.spediamo.it/ IT
SPRING-GDS SPRING-GDS Spring GDS https://www.spring-gds.com/ EU
STEF-IT STEF-IT STEF https://www.stef.it/ IT
SUSA SUSA Susa https://flex.susa.it/Home IT
SWISS-POST SWISS-POST Swiss Post https://www.post.ch/ CH
TWS TWS T.W.S. Express Courier http://www.twsexpresscourier.it IT
TECNO-TRANS TECNO-TRANS Tecnotrans http://www.tecnotrans.eu IT
TEMPO-ONE TEMPO-ONE Tempo One https://www.tempo-one.com/ FR
TIPSA TIPSA TIPSA http://www.tip-sa.com/ ES
TNT TNT TNT http://www.tnt.com GLOBAL
TNT-CLICK TNT-CLICK TNT Click http://www.tnt-click.it IT
TNT-ES TNT-ES TNT España http://www.tnt.es ES
TNT-ITA TNT-ITA TNT Italia https://www.tnt.it/ IT
TNT-UK TNT-UK TNT UK http://www.tnt.com/express/en_gb/site/home.html GB
TOLL TOLL Toll Group https://www.tollgroup.com/ GLOBAL
TOURLINE-EXPRESS TOURLINE-EXPRESS Tourline Express http://www.tourlineexpress.com ES
TRAKPAK TRAKPAK Trakpak http://www.trackmytrakpak.com EU
TYP TYP TYP https://typ.delivery IT
UPS UPS UPS http://www.ups.com/ GLOBAL
USPS USPS USPS https://www.usps.com/ US
YAMATO YAMATO Yamato Transport GLOBAL
YANWEN YANWEN Yanwen http://www.yw56.com.cn/ CN
YDH YDH Ydh http://www.ydhex.com/ CN
YODEL YODEL Yodel Domestic http://www.yodel.co.uk/ GB
YUNEXPRESS YUNEXPRESS Yun Express http://www.yunexpress.com/ CN
ZELERIS-ES ZELERIS-ES Zeleris https://www.zeleris.com/ ES
ZUST ZUST Züst Ambrosetti http://www.zust.it/ IT
Default G Q
Default 0
ASENDIA G Q
e-PAQ Plus 31
e-PAQ Select 32
BRT G Q
Express 0 0
Priority 1 E
10:30 2 H
Circuito DPD 6 6
Circuito Euroexpress 7 7
Circuito Fedex 8 8
DPD Direct Infeed 9 9
CORREOS G Q
Domestic
PAQUETE POSTAL PRIORITARIO (I) 20
POSTAL EXPRéS (I) 21
PAQ Estándar DOMICILIO 22
PAQ Estándar OFICINA 23
PAQ RETORNO PREMIUM CON Envío ASOCIADO 25
S0148 PAQ RETORNO 26
PAQ PREMIUM DOMICILIO 27
PAQ PREMIUM EN OFICINA 28
PAQUETE POSTAL Económico (I) 30
PAQ PREMIUM ENTREGA EN HOMEPAQ 31
PAQ PREMIUM ENTREGA EN CITYPAQ 32
PAQ Estándar ENTREGA EN HOMEPAQ 33
PAQ Estándar ENTREGA EN CITYPAQ 34
International
PAQ STANDARD INTERNACIONAL (I) 24
PAQ PREMIUM INTERNACIONAL (I) 29
PAQ INTERNACIONAL LIGH 35
CORREOS-EXPRESS G Q
Domestic
Paq 10 20 20
Paq 14 21 21
Paq 24 22 22
Baleares Express 23 23
Canarias Express 24 24
Canarias Aéreo 25 25
Canarias Marítimo 26 26
Paq Empresa 14 29
ePaq 24 30
54 Entrega Plus 31 31
International
Paq 24 22
Internacional Estándar 27 27
Internacional Express 28 28
Paq Empresa 14 29 29
ePaq 24 30 30
54 Entrega Plus 31
Crono G Q
Domestic
Express 2 P46
Economy 3 P49
Crono 1 P44
CRONOPLUS 5
ROAD EUROPE - EURODIS 6
Circuito Euroexpress 7
International
Internazionale 8 P48
DHL PARCEL CONNECT G Q
Domestic
DHL Parcel Connect connect
International
DHL Parcel International international
Dhl G Q
Domestic
Domestic Express 0
Domestic Express 10:30 2
Domestic Express 12:00 1
Domestic Express 9:00 4
Economy Select (H,W) 8
Medical Express 20
Express Easy 21
Parcel Product 22
International
Express Worldwide H12 7
International Express Worldwide 9
International Express 9:00 10
FERCAM G Q
BOOK 0
FLEX 2
FIX 1
SPEED 3
Private 5
HD (check "assemblyTypes") 20
FedEx G Q
Domestic
Priority Overnight 0
International
Priority 6
First 7
Economy 8
Connect plus 10
Regional Economy 11
GLS-ES G Q
CO1 - COURIER 14:00 Service 20
CO2 - COURIER BusinessParcel 21
CO3 - COURIER 10:00 Service 22
CO4 - COURIER SaturdayService 23
CO5 - COURIER MASIVO 24
CO6 - COURIER REC. EN NAVE 25
EC1 - EconomyParcel EconomyParcel 26
CA1 - CARGA MARITIMO 27
CO7 - COURIER ParcelShop 28
EC2 - EconomyParcel ParcelShop 29
EU1 - EUROBUSINESS PARCEL EBP 30
EU2 - EUROBUSINESS SMALL PARCEL EBP 31
AS1 - ASM TRAVELLERS ASM TRAVELLERS 32
AS2 - RECOGIDA BusinessParcel 33
AS3 - DEVOLUCION BusinessParcel 34
AS4 - RETORNO BusinessParcel 35
AS5 - RC.SELLADA BusinessParcel 36
INPOST G Q
InPost Locker Standard 1
Liccardi G Q
Bancale B
Dedicato DE
Espresso E
Reso R
Store ZS
MRW-ES G Q
Urgente 10 0000
Urgente Hoy - Frecuencia 1 0005_1
Urgente Hoy - Frecuencia 2 0005_2
Promociones 0010
Urgente 10 Expedición 0015
Urgente 12 0100
Urgente 12 Expedición 0105
Urgente 14 0110
Urgente 14 Expedición 0115
Urgente 19 0200
Urgente 19 Expedicion 0205
Urgente 19 Portugal 0220
Bag 19 0230
Bag 14 0235
Economico 0300
Economico Interinsular 0350
Marítimo Baleares 0370
Marítimo Canarias 0385
Marítimo Interinsular 0390
Express Documentos 0400
Express 2 Kilos 0450
Caja Express 3 Kilos 0480
Documentos 14 0490
Ecommerce 0800
Tramo Orario 08-14 0800_tramo_1
Tramo Orario 16-19 0800_tramo_2
Ecommerce Ultrarrápido - Frecuencia 1 0800_1
Ecommerce Ultrarrápido - Frecuencia 2 0800_2
Ecommerce Canje 810
Milkman G Q
Standard 0
Premium 1
NACEX ES G Q
NACEX 10:00H 20
NACEX 12:00H 21
INTERDIA mañana 22
INTERDIA tarde 23
INTERDIA aéreo 24
PLUS BAG 1 25
PLUS BAG 2 26
VALIJA 27
VALIJA IDA Y VUELTA 28
NACEX 19:00H 29
PUENTE URBANO mañana 30
PUENTE URBANO tarde 31
PUENTE URBANO nocturno. 32
DEVOLUCION ALBARAN CLIENTE 33
NACEX 08:30H 34
DEVOLUCION TALON 35
DEVOLUCION PLUS BAG 1 36
DEVOLUCION PLUS BAG 2 37
DEVOLUCION E-NACEX 38
NACEX SABADO 39
CANARIAS MARITIMO 40
CANARIAS 24H 41
PLUS PACK 42
E-NACEX 43
PREMIUM 44
NX-SHOP VERDE 45
NX-SHOP NARANJA 46
E-NACEX SHOP 47
C@MBIO 48
CANARIAS 48H 49
INMEDIATO 50
NACEX.SHOP 51
SWAP 52
RETORNO SWAP 53
DEV. ORIGEN 54
EURONACEX TERRESTRE 55
SERVICIO AEREO 56
EURONACEX ECONOMY 57
PLUSPACK EUROPA 58
BALEARES MARITIMO 59
NEXIVE G Q
Sistema Completo 0
Sistema Economy 2
Sistema Slim 1
Sistema Espresso 3
Poste Delivery Business G Q
Standard nazionale 0
Espresso nazionale 1
SDA G Q
Extralarge 0 S09
Internazionale 8 S08
Economy 3 S24
Road Europe 7 S34
Export Box 6 S36
SEUR G Q
Domestic
SEUR 24 20
SEUR 10 21
SEUR 13:30 22
SEUR FRIO 10 27
SEUR FRIO 13:30 28
Seur FRIO 48 (Baleares) 29
Seur 13 Saturday 30
International
Seur Internacional NON EU 23
Seur Classic (DPD) Internacional Terrestre 24
Seur Classic (DPD) Predict Crossborder 25
Seur NetExpress (SEUR) Internacional Terrestre 26
SMM-IT G Q
AT_DPD_PRIME_GEN 20
AT_POST_0584 21
AT_POST_B2C 46
BE_G3_STA 22
BE_TOO_BP 47
CH_SWP_PPECO 23
DE_490_WINE 24
DE_DHL_STA_POST 25
DE_DPD_B2C 26
DE_HERM_DROPOFF 27
DE_HERM_STA 28
DE_HERM_WINE 29
DE_DHL_PAKET_WEBSERVICE 43
ES_CORR_DROPOFF 30
ES_CORR_STA 31
FR_COL_SFS 44
FR_GLS_ADO 32
FR_GLS_STA 33
FR_GLS_WINE 34
FR_LPF_OTH 35
FR_MONDIAL_DROPOFF 36
INT_DHL_ECO 37
INT_DHL_EXPMB 38
IT_GLS_LIGHT 39
IT_SDA_MULTI 40
NL_G3_STA 41
PT_CORR_RAN 42
ES_PAA_STA 45
SkyNet Worldwide Express G Q
Domestic
Domestic Express 0
Domestic Express 1/5000 1
Express Documents 6
Express Non Documents 7
SKYSAVER 8
International
USA Deferred 9
USA Economy Service 10
Spring GDS G Q
TRCK - TRACKED 20
SIGN - SIGNATURED 21
PPTT - PostNL Packet Tracked 30
PPTR - PostNL Packet Registered 31
PPNT - PostNL Packet Non Tracked 32
TIPSA G Q
20 - DELEGATION 20
48 - ECONOMY 21
25 - FARMA 22
96 - MARITIMA 23
24 - PREMIUM 24
06 - TIPSA 06 25
10 - TIPSA 10 26
14 - TIPSA 14 27
MV - TIPSA, 28
50 - YUPICK 29
TNT G Q
Domestic
Nazionale Express 0
Nazionale 12:00 Express 1
Nazionale 10:00 Express 2
Nazionale Economy Express 3
International
Internazionale Express 6
Internazionale 12:00 Express 7
Internazionale Economy Express 8
Internazionale 12:00 Economy Express 9
TNT ES G Q
Domestic
Express 40
10:00 Express 42
12:00 Express 44
Express Plus 46
International
Economy Express 20
12:00 Economy Express 21
Express 22
9:00 Express 24
10:00 Express 26
12:00 Express 28
TNT IT G Q
Domestic
Nazionale Express 0 0
Nazionale 12:00 Express 1 1
Nazionale 10:00 Express 2 2
Nazionale Economy Express 3 3
International
Internazionale Express 6 6
Internazionale 12:00 Express 7 7
Internazionale Economy Express 8 8
Internazionale 12:00 Economy Express 9 9
UPS G Q
Domestic
Nazionale Express Saver 0 0
Nazionale Express 1 1
Nazionale Express Plus 2 2
Nazionale Standard 3 3
International
Internazionale Express 6 6
Internazionale Express Plus 7 7
Internazionale Standard 8 8
Internazionale Saver 9 9
Expedited 10 10
USA Next day air 21 21
USA 2nd day air 22 22
USA Ground 23 23
ARCO
Preavviso telefonico S
ASENDIA
Economy ECO
Signature SIG
PUDO PUDO
Mailbox MBX
Predict next day PND
Predict two days P2D
Saturday SAT
Evening delivery ED
Timed delivery by 10.00 1000
Timed delivery by 12.00 1200
Dangerous Goods DG
Address correction AC
POD POD
Flex FLX
Enhanced liability 500 € EL500
Enhanced liability 45 € EL45
Enhanced liability 150 € EL150
Sea SEA
Personal Delivery PD
BRT
su appuntamento A
consegna al piano P
CORREOS
Código Oficina (máximo 7 caracteres)
CORREOS EXPRESS
Entrega el sábado sabato
FERCAM
Al piano alPiano
Sponda sponda
Prenotazione telefonica appuntamento
GLS-ITA
EXPRESS 12 22
FLEX DELIVERY PARCEL 31
EXCHANGE 24
CONSEGNA AL PIANO 05
PREAVVISO TELEFONICO 25
SERVIZIO AL SABATO 07
SERVIZIO AL SABATO AFTERNOON 29
ENTRO ORE 12 01
ORA FISSA 02
SATURDAY EXPRESS 36
LICCARDI
Preavviso telefonico preavvisoTelefonico
MRW_ES
Entrega el sábado sabato
Entrega urgente 8:30 entrega830
Entrega Partir De (de 00:00 a 23:00) ejemplo 10:00
Sin gestión N_gestion
Gestión en origen O_gestion
Gestión en destino D_gestion
Sin retorno N_retorno
Retorno de albarán cobro en destino D_retorno
Retorno de mercancia S_retorno
Sin confirmación inmediata de entrega/recogida N_confirm
Confirmación inmediata de recogida R_confirm
Confirmación inmediata de entrega E_confirm
PTI
Al piano alPiano
Sabato sabato
Su appuntamento appuntamento
Poste Delivery Now PDBnow
SDA / CRONO-PTI
consegna al piano alPiano
consegna al sabato sabato
consegna alla sera sera
su appuntamento appuntamento
Ore 09:00 T09
Ore 10:00 T10
Ore 12:00 T12
SEUR
Entrega el sábado sabato
TWS
Consegna entro le 09:00 AM - spedizione monocollo T09
Consegna entro le 10:00 AM T10
Consegna entro le 12:00 AM T12
Consegna Al Piano PIA
Consegna Di Sabato SAB
Consegna Su Appuntamento APP
Consegna Di Sera SER
Combinazione Consegna Al Piano/Di Sabato PSA
Combinazione Consegna Al Piano/Su Appuntamento PAP
Combinazione Consegna Al Piano/Di Sera PSE
Combinazione Consegna Al Piano/Ore 9 PI0
Combinazione Consegna Al Piano/Ore 10 PI1
Combinazione Consegna Al Piano/Ore 12 PI2
Combinazione Consegna Di Sabato/Su Appuntamento SAP
Combinazione Consegna Su Appuntamento/Di Sera ASE
Combinazione Consegna Al Piano/Su Appuntamento/Di Sera APS
Combinazione Al Piano/Di Sabato/Su Appuntamento ASP
BRT - DISK B – WS REST G Q
CONTANTE 12 12
ASSEGNO INTESTATO AL MITTENTE [BP] 17 17
ASSEGNO CIRCOLARE INTESTATO ALLA MITTENTE [CM] 18 18
ASSEGNO BANCARIO INTESTATO ALLA MITTENTE [BM] 15 15
ASSEGNO CIRCOLARE INTESTATO AL CORRIERE 6
ASSEGNO CIRCOLARE INTESTATO AL MITTENTE ORIGINALE [OC] 10 10
ASSEGNO INTESTATO AL MITTENTE ORIGINALE [OM] 11 11
ASSEGNO BANCARIO INTESTATO CORRIERE CON MANLEVA [BB] 3 3
ACCETTARE ASSEGNO BANCARIO INTESTATO ALLA MITTENTE COSI COME RILASCIATO [TM] 19 19
DHL G Q
CASH, POS YYY
CONTANTE 12
ASSEGNO CIRCOLARE INTESTATO AL MITTENTE ORIGINALE 10 GGG
ASSEGNO BANCARIO INTESTATO AL MITTENTE ORIGINALE 15 QQQ
CONTANTI, POS, ASSEGNO O ASSEGNO POSTALE O ASSEGNO CIRCOLARE PAGABILE AL MITTENTE 0 KKK
ASSEGNO BANCARIO O ASSEGNO POSTALE INTESTATO CASA MANDANTE RRR
ASS. CIRC. INT CASA MANDANTE LLL
CASH, POS O ASSEGNO (BANC./POST./CIRCOLARE) INTESTATO CASA MANDANTE JJJ
FERCAM G Q
CONTANTE 12
ASSEGNO INTESTATO AL MITTENTE ORIGINALE 15
GLS-ITA G Q
CONTANTE CONT
ASSEGNO BANCARIO AB
ASSEGNO CIRCOLARE/BANCARIO (NO POSTALE) ABC
ASSEGNO BANCARIO/POSTALE (NO CIRCOLARE) ABP
ASSEGNO CIRCOLARE AC
ASSEGNO POSTALE AP
ASSEGNO CIRCOLARE/BANCARIO/POSTALE ASS
Ass. come rilasciato ASR
Ass. come rilasciato int. Mittente ARM
Ass. come rilasciato - no postale ASRP
Ass. come rilasciato int. Mittente – no postale ARMP
LICCARDI G Q
SOLO CONTANTI CNT 3
ASSEGNO CIRCOLARE INTESTATO AL MITTENTE ACM 5
ASSEGNO BANCARIO INTESTATO AL MITTENTE ABM 4
ASSEGNO A MITTENTE COME RILASCIATO 6
CONTANTI O ASSEGNO A MITTENTE COME RILASCIATO T 8
POSTE DELIVERY BUSINESS G Q
CONTANTE 12 12
ASSEGNO CIRCOLARE INTESTATO AL MITTENTE 10
ASSEGNO BANCARIO INTESTATO AL MITTENTE 11
ASSEGNO INTESTATO AL MITTENTE ORIGINALE 15
SDA G Q
Tutti VAR VAR
Contanti CON CON
Ass.Banc.Mittente ABM ABM
Ass.Banc.SDA ABS ABS
Ass.Circ.Mittente ACM ACM
Ass.Circ.SDA ACS ACS
TNT IT G Q
CONTANTE 12 12
ASSEGNO INTESTATO AL MITTENTE ORIGINALE 15 15