Qapla' :: RESTful JSON API 1.2

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.

L'API di Qapla è basata su REST.
Accetta richieste GET, POST, PUT, DELETE e PATCH codificate JSON.
Restituisce i valori codificati JSON.
Il fuso orario di riferimento è il CEST, che corrisponde all'orario UTC+2 quando è in vigore l'ora legale, o UTC+1 quando è in vigore l'ora solare.

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.

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

Una Postman Collection è disponibile.

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
RESPONSE

Request

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

{
                    "apiKey": "[API_KEY]",
                    "pushShipment": [{
                            "trackingNumber": "123987299",
                            "courier": "DHL",
                            "shipDate": "2014-08-01"
                        },
                        {
                            "trackingNumber": "1Z0V5V416840696736",
                            "courier": "UPS",
                            "shipDate": "2014-08-02",
                            "reference": "ord. # 1674",
                            "orderDate": "2014-07-30",
                            "weight": 1.3,
                            "parcels": 1,
                            "length": 10,
                            "width": 15,
                            "height": 5,
                            "name": "Pepito Sbazzeguti",
                            "street": "Via Aieie, 99",
                            "city": "Parnazza",
                            "ZIP": "12345",
                            "state": "MZ",
                            "country": "IT",
                            "email": "name@domain.ext",
                            "telephone": "02342522",
                            "agent": "agent@company.ext",
                            "amount": "150,00",
                            "pod": false,
                            "shipping": "8,00",
                            "custom1": "valore custom 1",
                            "custom2": "valore custom 2",
                            "custom3": "valore custom 3",
                            "note": "This is a note",
                            "language": "it",
                            "deliveryDate": "2014-07-31",
                            "tag": "customer1",
                            "isTrackingNumber": false,
                            "origin": "magento",
                            "isReturnable": true,
                            "platformOrderID": "1234567890",
                            "rows": [{
                                "sku": "BAR-301",
                                "name": "Barrette di Crusca d'Avena con Cioccolato (4 pezzi) 120g",
                                "qty": 1,
                                "weight": 1.5,
                                "url": "https://www.iltuosito.it/alimenti/barretta-al-cocco",
                                "imageUrl": "https://www.iltuosito.it/img/alimenti/barretta-al-cocco.jpg",
                                "price": 6.3500,
                                "total": 6.3500,
                                "isReturnable": true
                            }, {
                                "sku": "BEV-001",
                                "name": "Bevanda al mango in polvere 9g",
                                "qty": 5,
                                "weight": 1,
                                "url": "https://www.iltuosito.it/alimenti/barretta-al-cocco",
                                "imageUrl": "https://www.iltuosito.it/img/alimenti/barretta-al-cocco.jpg",
                                "price": 0.3800,
                                "total": 1.9000,
                                "isReturnable": true
                            }]
                        }
                    ]
            }

Parametri

Esistono 3 tipi di modalità di caricamento delle spedizioni.

"minimo" contenente 3 campi obbligatori^*
"necessario" per attivare i servizi aggiuntivi di comunicazione al cliente come Email transazionali, ecc.^•
"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
                                        

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 Body`200`

{
                "pushShipment": {
                    "result": "OK",
                    "error": null,
                    "count": 2,
                    "shipments": [{
                            "result": "OK",
                            "error": null,
                            "id": 9999999,
                            "url": "https://tracking.qapla.it/27e7cefc788a11e9bfc60cc47acaffd0Q!",
                            "hash": "27e7cefc788a11e9bfc60cc47acaffd0Q!",
                            "courier": "DHL",
                            "trackingNumber": "123987299"
                        },
                        {
                            "result": "OK",
                            "error": null,
                            "url": "https://tracking.qapla.it/27e7cefc788a11e9bfc60cc47acaffd0!",
                            "hash": "27e7cefc788a11e9bfc60cc47acaffd0!",
                            "courier": "UPS",
                            "trackingNumber": "1Z0V5V416840696736",
                            "reference": "ord. # 1674",
                            "custom1": "valore custom 1",
                            "custom2": "valore custom 2",
                            "custom3": "valore custom 3"
                        }
                    ],
                    "imported": 2
                }
                }

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]

REQUEST
RESPONSE

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 Body`200`

{"getShipment":{"result":"OK","error":null,"version":"1.2.50","lang":"it","count":1,"shipments":[{"id":1690120025,"hash":"347513728eab0009bfc60cc47acaffd0","url":"https://tracking.qapla.it/347513728eab0009bfc60cc47acaffd0","reference":"RAD000UFPL","trackingNumber":"080010017684806","isDeleted":false,"isArchived":false,"origin":{"code":"magento","name":"Magento","icon":"https://cdn.qapla.it/origin/magento.svg"},"courier":{"code":"BRT","name":"BRT","icon":"https://cdn.qapla.it/courier/BRT.svg","note":null,"estimatedDeliveryDate":null,"trackingURL":"https://brt.it/tracking/fooandnoes"},"status":{"date":"2019-06-14 06:15","dateISO":"2019-06-14 06:15:00","status":"ON_THE_ROAD","place":"RIVALTA (TO) (IT)","qaplaStatus":{"id":3,"status":"IN TRANSIT","detailID":0,"detail":null,"color":"#1D76D8","icon":"https://cdn.qapla.it/status/3.svg"},"dateUpd":"2019-06-14 15:53:15","lastCheck":"2019-06-14 22:17:13"},"shipDate":"2019-06-13","orderDate":"2019-01-31","dateIns":"2019-06-14 15:49:18","consignee":{"name":"Luca Cassia","address":"Via Campazzino, 12","city":"Milano","state":"MI","postCode":"20100","country":"IT","email":"adso@defanchisgiocattoli.it","isAmazon":false,"phone":"02343522"},"language":"it","newTrackingNumber":null,"oldTrackingNumber":null,"hasNewTrackingNumber":false,"isTrackingNumber":true,"returnTrackingNumber":null,"isReturnShipment":false,"isCOD":false,"amountText":null,"amount":null,"isDelivered":false,"isChild":true,"parent":{"id":"2010200","reference":"AD000UFPL","rackingNumber":"090010015489","courier":"BRT","url":"https://api.qapla.it/1.2/getShipment/?apiKey=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&id=0000000"},"hasChildren":true,"children":[{"id":"121029109","reference":"303-XX11XX-5621132","trackingNumber":"0844!!!!7689193","courier":"DPD","url":"https://api.qapla.it/1.2/getShipment/?apiKey=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&id=000001"}],"trueTrackingNumber":null,"altTrackingNumber":null,"custom1":null,"custom2":null,"custom3":null,"deliveryMode":"pickup","hasFlag":true,"flag":{"description":"Ritardo Courier","note":"telefonato a Pino"},"notifications":{"email":[{"result":"OK","statusID":3,"status":"IN TRANSIT","date":"2019-06-14 16:00:08","error":false,"isOpened":true}],"sms":[{"result":"OK","statusID":20,"status":"PARTITO","date":"2019-06-14 18:50:29"}],"webhook":[{"statusID":3,"date":"2019-06-14 23:51:06","result":"OK","status":"IN TRANSITO"}],"qaplAPP":[{"statusID":4,"result":"OK","date":"2019-06-15 08:00:00","status":"IN COSEGNA"},{"statusID":3,"result":"OK","date":"2019-06-14 19:15:09","status":"IN TRANSITO"}]},"trackingHistory":[{"date":"2019-06-14 06:15","dateISO":"2019-06-14 06:15:00","status":"IN TRANSIT","place":"RIVALTA (TO) (IT)","qaplaStatus":{"id":3,"status":"IN TRANSIT","detailID":0,"detail":null,"color":"#1D76D8","icon":"https://cdn.qapla.it/status/3.svg"}},{"date":null,"dateISO":null,"status":"PARCEL HANDED TO DPD","place":null,"qaplaStatus":{"id":20,"status":"DEPARTED","detailID":0,"detail":null,"color":"#8A2BE2","icon":"https://cdn.qapla.it/status/20.svg"}}]}]}}

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]

