IT
RESTful JSON API Ver. 1.2
rel. 1.2.98

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.

Rate limiting

The system uses the TokenBucket algorithm with the following parameters:

Bucket capacity 10 Maximum of ten requests
Tokens per second 1 Refilling at a rate of one 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.

        

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

        

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
1PENDINGShipment found but any news yet from courier.
2INFO RECEIVEDThe courier didn’t pick up the shipment yet.
20DEPARTEDShipment departed.
3IN TRANSITThe goods are in transit.
50PROCESSINGProcessing
4OUT FOR DELIVERYShipment in delivery.
5FAILED ATTEMPTDelivery failed. Early warning for potential problems.
8DELAYShipment is suffering delay.
6EXCEPTIONThere is a problem; generic or explained by additional icons.
10PICKUP POINTDelivered to a PickUp Point.
95RETURNEDShipment returned to sender.
99DELIVEREDThe shipment has been delivered to the recipient.
Status detail

Any additional status details.

idNamedetailIDNameDescription
6EXCEPTION1STOCK
6EXCEPTION2RETURN
6EXCEPTION3DAMAGED
6EXCEPTION4LOST

Couriers

List of Qapla's couriers' codes, in alphabetical order.
CodeNameURL
4PX 4PX 4PX http://express.4px.com/ cn
ALIEXPRESS ALIEXPRESS Aliexpress https://www.aliexpress.com/‎ cn
AMATI-JR AMATI-JR Amati JR http://www.amatijrtrasporti.it/ it
ARAMEX ARAMEX Aramex http://www.aramex.com global
ARCO ARCO Arco Spedizioni http://www.arco.it/ it
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
BRT BRT BRT http://www.brt.it it
CBL-LOGISTICA CBL-LOGISTICA CBL Logistica http://www.cbl-logistica.com es
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
CAQ-ITA CAQ-ITA Click & Quick http://spedire.online it
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
CTS_GROUP CTS_GROUP CTS GROUP https://www.ctsgroup.nl/en/ nl
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
DSV DSV DSV http://www.dsv.com/ global
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
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
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
INSTALLO INSTALLO Installo https://www.installo.it/ it
LA-POSTE LA-POSTE La Poste https://www.laposte.fr/ fr
MBE-IT MBE-IT Mail Boxes Etc. Italia https://www.mbe.it/ it
MILKMAN MILKMAN Milkman https://www.milkman.it/ it
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
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
PTI PTI Poste Italiane http://www.poste.it it
POSTNL-INT POSTNL-INT PostNL International http://www.postnl.post/ nl
RDA RDA Ramoneda http://www.ramoneda.com/ es
ROYAL-MAIL ROYAL-MAIL Royal Mail http://www.royalmail.com gb
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
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
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
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