IT
RESTful JSON API Ver. 1.2
rel. 1.2.98
Qapla' srl   •   06492420481

Introduction

Previous versions
Previous versions of this API are still active, but to be considered as deprecated.
Webhook
Qapla' also has a Webhook service which is an integral part of the API.

API Key

To be able to use the APIs you need to be aware of the Private API Keys assigned to your channel(s), which can be found on the Control Panel under:
Settings \ [CHANNEL_NAME]

This API key must be protected and kept secret.

API Key

Endpoint

https://api.qapla.it/[API_VERSION]/[ENDPOINT]
[API_VERSION]is the versioning value of the API.
[ENDPOINT]is the endpoint you need to call.

Response

The JSON response to a Request uses this standard format

    
[API_NAME]The name of the API consumed
[OK/KO]OK in case of a positive answer, KO In case of an error
[ERROR_MESSAGE]It is null in case of OK and will contain the error in case of KO

Rate limiting

The system uses the TokenBucket algorithm with the following parameters:

Bucket capacity 120 Maximum of 120 requests
Tokens per second 2 Refilling at a rate of 2 per second
HTTP Response Status Codes
Exceeding the limit will lead to the following HTTP response
429 Too Many Requests
and the following response error by any API involved
"error": "Too Many Requests"
Abuse
The abuse of the use will lead to a BAN of the API Key.

Test

Once you get the API Key you can immediately make a connection test using the getChannel API.

SDK

PHP

pushShipment

pushShipment allows you to upload one or more shipments through a POST of data in JSON format.

In combination with the Webhook creates an integrated shipping management system.

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

In this example, two shipments are loaded, one in "minimum" and one "complete" format.



            

        
Response Body200


                
Errors

In case of error, each shipping line will be reported:


        

pushOrder

pushOrder allows you to upload one or more orders via a POST of data in JSON format.
POSThttps://api.qapla.it/1.2/pushOrder/


            
        
Response Body200


            

            
Errors
The error message is reported in the "error" field.

        

Labels

createReturnLabel

createReturnLabel allows you to create a return label in PDF format.
POSThttps://api.qapla.it/1.2/createReturnLabel/


            
Parameters

*Mandatory parameter

Parameter Description
apiKey(string) Channel's API Key
sandbox(boolean) It is true if you want to use the sandbox (test mode)
orderReference(string)
orderID(string)
courier*(string) Qapla's courier code
weight(float)
parcels(int)
notes(string)
sender*

The sender of the shipment

firstName*(string)
lastName*(string)
address*(string)
city*(string)
state*(string)
postalCode*(string)
country*(string) The country of the sender in ISO 3166-1 alpha-2 format (Example: IT)
email(string)
phone(string)
consignee

The shipment consignee

It is NOTmandatory IF the recipient data is compiled on the Control Panel, otherwise the company data will be used.
company*(string)
address*(string)
city*(string)
state*(string)
postalCode*(string)
country*(string) The country of the sender in ISO 3166-1 alpha-2 format (Example: IT)
email(string)
phone(string)
Response Body200
The PDF of the label.



            
Errors
In case of an error the "result" field will contain "KO" and the error the description of the error.

getChannel

getChannel allows you to get information about the channel connected to the API Key and to the company that created it.
GEThttps://api.qapla.it/1.2/getChannel/?apiKey=[API_KEY]
Parametri
Parameter Description
apiKey the API Key assigned to the channel we want to query
Response Body200

        

Help

Qapla' Status

It's the interpretation of the status of the shipment with values that Qapla' assigns to each possible state of the courier.

idnameDescription
0 WAITING TO COMPUTE
1 PENDING Shipment found but any news yet from courier.
2 INFO RECEIVED The courier didn’t pick up the shipment yet.
20 DEPARTED Shipment departed.
3 IN TRANSIT The goods are in transit.
50 PROCESSING Processing
50 PROCESSING • CUSTOMS
4 OUT FOR DELIVERY Shipment in delivery.
5 FAILED ATTEMPT Delivery failed. Early warning for potential problems.
8 DELAY Shipment is suffering delay.
6 EXCEPTION There is a problem; generic or explained by additional icons.
6 EXCEPTION • STOCK
6 EXCEPTION • RETURN
6 EXCEPTION • DAMAGED
6 EXCEPTION • LOST
6 EXCEPTION • PARTIAL DELIVERY
10 PICKUP POINT Delivered to a PickUp Point.
95 RETURNED Shipment returned to sender.
99 DELIVERED The shipment has been delivered to the recipient.