REQUEST
RESPONSE

Parametri

Parametro	Descrizione
apiKey	la API Key assegnata al canale che vogliamo interrogare
[DATE]^*
shipDate	data spedizione in formato ISO 8601 "YYYY-MM-DD"
orderDate	data ordine in formato ISO 8601 "YYYY-MM-DD"
dateIns	data di caricamento in formato ISO 8601 "YYYY-MM-DD"

^*Se nessun parametro viene valorizzato di default verrà utilizzato dateIns e la data corrente.

Response Body`200`

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/

REQUEST
RESPONSE

Parametri

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

trackingNumber
courier

Response Body`200`

deleteShipment

deleteShipment permette di eliminare una spedizione.

DELETEhttps://api.qapla.it/1.2/deleteShipment/

REQUEST
RESPONSE

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 Body`200`

undeleteShipment

undeleteShipment permette di ripristinare una spedizione.

PATCHhttps://api.qapla.it/1.2/undeleteShipment/

REQUEST
RESPONSE

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 Body`200`

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/

REQUEST
RESPONSE

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 Body`200`

{
	"trackingByTimeFrame": {
		"result": "OK",
		"error": null,
		"version": "1.2.4",
		"dateFrom": "2019-10-29 17:03:52",
		"dateTo": "2019-10-29 23:59:59",
		"lang": "it",
		"count": 2,
		"shipments": [{
			"id": "000000000001",
			"getShipment": "https://api.qapla.it/1.2/getShipment/?apiKey=[API_KEY]&id=000000000001",
			"reference": "0101000101002-A",
			"trackingNumber": "XX000001",
			"origin": "privalia_it",
			"courier": "GLS-ITA",
			"status": {
				"date": "29/10/19 14:07",
				"dateISO": "2019-10-29 14:07:00",
				"status": "CONSEGNATA",
				"place": "LUCCA",
				"qaplaStatus": {
					"id": 99,
					"status": "CONSEGNATO",
					"detailID": 0,
					"detail": null,
					"color": "#66CC00",
					"icon": "https://cdn.qapla.it/status/99.svg"
				},
				"dateUpd": "2019-10-29 17:13:07",
				"lastCheck": "2019-10-29 17:13:07"
			},
			"shipDate": "2019-10-28",
			"orderDate": "2019-10-13",
			"dateIns": "2019-10-28 17:14:45",
			"dateUpd": "2019-10-29 17:13:07",
			"custom1": null,
			"custom2": null,
			"custom3": null
		}, {
			"id": "000000000002",
			"getShipment": "https://api.qapla.it/1.2/getShipment/?apiKey=[API_KEY]&id=000000000001",
			"reference": "0101000101002-B",
			"trackingNumber": "XX000001",
			"origin": "privalia_it",
			"courier": "GLS-ITA",
			"status": {
				"date": "29/10/19 13:53",
				"dateISO": "2019-10-29 13:53:00",
				"status": "CONSEGNATA",
				"place": "SAVONA",
				"qaplaStatus": {
					"id": 99,
					"status": "CONSEGNATO",
					"detailID": 0,
					"detail": null,
					"color": "#66CC00",
					"icon": "https://cdn.qapla.it/status/99.svg"
				},
				"dateUpd": "2019-10-29 17:12:50",
				"lastCheck": "2019-10-29 17:12:50"
			},
			"shipDate": "2019-10-28",
			"orderDate": "2019-10-25",
			"dateIns": "2019-10-28 17:14:45",
			"dateUpd": "2019-10-29 17:12:50",
			"custom1": null,
			"custom2": null,
			"custom3": null
		}]
	}
}

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

pushOrder

pushOrder permette di caricare uno o più ordini tramite una POST dei dati in formato JSON.

POSThttps://api.qapla.it/1.2/pushOrder/

REQUEST
RESPONSE

{
  "apiKey": "[API_KEY]",
  "origin": "magento2",
  "pushOrder": [
    {
      "reference": "BAT-234241299",
      "orderID": 234241222,
      "courier": "CRONO-PTI",
      "courierService": "P46",
      "status": "Processato",
      "createdAt": "2018-04-01 22:38:18",
      "updatedAt": "2018-04-01 22:40:41",
      "name": "Barbara Gordon",
      "street": "Via manin, 8",
      "city": "Vigonza",
      "state": "Padova",
      "postCode": "35010",
      "country": "IT",
      "email": "batgirl@yahoo.it",
      "telephone": "3473425220",
      "amount": 109.2548,
      "currencyCode": "EUR",
      "payment": "pp_hosted",
      "isCOD": false,
      "notes": "Consegnare solo se in costume",
      "weight": 1.3,
      "parcels": 1,
      "length": 10,
      "width": 15,
      "height": 5,
      "isReturnable": true,
      "shippingCODPaymentOption": "",
      "shippingInsurance": 300.99,
      "shippingDeliveryOptions": "A,P",
      "shippingRequiredDeliveryDate": "2020-09-01",
      "pickUpDate": "2020-08-30",
      "custom1": "custom value 1",
      "custom2": "custom value 2",
      "custom3": "custom value 3",
      "pickupPoint": "0201",
      "content": "The goods",
      "rows": [
        {
          "sku": "BAR-301",
          "name": "Barrette di Crusca d'Avena con Cioccolato (4 pezzi) 120g",
          "qty": 1,
          "weight": 1.5,
          "url": "https://www.iltuosito.it/alimenti/barretta-al-cocco",
          "imageUrl": "https://www.iltuosito.it/img/alimenti/barretta-al-cocco.jpg",
          "price": 6.35,
          "total": 6.35,
          "isReturnable": true,
          "notes": "this is a product note"
        },
        {
          "sku": "BEV-001",
          "name": "Bevanda al mango in polvere 9g",
          "qty": 5,
          "weight": 1,
          "url": "https://www.iltuosito.it/alimenti/barretta-al-cocco",
          "imageUrl": "https://www.iltuosito.it/img/alimenti/barretta-al-cocco.jpg",
          "price": 0.38,
          "total": 1.9,
          "isReturnable": true
        }
      ],
      "sender": {
        "code": "FEDO",
        "businessName": "fedò snc",
        "street": "Via I Maggio, 11",
        "city": "Vedano Olona",
        "state": "VA",
        "postCode": "21040",
        "country ": "IT",
        "email": "evelina@fedo.it",
        "telephone": "0332261261",
        "referent": "Evelina",
        "isDefault": false
      },
      "PUDO":{
        "id" : "1234",
        "type" : "LOCKER",
        "name" :"Bar Mario snc",
        "address":"Via mario rossi",
        "city":"Varese",
        "state":"VA",
        "country":"IT",
        "postalCode":"21100",
        "description":"Note"
      }
    }
  ]
}

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
                            

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 o il codice tariffa di BRT

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): elenco codici servizi

shippingInsurance(float)

Generale
GLS-ITA
SDA

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)

Generale
PTI

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

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**
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

Response Body`200`

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]

REQUEST
RESPONSE

Parametri

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

Response Body`200`

{
  "getOrder": {
    "result": "OK",
    "error": null,
    "version": "1.2.52",
    "count": 1,
    "orders": [{
      "reference": "100A-Q231",
      "orderID": 201761,
      "status": "processing",
      "dateIns": "2019-06-21 18:00:08",
      "createdAt": "2019-06-21 15:33:26",
      "updatedAt": "2019-06-21 15:33:27",
      "isActive": true,
      "isDeleted": false,
      "isShipped": false,
      "origin": {
        "code": "magento2",
        "name": "Magento2",
        "icon": "https://cdn.qapla.it/origin/magento2.svg"
      },
      "courier": {
        "code": null,
        "name": null,
        "icon": null,
        "courierService": null
      },
      "consignee": {
        "name": "Pepito Sbazzeguti",
        "address": "Via Aieie, 9",
        "city": "Parnazza",
        "state": "RM",
        "postCode": "00122",
        "country": "MZ",
        "email": "pepito@sbazzeguti.it",
        "phone": "02342522"
      },
      "amount": "EUR 1058",
      "payment": "pwsmage_consel",
      "isCOD": false,
      "notes": null,
      "weight": null,
      "parcels": null,
      "length": null,
      "width": null,
      "height": null,
      "rows": {
        "sku": "BAR-301",
        "name": "Barrette di Crusca d'Avena con Cioccolato (4 pezzi) 120g",
        "qty": 1,
        "price": 6.3500,
        "total": 6.3500
      },
      "PUDO":{
        "id" : "1234",
        "type" : "LOCKER",
        "name" :"Bar Mario snc",
        "address":"Via mario rossi",
        "city":"Varese",
        "state":"VA",
        "country":"IT",
        "postalCode":"21100",
        "description":"Note"
      }
    }]
  }
}

getOrders

getOrders permette di ricevere la lista degli ordini importati da Qapla'.

GEThttps://api.qapla.it/1.2/getOrders/?apiKey=[API_KEY]&[DATE]

REQUEST
RESPONSE

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 Body`200`

deleteOrder

deleteOrder permette di eliminare un ordine.

DELETEhttps://api.qapla.it/1.2/deleteOrder/

REQUEST
RESPONSE

Parametri

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

Response Body`200`

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/

REQUEST
RESPONSE

Parametri

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

Response Body`200`

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:

Peso	COD	CAP
minore o uguale a 3Kg			GLS
maggiore di 3Kg	minore di 100€		BRT
maggiore di 3Kg	maggiore di 100€	minore di 70000 (nord)	GLS
maggiore di 3Kg	maggiore 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
RESPONSE

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 Body`200`

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.

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

REQUEST
RESPONSE

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
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 Body`200`

{
                "fetchPlatformOrders": {
                "version": "1.2.34",
                "result": "OK",
                "error": null,
                "platform": "ibs",
                "dateFrom": "2020-10-27 11:00:00",
                "dateTo": "2020-10-27 23:59:59",
                "format": "qapla",
                "count": 14,
                "orders": [
                {
                "source": "ibs",
                "reference": "44725530-A",
                "orderID": null,
                "courier": 0,
                "status": "SHIPPING",
                "createdAt": "2020-10-27 12:11:26",
                "updatedAt": "2020-10-27 12:45:13",
                "name": "Marty McFly",
                "address": "Via Sciesa, 10",
                "city": "Vedano Olona",
                "state": "VA",
                "postCode": "21040",
                "country": "IT",
                "email": null,
                "telephone": "3211234567",
                "amount": "EUR 15.1",
                "payment": "CC",
                "isCOD": false,
                "notes": null,
                "weight": null,
                "content": null,
                "rows": [
                {
                "sku": "IBSMP1234567",
                "name": "Ritorno al futuro",
                "qty": 1,
                "price": 10.2,
                "total": 15.1,
                "url": null,
                "imgUrl": null,
                "weight": null
                }
                ]
                }
                ]
                }
                }

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/

REQUEST
RESPONSE

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
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 Body`200`

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/

REQUEST
RESPONSE

Test

È possibile ottenere una "dummy label" di test utilizzando il corriere avente codice GENERIC.

Request