Couriers

List of Qapla's couriers' codes, in alphabetical order.
CodeNameURL
4PX 4PX 4PX http://express.4px.com/ cn
AIR-EXPRESS-IT AIR-EXPRESS-IT Air Express https://airexpress.it/ it
ALIEXPRESS ALIEXPRESS Aliexpress https://www.aliexpress.com/‎ cn
AMATI-JR AMATI-JR Amati JR http://www.amatijrtrasporti.it/ it
AN-POST AN-POST An Post https://www.anpost.com/ ie
ARAMEX ARAMEX Aramex http://www.aramex.com global
ARCO ARCO Arco Spedizioni http://www.arco.it/ it
ASENDIA ASENDIA Asendia Europe https://www.asendia.com eu
ASENDIA-DE ASENDIA-DE ASENDIA Germany http://www.asendia.de/ de
ASENDIA-USA ASENDIA-USA ASENDIA USA http://www.asendiausa.com/ us
ASM ASM ASM http://www.asmred.com es
AUSTRIAN-POST AUSTRIAN-POST Austrian Post https://www.post.at at
BETSERVICE BETSERVICE B&T Service http://www.betservice.net/ it
BIZ-COURIER BIZ-COURIER Biz Courier https://www.bizcourier.eu/ gr
BPOST BPOST BPost https://track.bpost.be be
BRAZIL-CORREIOS BRAZIL-CORREIOS Brazil Correios http://correios.com.br/ br
BRT BRT BRT http://www.brt.it it
CBL-LOGISTICA CBL-LOGISTICA CBL Logistica http://www.cbl-logistica.com es
CZECH-POST CZECH-POST Česká pošta https://www.ceskaposta.cz cz
CHINA-EMS CHINA-EMS China EMS http://www.11183.com.cn/english.html cn
CHINA-POST CHINA-POST China Post http://www.chinapost.com.cn/ cn
CHRONOPOST-FR CHRONOPOST-FR Chronopost France http://www.chronopost.fr/ fr
CNE-EXPRESS CNE-EXPRESS CNE Express http://www.cnexps.com/ cn
COLIS-PRIVE COLIS-PRIVE Colis Privé https://www.colisprive.com fr
COLISSIMO COLISSIMO Colissimo http://www.colissimo.fr fr
CORREOS CORREOS Correos http://www.correos.es es
CORREOS-EXPRESS CORREOS-EXPRESS Correos Express https://www.correosexpress.com es
COURIER-EXPRESS-IT COURIER-EXPRESS-IT Courier expres http://www.spacecomputer-web.it/web/courier it
CRONO-PTI CRONO-PTI Crono Poste http://www.poste-impresa.it/online/pmi/postali/italia/crono-gamma.shtml it
CRONO-REVERSE CRONO-REVERSE Crono Reverse https://business.poste.it/professionisti-imprese/prodotti/crono-reverse-gestione-resi-ecommerce.html it
CTS_GROUP CTS_GROUP CTS GROUP https://www.ctsgroup.nl/en/ nl
CTT CTT CTT https://www.ctt.pt pt
CYPRUS-POST CYPRUS-POST Cyprus Post https://www.cypruspost.post/ cy
DAC-IT DAC-IT D.A.C https://dac-it.com/ it
DBSCHENKER DBSCHENKER DB Schenker https://www.dbschenker.com/ global
DHL-DE DHL-DE Deutsche Post DHL http://www.dpdhl.com/ de
DHL-ECOMMERCE DHL-ECOMMERCE DHL eCommerce http://webtrack.dhlglobalmail.com/ us
DHL DHL DHL Express http://www.dhl.com/ global
DHL-FREIGHT DHL-FREIGHT DHL Freight https://www.logistics.dhl global
DHL-PAKET DHL-PAKET DHL Paket https://www.dhl.de/ de
DHLPARCEL-NL DHLPARCEL-NL DHL Parcel NL https://www.dhlparcel.nl/ nl
DHLPARCEL-ES DHLPARCEL-ES DHL Parcel Spain https://www.dhlparcel.es es
DMM DMM DMM Network http://www.dmmnetwork.it/ it
DPD DPD DPD http://www.dpd.com/ global
DPD-FR DPD-FR DPD France http://www.dpd.fr fr
DPD-UK DPD-UK DPD UK http://www.dpd.co.uk/ gb
DSV DSV DSV http://www.dsv.com/ global
ELTA-HELLENIC-POST ELTA-HELLENIC-POST ELTA Hellenic Post https://www.elta.gr gr
EMIRATES-POST EMIRATES-POST Emirates Post https://www.epg.gov.ae/ ae
ENERGO-LOGISTIC ENERGO-LOGISTIC Energo Logistic https://www.energologistic.it/ it
ENVIALIA ENVIALIA Envialia http://www.envialia.com/ es
FAST-WL FAST-WL FAST WORLD LOGISTIC http://www.fastwl.com/ fr
FEDEX FEDEX FedEx http://www.fedex.com/ global
FERCAM FERCAM FERCAM Logistics http://www.fercam.com/ it
FERMOPOINT FERMOPOINT Fermopoint https://www.fermopoint.it it
FINESSO FINESSO Finesso https://www.finesso.it/ it
GLOBALTR GLOBALTR Global Trasporti http://www.globaltrasporti.com/ it
GLS-ITA GLS-ITA GLS http://www.gls-italy.com it
GLS GLS GLS Europe https://gls-group.eu/ eu
GLS-SPAIN GLS-SPAIN Gls Spain https://m.gls-spain.es/ es
HERMES-DE HERMES-DE Hermes Germany https://www.myhermes.de de
HERMES-IT HERMES-IT Hermes Italy http://www.hermes-italy.it/ it
HERMES HERMES Hermes UK https://www.myhermes.co.uk gb
HONG-KONG-POST HONG-KONG-POST Hong Kong Post https://www.hongkongpost.hk/en/home/index.html hk
HRVATSKA-POSTA HRVATSKA-POSTA Hrvatska pošta https://www.posta.hr hr
INSTALLO INSTALLO Installo https://www.installo.it/ it
JERSEY-POST JERSEY-POST Jersey Post https://www.jerseypost.com/ gb
KOREA-POST KOREA-POST Korea Post https://www.epost.go.kr kr
LA-POSTE LA-POSTE La Poste https://www.laposte.fr/ fr
LATVIJAS-PASTS LATVIJAS-PASTS Latvijas Pasts https://pasts.lv/ lv
LIETUVOS-PASTAS LIETUVOS-PASTAS Lietuvos Paštas https://www.post.lt/ lt
MAGYAR-POSTA MAGYAR-POSTA Magyar Posta https://www.posta.hu/ hu
MBE-IT MBE-IT Mail Boxes Etc. Italia https://www.mbe.it/ it
MALTA-POST MALTA-POST Malta Post https://www.maltapost.com/ mt
MILKMAN MILKMAN Milkman https://www.milkman.it/ it
MONDIALRELAY MONDIALRELAY Mondial Relay https://www.mondialrelay.fr fr
MRW-ES MRW-ES MRW http://www.mrw.es/ es
NACEX-ES NACEX-ES Nacex https://www.nacex.es/ es
NEXIVE NEXIVE Nexive http://www.nexive.it/ it
NOPAR NOPAR Nopar Solutions http://noparsolutions.com/ es
OMNIVA OMNIVA Omniva https://www.omniva.ee ee
ONEXP ONEXP One Express http://www.oneexpress.it it
ONTRAC ONTRAC OnTrac http://www.ontrac.com global
PALLETW PALLETW Palletways http://www.palletways.com eu
PARCEL-FORCE PARCEL-FORCE Parcel Force http://www.parcelforce.com gb
POCZTA-POLSKA POCZTA-POLSKA Poczta Polska http://www.poczta-polska.pl pl
POS-MALAYSIA POS-MALAYSIA Pos Malaysia https://www.pos.com.my/ my
SLOVENIA-POST SLOVENIA-POST Pošta Slovenije https://www.posta.si si
PTI PTI Poste Italiane http://www.poste.it it
POSTEN-NORGE POSTEN-NORGE Posten Norge https://www.posten.no/ no
POSTI POSTI Posti https://www.posti.fi/ fi
POSTNL-INT POSTNL-INT PostNL International http://www.postnl.post/ nl
POSTNL-3S POSTNL-3S PostNL International 3S https://www.internationalparceltracking.com nl
POSTNORD-DENMARK POSTNORD-DENMARK PostNord Denmark https://www.postnord.dk dk
POSTNORD-SWEDEN POSTNORD-SWEDEN PostNord Sweden https://www.postnord.se/ se
QHD QHD QHD https://www.qhditalia.it/ global
RDA RDA Ramoneda http://www.ramoneda.com/ es
ROYAL-MAIL ROYAL-MAIL Royal Mail http://www.royalmail.com gb
RUSSIAN-POST RUSSIAN-POST Russian Post https://www.pochta.ru ru
SF-EXPRESS SF-EXPRESS S.F. Express http://www.sf-express.com cn
SAILPOST SAILPOST Sailpost http://www.sailpost.it it
SMM-IT SMM-IT San Marino Mail http://www.sanmarinomail.sm it
SDA SDA SDA http://wwww.sda.it it
SDA-RACCOMANDATA SDA-RACCOMANDATA SDA Raccomandata http://wwww.sda.it it
SENDABOX SENDABOX Sendabox http://www.sendabox.it/ it
SENDING SENDING Sending Transporte Urgente https://www.sending.es es
SEUR SEUR Seur http://www.seur.com es
SGT SGT SGT Corriere Espresso http://www.sgt.it/ it
SINOTRANS SINOTRANS Sinotrans http://www.sinotrans-csc.com/ cn
SKYNET-ITA SKYNET-ITA SkyNet Italy http://www.skynetitaly.it it
SKYNET SKYNET SkyNet Worldwide Express http://www.skynetwwe.com/ global
SOUTH-AFRICAN-POST SOUTH-AFRICAN-POST South African Post https://www.postoffice.co.za za
SPEDIAMO SPEDIAMO Spediamo.it http://www.spediamo.it/ it
SWISS-POST SWISS-POST Swiss Post https://www.post.ch/ ch
TWS TWS T.W.S. Express Courier http://www.twsexpresscourier.it it
TECNO-TRANS TECNO-TRANS Tecnotrans http://www.tecnotrans.eu it
TIPSA TIPSA TIPSA http://www.tip-sa.com/ es
TNT TNT TNT http://www.tnt.com global
TNT-CLICK TNT-CLICK TNT Click http://www.tnt-click.it it
TNT-ES TNT-ES TNT España http://www.tnt.es es
TNT-ITA TNT-ITA TNT Italia https://www.tnt.it/ it
TNT-UK TNT-UK TNT UK http://www.tnt.com/express/en_gb/site/home.html gb
TOLL TOLL Toll Group https://www.tollgroup.com/ global
TOURLINE-EXPRESS TOURLINE-EXPRESS Tourline Express http://www.tourlineexpress.com es
TRAKPAK TRAKPAK Trakpak http://www.trackmytrakpak.com eu
UPS UPS UPS http://www.ups.com/ global
USPS USPS USPS https://www.usps.com/ us
YANWEN YANWEN Yanwen http://www.yw56.com.cn/ cn
YDH YDH Ydh http://www.ydhex.com/ cn
YODEL YODEL Yodel Domestic http://www.yodel.co.uk/ gb
YUNEXPRESS YUNEXPRESS Yun Express http://www.yunexpress.com/ cn
ZELERIS-ES ZELERIS-ES Zeleris https://www.zeleris.com/ es
ZUST ZUST Züst Ambrosetti http://www.zust.it/ it