{
  "apiKey": "[API_KEY]",
  "sandbox": true,
  "createLabel": {
    "origin": "magento",
    "reference": "BAT-234241299",
    "orderID": 123213,
    "courier": "CRONO-PTI",
    "courierService": "P46",
    "name": "Barbara Gordon",
    "address": "Via manin, 8",
    "city": "Vigonza",
    "state": "PD",
    "postCode": "35010",
    "country": "IT",
    "email": "batgirl@yahoo.it",
    "telephone": "3473425220",
    "isCOD": false,
    "payment": "Foo",
    "amount": 109.2548,
    "notes": "Consegnare solo se in costume nero",
    "weight": 1.3,
    "parcels": 1,
    "length": 10,
    "width": 15,
    "height": 5,
    "shippingCODPaymentOption": "",
    "shippingInsurance": 300.99,
    "shippingDeliveryOptions": "A,P",
    "shippingRequiredDeliveryDate": "YYYY-MM-DD",
    "pickupDate": "YYYY-MM-DD",
    "gSpedPrinterID": 22,
    "content": "The goods",
    "custom1": "Custom 1",
    "custom2": "Custom 2",
    "custom3": "Custom 3",
    "sender": {
      "code": "FEDO",
      "businessName": "fedò snc",
      "street": "Via I Maggio, 11",
      "city": "Vedano Olona",
      "state": "VA",
      "postCode": "21040",
      "country ": "IT",
      "email": "evelina@fedo.it",
      "telephone": "0332261261",
      "referent": "Evelina",
      "isDefault": false
    },
    "tradeDocuments": [
      {
        "type": "CERTIFICATE_OF_ORIGIN",
        "name": "FILENAME.PDF",
        "content": "BASE64PDF"
      },
      {
        "type": "OTHER",
        "name": "FILENAME2.PDF",
        "content": "BASE64PDF"
      },
      {
        "type": "CERTIFICATE_OF_ORIGIN",
        "name": "FILENAME3.PDF",
        "content": "BASE64PDF"
      }
    ],
    "rows": [
      {
        "sku": "BAR-301",
        "name": "Barrette di Crusca d'Avena con Cioccolato (4 pezzi) 120g",
        "qty": 1,
        "weight": 1.5,
        "url": "https://www.iltuosito.it/alimenti/barretta-al-cocco",
        "imageUrl": "https://www.iltuosito.it/img/alimenti/barretta-al-cocco.jpg",
        "price": 6.35,
        "total": 6.35,
        "isReturnable": true,
        "notes": "this is a product note"
      },
      {
        "sku": "BEV-001",
        "name": "Bevanda al mango in polvere 9g",
        "qty": 5,
        "weight": 1,
        "url": "https://www.iltuosito.it/alimenti/barretta-al-cocco",
        "imageUrl": "https://www.iltuosito.it/img/alimenti/barretta-al-cocco.jpg",
        "price": 0.38,
        "total": 1.9,
        "isReturnable": true
      }
    ],
    "PUDO": {
      "id": "1234",
      "type": "LOCKER",
      "name": "Bar Mario snc",
      "address": "Via mario rossi",
      "city": "Varese",
      "state": "VA",
      "country": "IT",
      "postalCode": "21100",
      "description": "Note"
    }
  }
}

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
                            

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 o il codice tariffa di BRT

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): elenco codici servizi

shippingInsurance(float)

Generale
GLS-ITA
SDA

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)

Generale
PTI

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

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**
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

Response Body`200`

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/

REQUEST
RESPONSE

Parametri

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

Response Body`200`

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]

REQUEST
RESPONSE

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

Response Body`200`

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
RESPONSE

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 Body`200`

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.

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]

REQUEST
RESPONSE

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:

	at	Austria
	be	Belgio
	ch	Svizzera
	cn	Cina
	cy	Cipro
	cz	Repubblica Ceca
	de	Germania
	dk	Danimarca
	ee	Estonia
	es	Spagna
	eu
	fi	Finlandia
	fr	Francia
	gb	Regno Unito
	global
	gr	Grecia
	hk	Hong Kong
	hr	Croazia
	hu	Ungheria
	ie	Irlanda
	it	Italia
	kr	Corea del Sud
	lt	Lituania
	lv	Lettonia
	mt	Malta
	my	Malaysia
	nl	Paesi Bassi
	pl	Polonia
	pt	Portogallo
	ru	Russia
	se	Svezia
	si	Slovenia
	us	USA
	za	Sud Africa

code

Il codice Qapla' del corriere

code=BRT

Response Body`200`

Il seguente URL

GEThttps://api.qapla.it/1.2/getCouriers/?apiKey=[API_KEY]&country=global

darà come risultato:

{"getCouriers":{"result":"OK","error":null,"version":"1.2.5","count":12,"couriers":[{"code":"ARAMEX","name":"Aramex","country":"global","url":"http://www.aramex.com","trackingURL":"https://www.aramex.com/track-results-multiple.aspx?ShipmentNumber=[TRACKING_NUMBER]"},{"code":"DBSCHENKER","name":"DB Schenker","country":"global","url":"https://www.dbschenker.com/","trackingURL":"https://eschenker.dbschenker.com/nges-portal/public/en-GB_GB/#!/tracking/schenker-search?refNumber=[TRACKING_NUMBER]"},{"code":"DHL","name":"DHL Express","country":"global","url":"http://www.dhl.com/","trackingURL":"http://www.dhl.it/content/it/it/express/ricerca.shtml?brand=DHL&AWB=[TRACKING_NUMBER]"},{"code":"DHL-FREIGHT","name":"DHL Freight","country":"global","url":"https://www.logistics.dhl","trackingURL":"https://www.logistics.dhl/global-en/home/tracking/tracking-freight.html?tracking-id=[TRACKING_NUMBER]"},{"code":"DPD","name":"DPD","country":"global","url":"http://www.dpd.com/","trackingURL":"https://tracking.dpd.de/status/en_US/parcel/[TRACKING_NUMBER]"},{"code":"DSV","name":"DSV","country":"global","url":"http://www.dsv.com/","trackingURL":"https://www.tracktrace.dsv.com/newtracking/public/showShipment.jsp?mode=roaddetails&sid=[TRACKING_NUMBER]"},{"code":"FEDEX","name":"FedEx","country":"global","url":"http://www.fedex.com/","trackingURL":"https://www.fedex.com/apps/fedextrack/?action=track&cntry_code=it&trackingnumber=[TRACKING_NUMBER]"},{"code":"ONTRAC","name":"OnTrac","country":"global","url":"http://www.ontrac.com","trackingURL":"https://www.ontrac.com/trackingdetail.asp?run=&tracking=[TRACKING_NUMBER]"},{"code":"SKYNET","name":"SkyNet Worldwide Express","country":"global","url":"http://www.skynetwwe.com/","trackingURL":"https://iskynettrack.skynetwwe.info/ShipmentTrackSingle.aspx?textfield=[TRACKING_NUMBER]"},{"code":"TNT","name":"TNT","country":"global","url":"http://www.tnt.com","trackingURL":"https://www.tnt.com/express/it_it/site/home/applications/tracking.html?cons=[TRACKING_NUMBER]"},{"code":"TOLL","name":"Toll Group","country":"global","url":"https://www.tollgroup.com/","trackingURL":"https://www.mytoll.com/?externalSearchQuery=[TRACKING_NUMBER]"},{"code":"UPS","name":"UPS","country":"global","url":"http://www.ups.com/","trackingURL":"http://wwwapps.ups.com/WebTracking/track?HTMLVersion=5.0&loc=it_IT&Requester=UPSHome&WBPM_lid=homepage%2Fct1.html_pnl_trk&track.x=Ricerca&trackNums=[TRACKING_NUMBER]"}]}}

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]

REQUEST
RESPONSE

Parametri

Parametro	Descrizione
apiKey	la API Key assegnata al canale che vogliamo interrogare
trackingNumber	Il tracking number da identificare

Response Body`200`

apiVirtual

apiVirtual permette di aggiornare lo stato di una spedizione del corriere virtuale.

POSThttps://api.qapla.it/virtual/

REQUEST
RESPONSE

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 Body`200`

Errori

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

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]

REQUEST
RESPONSE

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 Body`200`

getCredits

getCredits permette di ottenere i crediti rimanenti sul proprio account premium.

GEThttps://api.qapla.it/1.2/getCredits/?apiKey=[API_KEY]

REQUEST
RESPONSE

Parametri

Parametro	Descrizione
apiKey	la API Key assegnata al canale che vogliamo interrogare

Response Body`200`

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]

REQUEST
RESPONSE

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 Body`200`

{"getQaplaStatus":{"result":"OK","error":null,"qaplaStatus":[{"statusID":0,"status":"ATTESA ELABORAZIONE","statusDescription":"La gestione automatica di interrogazione del corriere non è ancora stata eseguita.","color":"#ecf0f1","icon":"https://cdn.qapla.it/status/0.svg","statusDetailID":0,"statusDetail":null,"statusDetailDescription":null},{"statusID":1,"status":"IN SOSPESO","statusDescription":"La spedizione è stata trovata ma non ci sono ancora notizie da parte del corriere.","color":"#abbad4","icon":"https://cdn.qapla.it/status/1.svg","statusDetailID":0,"statusDetail":null,"statusDetailDescription":null},{"statusID":2,"status":"ATTESA RITIRO","statusDescription":"Il corriere non ha ancora ritirato la spedizione.","color":"#35495e","icon":"https://cdn.qapla.it/status/2.svg","statusDetailID":0,"statusDetail":null,"statusDetailDescription":null},{"statusID":20,"status":"PARTITO","statusDescription":"La spedizione è partita.","color":"#8A2BE2","icon":"https://cdn.qapla.it/status/20.svg","statusDetailID":0,"statusDetail":null,"statusDetailDescription":null},{"statusID":3,"status":"IN TRANSITO","statusDescription":"La merce è in transito.","color":"#1D76D8","icon":"https://cdn.qapla.it/status/3.svg","statusDetailID":0,"statusDetail":null,"statusDetailDescription":null},{"statusID":50,"status":"IN LAVORAZIONE","statusDescription":"Spedizione in lavorazione","color":"#BDB76B","icon":"https://cdn.qapla.it/status/50.svg","statusDetailID":0,"statusDetail":null,"statusDetailDescription":null},{"statusID":4,"status":"IN CONSEGNA","statusDescription":"Spedizione in consegna.","color":"#376600","icon":"https://cdn.qapla.it/status/4.svg","statusDetailID":0,"statusDetail":null,"statusDetailDescription":null},{"statusID":5,"status":"TENTATIVO DI CONSEGNA FALLITO","statusDescription":"La consegna è fallita. Pre-allarme per possibili problemi.","color":"#FF6E00","icon":"https://cdn.qapla.it/status/5.svg","statusDetailID":0,"statusDetail":null,"statusDetailDescription":null},{"statusID":8,"status":"RITARDO","statusDescription":"La spedizione sta subendo dei ritardi.","color":"#e9be57","icon":"https://cdn.qapla.it/status/8.svg","statusDetailID":0,"statusDetail":null,"statusDetailDescription":null},{"statusID":6,"status":"ECCEZIONE","statusDescription":"Viene segnalato un qualche problema che può essere generico o spiegato da ulteriori icone.","color":"#970D00","icon":"https://cdn.qapla.it/status/6.svg","statusDetailID":0,"statusDetail":null,"statusDetailDescription":null},{"statusID":6,"status":"ECCEZIONE","statusDescription":null,"color":"#970D00","icon":"https://cdn.qapla.it/status/6-1.svg","statusDetailID":1,"statusDetail":"GIACENZA","statusDetailDescription":"La spedizione è in giacenza"},{"statusID":6,"status":"ECCEZIONE","statusDescription":null,"color":"#970D00","icon":"https://cdn.qapla.it/status/6-2.svg","statusDetailID":2,"statusDetail":"SPEDIZIONE IN RIENTRO / RIFIUTATA","statusDetailDescription":"La spedizione è stata rifiutata e la merce è in rientro."},{"statusID":6,"status":"ECCEZIONE","statusDescription":null,"color":"#970D00","icon":"https://cdn.qapla.it/status/6-3.svg","statusDetailID":3,"statusDetail":"DANNEGGIAMENTO","statusDetailDescription":"Il corriere segnala che la merce risulta danneggiata."},{"statusID":6,"status":"ECCEZIONE","statusDescription":null,"color":"#970D00","icon":"https://cdn.qapla.it/status/6-4.svg","statusDetailID":4,"statusDetail":"SMARRIMENTO","statusDetailDescription":"Il corriere segnala che la merce risulta smarrita."},{"statusID":10,"status":"PUNTO DI RITIRO","statusDescription":"La spedizione è stata consegnata in un Punto di Ritiro.","color":"#FFDE00","icon":"https://cdn.qapla.it/status/10.svg","statusDetailID":0,"statusDetail":null,"statusDetailDescription":null},{"statusID":95,"status":"RIENTRATO","statusDescription":"La spedizione è rientrata al mittente.","color":"#620000","icon":"https://cdn.qapla.it/status/95.svg","statusDetailID":0,"statusDetail":null,"statusDetailDescription":null},{"statusID":99,"status":"CONSEGNATO","statusDescription":"La spedizione è stata consegnata al destinatario.","color":"#66cc00","icon":"https://cdn.qapla.it/status/99.svg","statusDetailID":0,"statusDetail":null,"statusDetailDescription":null}]}}

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
RESPONSE

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 Body`200`

{
  "getPudos": {
    "data": [
      {
        "courier": "DHLPARCEL-ES",
        "statusCode": 200,
        "servicePointList": [
          {
            "ID": "8055-ES-0005466",
            "name": "BLUE LINE technology",
            "businessDays": [
              {
                "day": 2,
                "dayName": "Tuesday",
                "dayNameIT": "martedì",
                "businessHours": [
                  {
                    "open": "09:30",
                    "close": "13:30"
                  },
                  {
                    "open": "17:30",
                    "close": "20:30"
                  }
                ]
              },
              {
                "day": 3,
                "dayName": "Wednesday",
                "dayNameIT": "mercoledì",
                "businessHours": [
                  {
                    "open": "09:30",
                    "close": "13:30"
                  },
                  {
                    "open": "17:30",
                    "close": "20:30"
                  }
                ]
              },
              {
                "day": 4,
                "dayName": "Thursday",
                "dayNameIT": "giovedì",
                "businessHours": [
                  {
                    "open": "09:30",
                    "close": "13:30"
                  },
                  {
                    "open": "17:30",
                    "close": "20:30"
                  }
                ]
              },
              {
                "day": 5,
                "dayName": "Friday",
                "dayNameIT": "venerdì",
                "businessHours": [
                  {
                    "open": "09:30",
                    "close": "13:30"
                  },
                  {
                    "open": "17:30",
                    "close": "20:30"
                  }
                ]
              },
              {
                "day": 6,
                "dayName": "Saturday",
                "dayNameIT": "sabato",
                "businessHours": [
                  {
                    "open": "10:00",
                    "close": "14:00"
                  }
                ]
              }
            ],
            "telephone": null,
            "distance": 0.664,
            "holidays": [],
            "notes": null,
            "availableServices": [
              {
                "serviceDescription": "parcel:pick-up"
              },
              {
                "serviceDescription": "franking"
              },
              {
                "serviceDescription": "handicapped-access"
              },
              {
                "serviceDescription": "cash-service"
              },
              {
                "serviceDescription": "parcel:drop-off"
              }
            ],
            "courierSpecific": [
              {
                "name": "harmonisedId",
                "value": "102"
              },
              {
                "name": "psfKey",
                "value": "ES-0005466"
              },
              {
                "name": "keyword",
                "value": "DHL Servicepoint"
              }
            ],
            "type": "SHOP",
            "pushOrderPUDO": {
              "id": "8055-ES-0005466",
              "courierID": 0,
              "type": null,
              "name": null,
              "address": "C/Salvado espriu 2",
              "city": "Sant Just Desvern",
              "state": null,
              "country": "ES",
              "postalCode": "08960",
              "description": null,
              "psfKey": "ES-0005466",
              "keyword": "DHL Servicepoint",
              "postnumber": "",
              "harmonisedId": "102"
            },
            "street": "C/Salvado espriu 2",
            "postCode": "08960",
            "city": "Sant Just Desvern",
            "province": null,
            "country": "ES",
            "coordinates": {
              "latitude": 41.37976,
              "longitude": 2.071
            }
          }
        ],
        "error": ""
      },
      {
        "courier": "UPS",
        "statusCode": 200,
        "servicePointList": [
          {
            "ID": "114732",
            "name": "ELECTRODOMESTICS A. MURCIANO",
            "businessDays": [
              {
                "day": 1,
                "dayName": "Monday",
                "dayNameIT": "lunedì",
                "businessHours": [
                  {
                    "open": "09:00",
                    "close": "13:30"
                  },
                  {
                    "open": "17:00",
                    "close": "20:00"
                  }
                ]
              },
              {
                "day": 2,
                "dayName": "Tuesday",
                "dayNameIT": "martedì",
                "businessHours": [
                  {
                    "open": "09:00",
                    "close": "13:30"
                  },
                  {
                    "open": "17:00",
                    "close": "20:00"
                  }
                ]
              },
              {
                "day": 3,
                "dayName": "Wednesday",
                "dayNameIT": "mercoledì",
                "businessHours": [
                  {
                    "open": "09:00",
                    "close": "13:30"
                  },
                  {
                    "open": "17:00",
                    "close": "20:00"
                  }
                ]
              },
              {
                "day": 4,
                "dayName": "Thursday",
                "dayNameIT": "giovedì",
                "businessHours": [
                  {
                    "open": "09:00",
                    "close": "13:30"
                  },
                  {
                    "open": "17:00",
                    "close": "20:00"
                  }
                ]
              },
              {
                "day": 5,
                "dayName": "Friday",
                "dayNameIT": "venerdì",
                "businessHours": [
                  {
                    "open": "09:00",
                    "close": "13:30"
                  },
                  {
                    "open": "17:00",
                    "close": "20:00"
                  }
                ]
              }
            ],
            "telephone": "",
            "distance": 0.6,
            "holidays": [],
            "notes": "At the end of c / Major, and next to La Mallola",
            "availableServices": [
              {
                "serviceCode": "001",
                "serviceDescription": "Direct To Retail"
              },
              {
                "serviceCode": "002",
                "serviceDescription": "Not In One ADL"
              },
              {
                "serviceCode": "004",
                "serviceDescription": "Retail to Retail"
              },
              {
                "serviceCode": "007",
                "serviceDescription": "PUDO"
              },
              {
                "serviceCode": "010",
                "serviceDescription": "DCO DCR intercept accepted"
              },
              {
                "serviceCode": "011",
                "serviceDescription": "Accepts Payments"
              },
              {
                "serviceCode": "012",
                "serviceDescription": "Pay-At-Store"
              },
              {
                "serviceCode": "015",
                "serviceDescription": "Accepts Mobile Barcodes"
              }
            ],
            "courierSpecific": [],
            "type": "SHOP",
            "pushOrderPUDO": {
              "id": "114732",
              "courierID": 0,
              "type": null,
              "name": "ELECTRODOMESTICS A. MURCIANO",
              "address": "CL MARAGALL, 2",
              "city": "SANT JUST DESVERN",
              "state": null,
              "country": "ES",
              "postalCode": "08960",
              "description": null,
              "psfKey": null,
              "keyword": null,
              "postnumber": null,
              "harmonisedId": null
            },
            "street": "CL MARAGALL, 2",
            "postCode": "08960",
            "city": "SANT JUST DESVERN",
            "province": null,
            "country": "ES",
            "coordinates": {
              "latitude": 41.3818016,
              "longitude": 2.081099987
            }
          }
        ],
        "error": ""
      }
    ],
    "result": "OK"
  }
}

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”

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;
</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

Parametro	Descrizione
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.

Risultato

Il risultato è un HTML che verrà inserito dentro l'elemento con id qapla-tracking avente il seguente contenuto.

Qapla' Status

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

id	detailID	Nome	Descrizione
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.

Codice	Nome	URL
FOURPX	4PX	http://express.4px.com/
AG-LOGISTICA	AG Logistica	http://www.aglogisticasrl.it/
AIR-EXPRESS-IT	Air Express	https://airexpress.it/
ALIEXPRESS	Aliexpress	https://www.aliexpress.com/‎
ALPI	Alpi World	https://www.alpiworld.com/
AMATI-JR	Amati JR	http://www.amatijrtrasporti.it/
AMAZON-SHIPPING	Amazon Shipping	https://shipping.amazon.co.uk/
AN-POST	An Post	https://www.anpost.com/
APP2DELIVERY	App2delivery
ARAMEX	Aramex	http://www.aramex.com
ARCO	Arco Spedizioni	http://www.arco.it/
ASENDIA	Asendia Europe	https://www.asendia.com
ASENDIA-DE	ASENDIA Germany	http://www.asendia.de/
ASENDIA-USA	ASENDIA USA	http://www.asendiausa.com/
ASM	ASM	http://www.asmred.com
AUSTRALIA-POST	Australia Post	https://auspost.com.au/
AUSTRIAN-POST	Austrian Post	https://www.post.at
BETSERVICE	B&T Service	http://www.betservice.net/
BELPOCHTA	Belpochta	https://belpost.by/
BIZ-COURIER	Biz Courier	https://www.bizcourier.eu/
BPOST	BPost	https://track.bpost.be
BRACCHI	Bracchi	https://www.bracchi.it/
BRAZIL-CORREIOS	Brazil Correios	http://correios.com.br/
BRT	BRT	http://www.brt.it
BULGARIAN-POSTS	Bulgarian Posts	https://www.bgpost.bg/en
CBL-LOGISTICA	CBL Logistica	http://www.cbl-logistica.com
CELERITAS	Celeritas	https://celeritastransporte.com/
CZECH-POST	Česká pošta	https://www.ceskaposta.cz
CEVA-LOGISTICS	Ceva Logistics	https://www.cevalogistics.com/
CHINA-EMS	China EMS	http://www.11183.com.cn/english.html
CHINA-POST	China Post	http://www.chinapost.com.cn/
CHRONOPOST-FR	Chronopost France	http://www.chronopost.fr/
CNE-EXPRESS	CNE Express	http://www.cnexps.com/
COLDLINE	Coldline	https://www.coldlinegroup.com/
COLIS-PRIVE	Colis Privé	https://www.colisprive.com
COLISSIMO	Colissimo	http://www.colissimo.fr
CORREOS	Correos	http://www.correos.es
CORREOS-EXPRESS	Correos Express	https://www.correosexpress.com
COURIER-EXPRESS-IT	Courier expres	http://www.spacecomputer-web.it/web/courier
CRONO-PTI	Crono Poste	http://www.poste-impresa.it/online/pmi/postali/italia/crono-gamma.shtml
CRONO-REVERSE	Crono Reverse	https://business.poste.it/professionisti-imprese/prodotti/crono-reverse-gestione-resi-ecommerce.html
CTS_GROUP	CTS GROUP	https://www.ctsgroup.nl/en/
CTT	CTT	https://www.ctt.pt
CYPRUS-POST	Cyprus Post	https://www.cypruspost.post/
DAC-IT	D.A.C	https://dac-it.com/
DBSCHENKER	DB Schenker	https://www.dbschenker.com/
DEUTSCHE-POST	Deutsche Post	https://www.deutschepost.de/
DHL-DE	Deutsche Post DHL	http://www.dpdhl.com/
DHL-ECOMMERCE	DHL eCommerce	http://webtrack.dhlglobalmail.com/
DHL	DHL Express	http://www.dhl.com/
DHL-FREIGHT	DHL Freight	https://www.logistics.dhl
DHL-PAKET	DHL Paket	https://www.dhl.de/
DHLPARCEL-NL	DHL Parcel NL	https://www.dhlparcel.nl/
DHLPARCEL-ES	DHL Parcel Spain	https://www.dhlparcel.es
DMM	DMM Network	http://www.dmmnetwork.it/
DPD	DPD	http://www.dpd.com/
DPD-FR	DPD France	http://www.dpd.fr
DPD-UK	DPD UK	http://www.dpd.co.uk/
DSV	DSV	http://www.dsv.com/
ELTA-HELLENIC-POST	ELTA Hellenic Post	https://www.elta.gr
EMIRATES-POST	Emirates Post	https://www.epg.gov.ae/
ENERGO-LOGISTIC	Energo Logistic	https://www.energologistic.it/
ENVIALIA	Envialia	http://www.envialia.com/
FAST-WL	FAST WORLD LOGISTIC	http://www.fastwl.com/
FEDEX	FedEx	http://www.fedex.com/
FERCAM	FERCAM Logistics	http://www.fercam.com/
FERMOPOINT	Fermopoint	https://www.fermopoint.it
FINESSO	Finesso	https://www.finesso.it/
GEODIS	Geodis	https://geodis.com/
GLOBALTR	Global Trasporti	http://www.globaltrasporti.com/
GLS-ITA	GLS	http://www.gls-italy.com
GLS	GLS Europe	https://gls-group.eu/
GLS-EUROPE-WW	GLS Europe WW	https://gls-group.eu/GROUP/en/home
GLS-FR	GLS France	https://gls-group.eu/FR/fr/home
GLS-SPAIN	GLS Spain	https://m.gls-spain.es/
GO-EXPRESS	GO! Express & Logistics	https://www.general-overnight.com
HERMES-DE	Hermes Germany	https://www.myhermes.de
HERMES-IT	Hermes Italy	http://www.hermes-italy.it/
HERMES	Hermes UK	https://www.myhermes.co.uk
HONG-KONG-POST	Hong Kong Post	https://www.hongkongpost.hk/en/home/index.html
HRP	HR Parcel	https://www.hrparcel.com/
HRVATSKA-POSTA	Hrvatska pošta	https://www.posta.hr
INPOST	InPost	https://inpost.it/
INSTALLO	Installo	https://www.installo.it/
INTEGRA2	Integra2	https://www.integra2.es/
JERSEY-POST	Jersey Post	https://www.jerseypost.com/
KOREA-POST	Korea Post	https://www.epost.go.kr
LA-POSTE	La Poste	https://www.laposte.fr/
LATVIJAS-PASTS	Latvijas Pasts	https://pasts.lv/
LICCARDI	Liccardi Trasporti	https://www.liccarditrasporti.com/
LIETUVOS-PASTAS	Lietuvos PaÅ¡tas	https://www.post.lt/
LUXEMBOURG-POST	Luxembourg Post	https://www.post.lu
MAGYAR-POSTA	Magyar Posta	https://www.posta.hu/
MBE-IT	Mail Boxes Etc. Italia	https://www.mbe.it/
MALTA-POST	Malta Post	https://www.maltapost.com/
MILKMAN	Milkman	https://www.milkman.it/
MONDIALRELAY	Mondial Relay	https://www.mondialrelay.fr
MRW-ES	MRW	http://www.mrw.es/
NACEX-ES	Nacex	https://www.nacex.es/
NEXIVE	Nexive	http://www.nexive.it/
NOPAR	Nopar Solutions	http://noparsolutions.com/
OMNIVA	Omniva	https://www.omniva.ee
ONEXP	One Express	http://www.oneexpress.it
ONTRAC	OnTrac	http://www.ontrac.com
PAACK	Paack
PACKETA	Packeta	https://tracking.packeta.com/
PALLETW	Palletways	http://www.palletways.com
PALLEX	Pallex	https://www.pallex.it/
PARCEL-FORCE	Parcel Force	http://www.parcelforce.com
POCZTA-POLSKA	Poczta Polska	http://www.poczta-polska.pl
POS-MALAYSIA	Pos Malaysia	https://www.pos.com.my/
POSTA-ROMANA	Poșta Română	https://www.posta-romana.ro/
SLOVENIA-POST	Pošta Slovenije	https://www.posta.si
PTI	Poste Italiane	http://www.poste.it
POSTEN-NORGE	Posten Norge	https://www.posten.no/
POSTI	Posti	https://www.posti.fi/
POSTNL-INT	PostNL International	http://www.postnl.post/
POSTNL-3S	PostNL International 3S	https://www.internationalparceltracking.com
POSTNORD-DENMARK	PostNord Denmark	https://www.postnord.dk
POSTNORD-SWEDEN	PostNord Sweden	https://www.postnord.se/
QHD	QHD	https://www.qhditalia.it/
RDA	Ramoneda	http://www.ramoneda.com/
REDUR	Redur
ROYAL-MAIL	Royal Mail	http://www.royalmail.com
RPOST	RPost	https://www.errepost.it/
RUSSIAN-POST	Russian Post	https://www.pochta.ru
SF-EXPRESS	S.F. Express	http://www.sf-express.com
SAILPOST	Sailpost	http://www.sailpost.it
SMM-IT	San Marino Mail	http://www.sanmarinomail.sm
SDA	SDA	http://wwww.sda.it
SDA-RACCOMANDATA	SDA Raccomandata	http://wwww.sda.it
SENDABOX	Sendabox	http://www.sendabox.it
SENDING	Sending Transporte Urgente	https://www.sending.es
SEUR	Seur	http://www.seur.com
SGT	SGT Corriere Espresso	http://www.sgt.it/
SINOTRANS	Sinotrans	http://www.sinotrans-csc.com/
SKYNET-ITA	SkyNet Italy	http://www.skynetitaly.it
SKYNET	SkyNet Worldwide Express	http://www.skynetwwe.com/
SOUTH-AFRICAN-POST	South African Post	https://www.postoffice.co.za
SPEDIAMO	Spediamo.it	http://www.spediamo.it/
SPRING-GDS	Spring GDS	https://www.spring-gds.com/
STEF-IT	STEF	https://www.stef.it/
SUSA	Susa	https://flex.susa.it/Home
SWISS-POST	Swiss Post	https://www.post.ch/
TWS	T.W.S. Express Courier	http://www.twsexpresscourier.it
TECNO-TRANS	Tecnotrans	http://www.tecnotrans.eu
TEMPO-ONE	Tempo One	https://www.tempo-one.com/
TIPSA	TIPSA	http://www.tip-sa.com/
TNT	TNT	http://www.tnt.com
TNT-CLICK	TNT Click	http://www.tnt-click.it
TNT-ES	TNT España	http://www.tnt.es
TNT-ITA	TNT Italia	https://www.tnt.it/
TNT-UK	TNT UK	http://www.tnt.com/express/en_gb/site/home.html
TOLL	Toll Group	https://www.tollgroup.com/
TOURLINE-EXPRESS	Tourline Express	http://www.tourlineexpress.com
TRAKPAK	Trakpak	http://www.trackmytrakpak.com
TYP	TYP	https://typ.delivery
UPS	UPS	http://www.ups.com/
USPS	USPS	https://www.usps.com/
YAMATO	Yamato Transport
YANWEN	Yanwen	http://www.yw56.com.cn/
YDH	Ydh	http://www.ydhex.com/
YODEL	Yodel Domestic	http://www.yodel.co.uk/
YUNEXPRESS	Yun Express	http://www.yunexpress.com/
ZELERIS-ES	Zeleris	https://www.zeleris.com/
ZUST	Züst Ambrosetti	http://www.zust.it/

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

Default	G	Q
Default	0
ASENDIA	G	Q
e-PAQ Plus	31
e-PAQ Select	32
BRT	G	Q
Express	0
Priority	1
10:30	2
Messaggeria	3
Circuito DPD	6
Circuito Euroexpress	7
Circuito Fedex	8
DPD Direct Infeed	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
Paq 14	21
Paq 24	22
Baleares Express	23
Canarias Express	24
Canarias Aéreo	25
Canarias Marítimo	26
54 Entrega Plus	31
International
Internacional Estándar	27
Internacional Express	28
Paq Empresa 14	29
ePaq 24	30
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	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 (non è possibile specificare il tipo di montaggio)	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
Nazionale Express Plus	2
Nazionale Standard	3
International
Internazionale Express	6
Internazionale Express Plus	7
Internazionale Standard	8
Internazionale Saver	9
Expedited	10
USA Next day air	21
USA 2nd day air	22
USA Ground	23

Introduzione

Versioni precedenti

Webhook

API Key

Endpoint

Response

Limiti di utilizzo

HTTP Response Status Codes

Abuse

Sandbox

Test

Postman Collection

Spedizioni

pushShipment

Request

Parametri

Response Body200

Errori

getShipment

Parametri

Response Body200

Descrizione

Errori

getShipments

Parametri

Response Body200

Descrizione

Errori

updateShipment

Parametri

Response Body200

deleteShipment

Parametri

Response Body200

undeleteShipment

Parametri

Response Body200

trackingByTimeFrame

Parametri

Response Body200

Descrizione

Ordini

pushOrder

Parametri

Response Body200

Descrizione

Errori

getOrder

Parametri

Response Body200

getOrders

Parametri

Response Body200

deleteOrder

Parametri

Response Body200

updateOrder

undeleteOrder

Parametri

Response Body200

detectOrderCourier

Request

Parametri

Response Body200

Errori

Platforms

fetchPlatformOrders

Parametri

Response Body200

Errori

updatePlatformOrder

Autenticazione

Parametri

Response Body200

Etichette

createLabel

Test

Request

Parametri

Response Body200

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`

Response Body`200`