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

Introduction

APIs provide the possibility to integrate Qapla' both for reading and writing with your own ecommerce system or for an e-commerce to which a plugin or connector has not yet been implemented.

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

API Key

In oder to use the APIs, it is necessary to know the Private API Keys assigned to your channel(s), available on the Control Panel in the section:
Settings \ [CHANNEL_NAME]

This API key must be protected and kept secret.

API Key

Endpoint

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

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.

Sandbox

“Is there a Sandbox?”

No, there is not a Sandbox. It is necessary only a API Key to start working directly.

Test

Once the API Key has been obtained, a connection test can be immediately performed using the API getChannel.

SDK

PHP

Shipments

The primary key to identify a shipment is:

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:


        

getShipment

getShipment allows you to read the status of a shipment through the tracking number, the order reference or the ID.

For a total and integrated management of the update cycle of shipments, also evaluate the Webhook.

🛈
Remember the usage limits and also evaluate the 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]
Parameters
Parameter Description
apiKey*(string) The API Key assigned to the channel we want to query
Exclusive parameters
trackingNumber(string) The interested tracking number
reference(string) The order reference
id(int) Shipment ID
custom1, custom2, custom3(string) The fields custom1, custom2, custom3
Optional parameters
lang The language of the names of the Qapla' status (it, en, es), default: it.

Example:

&lang=en
data

The flag data specifies which and how much data we want to receive, by default it returns minimal data on the progress of the shipment.
It can have the following values:

Parameter Description
If no parameter is specified, it will be returned the minimum data
all Minimum data + all the data to follow
consignee Minimum data + recipient data
children Minimum data + data of child shipments, if any
parent Minimum data + data of the parent shipment, if any
flag Minimum data + data relating to the report of the shipment, if any
notifications Minimum data + notification data (email sms, webhook, qaplAPP)
history Minimum data + shipment tracking history

The parameter can be combined separated by commas, for example

&data=consignee,history
in order to get only these data.
Response Body200


            
Description
result The result of the operation: OK or KO in case of error
error The error in case of result: KO
version The API version
lang The required language / transferred as parameter (default: it)
count Number of current shipments
shipments

It is an array that can contain more than one shipment

id Shipment ID
hash The hash of the shipment, used for example by the tracking page
url Web address of the tracking page of this shipment
reference Order reference
trackingNumber The tracking number
isDeleted It is true (boolean value) if the shipment is cancelled
isArchived It is true (boolean value) if the shipment is filed
origin The origin of the shipment if loaded (es: magento, prestashop, amazon, ecc)
courier
code Courier code
name Name of the courier
icon Icon's URL of the courier
note Possible notes from the courier on the shipment
estimatedDeliveryDate Possible estimated date of expected delivery
url Address URL of the courier
trackingURL Tracking URL address of the courier for this shipment
status

Current status of the shipment

date Status date, as reported by the courier
dateISO The ISO version YYYY-MM-DD HH:MM:SS of the date communicated by the courier
status Status communicated by the courier
place Location communicated by the courier
qaplaStatus

The "translation" of the status of the courier in the status of Qapla'

id The ID of the status
status The description
detailID ID of the possible detail
detail Description of the possible detail
color The color assigned by Qapla' to the status
icon Status icon
dateUpd The date in which the shipment status has been updated on Qapla'
lastCheck The date of the last control of the shipment status
shipDate The shipment date communicated when the shipment is loaded
orderDate The order date communicated when the shipment is loaded
dateIns The upload date of the shipment
consignee

Recipient data

name Recipient name
address Recipient address
city Recipient city
state Recipient province
country Recipient country
email Recipient email
isAmazon It is true (boolean value) if the recipient email is from Amazon
phone Recipient telephone number
language The language in which the shipment will "speak" when notifications such as email or SMS are sent
newTrackingNumber Possible new tracking number assigned to shipment
oldTrackingNumber Possible old tracking number in case it has been populated the field newTrackingNumber
hasNewTrackingNumber It is true (boolean value) if the shipment has obtained a new tracking number
isTrackingNumber It is true (boolean value) if the trackingNumber value contains the true tracking number
trueTrackingNumber It contains the potential "true" tracking number
altTrackingNumber It contains an alternative tracking number in case the shipment has changed it for the same courier during the trip
returnTrackingNumber It indicates any return tracking number if different from the outward one
isReturnShipment It is true (boolean value) if the shipment is a return / restitution shipment
isCOD It is true (boolean value) if the shipment is cash on delivery
amountText The textual amount of the shipment
amount The amount as a float number
isDelivered It is true (boolean value) if the shipment is delivered
isChild It is true (boolean value) if the shipment is "daughter" of another shipment, in this case the "parent" field will be populated
parent

The "father" shipment

id Shipment ID
reference The order reference of the shipment
trackingNumber The order tracking number of the shipment
courier The courier code of the shipment
url The URL to this same API to call back the "father" shipment
hasChildren It is true (boolean value) if the shipment has "children", in this case the "children" field will be populated
children

It is an array of "child" shipments

id Shipment ID
reference The order reference of the shipment
trackingNumber The order tracking number of the shipment
courier The courier code of the shipment
url The URL to this same API to call back the "father" shipment
custom1 The custom1 value as imported
custom2 The custom2 value as imported
custom3 The custom3 value as imported
deliveryMode It can assume the values ​​"home" for a delivery direct to the recipient or "pickup" for a delivery direct to a collection point (Pickup point)
hasFlag It is true (boolean value) if the shipment has been "reported", in this case the "flag" field is populated
flag
Description The description of the flag
Note The potential note
notifications

All notifications sent by status for this shipment. Obtainable using the data parameter=notifications and included if data=all

email

It is an array of sent email

result It is OK if the email has been successful, otherwise KO
statusID The Qapla' status for which the email has been sent
status Description of the sent status
date Sent date
error Possible error
isOpened It is true (boolean value) if the email has been opened / read
sms

It is an array of SMS sent

result It is OK if the SMS has been successful, otherwise KO
statusID The Qapla' Status for which SMS has been sent
status Description of the sent status
date Sent date
webhook

It is an array of sent webhook

result It is OK if the email has been successful, otherwise KO
statusID The Qapla' status for which the webhook has been sent
status Description of the sent status
date Sent date
qaplAPP

It is an array of sent notifications to qaplAPP

result It is OK if the email has been successful, otherwise KO
statusID The Qapla' status or which notification has been sent to qaplAPP
status Description of the sent status
date Notification date
trackingHistory

It is an array of following elements:

date The date of the status as communicated by the courier
dateISO The ISO version YYYY-MM-DD HH:MM:SS of the date communicated by the courier
status Status communicated by the courier
place The place
qaplaStatus

The "translation" of the status of the courier in the status of Qapla'

id Status ID
status The description
detailID ID of the possible detail
detail Description of the possible detail
color The color assigned by Qapla' to the status
icon Status icon
Errors
In case of error the "result" field will contain "KO" and the "error" field the description of the error.
{
"getShipment": {
    "result": "KO",
    "error": "[ERROR_MESSAGE]"
}
}

getShipments

getShipments allows you to receive the list of shipments imported from Qapla' by input date, shipping date, order date.
GEThttps://api.qapla.it/1.2/getShipments/?apiKey=[API_KEY]&[DATE]
Parameters
ParameterDescription
apiKeythe API Key assigned to the channel we want to query
[DATE]*
shipDateshipment date in format ISO 8601 "YYYY-MM-DD"
orderDateorder date in format ISO 8601 "YYYY-MM-DD"
dateInsupload date in format ISO 8601 "YYYY-MM-DD"
*If no parameter is set, it will be used by default dateIns and current date.
Response Body200


            
Description
result(string) The result of the operation: OK or KO in case of error
error(string) The error in case of result: KO
version(string) The API version
search(string) The parameter ascribed as search
count(int) Number of current shipments
shipments(array) It is an array that can contain more than one shipment
id(int) Numeric ID of the shipment
getShipment(string) The url to the getShipment API for this shipment
reference(string) The order reference
trackingNumber(string) The tracking number
isDeleted(bool) It is true (boolean value) if the shipment is cancelled
isArchived(bool) It is true (boolean value) if the shipment is filed
origin(string) Shipment origin platform
courier(string) The courier code of the shipment
statusID(int) The Qapla' status of the shipment
statusDetailID(int) Possible Qapla' status of detail
shipDate(string) Shipment date
orderDate(string) Order date
dateIns(string) Upload date to Qapla''
language(string) Shipment language
custom1(string) The custom1 value
custom2(string) The custom2 value
custom3(string) The custom3 value
Errors


        

updateShipment

updateShipment allows you to update a shipment.
PUThttps://api.qapla.it/1.2/updateShipment/


            
Parameters

The same parameters of the pushShipment are sent considering that the primary key is composed by

  • trackingNumber
  • courier
Response Body200

        

deleteShipment

deteleShipment allows you to delete a shipment.
DELETEhttps://api.qapla.it/1.2/deleteShipment/


            
Parameters
Parameter Description
apiKey*(string) the API Key assigned to the channel we want to query
courier*(string) shipment's courier code
trackingNumber*(string) shipment's tracking number
Response Body200

        

trackingByTimeFrame

trackingByTimeFrame allows you to obtain the list of shipments that have undergone an update of the tracking status included in the dateFrom/dateTo timeframe.
GEThttps://api.qapla.it/1.2/trackingByTimeFrame/
Parameters
Parameter Description
apiKey*(string) The API Key assigned to the channel we want to query
Optional parameters
dateFrom(timestamp) default: an hour ago. In format ISO 8601 "yyyy-mm-dd hh:mm:ss"
dateTo(timestamp) in format ISO 8601 "yyyy-mm-dd hh:mm:ss"
lang The language of the names of the Qapla' status (it, en, es), default: it.

Example:

&lang=en
Response Body200


            
Description
result The result of the operation: OK or KO in case of error
error The error in case of result: KO
version The version of API
lang The language requested / passed as a parameter (default: it)
count Number of current shipments

Orders

The primary key to identify an order is:

An order update occurs if during a pushOrder, the date of update "updatedAt" is greater than the recorded date.

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/


            
            
Parameters

*Mandatory parameter


The maximum number of orders that can be sent for each individual request is 100.
apiKey*(string) The API Key assigned to the channel we want to query
pushOrder(array)

It is an array of maximum 100 orders to load.

reference*(string) Order alphanumeric reference
orderID(int) Possible order numeric reference
courier*(string) The Qapla' courier code
courierService(string) Possible kind of courier service (to be agreed)
status(string) Order status (processing, complete, ecc)
createdAt*(YYYY-MM-DD HH:MM:S) Order creation date
updatedAt*(YYYY-MM-DD HH:MM:SS) Order update date
Attention
This date is used to determine whether to update the order on Qapla'
name*(string) Recipient name
street*(string) Recipient address
city*(string) Recipient city
state*(string) Recipient province
postCode*(string) Recipient postal code
country*(string) Recipient country in formatISO 3166-1 alpha-2 (Example: IT)
email(string) Recipient email
telephone(string) Recipient telephone
amount(float) Shipment cost
payment Type of payment
isCOD(boolean) It is true if payment is cash on delivery
notes(string) Any order note
weight(float) Potential weight of the order
parcels(int) Any order packages
length(float) Potential measures: lenght
width(float) Potential measures: depth
height(float) Potential measures: height
rows(array)

It is an array of "order rows".

It is not mandatory, but if populated it has some mandatory data.

sku*(string) Article code
name*(string) Article description
qty*(int) Quantity
price*(string) Price
total(string) Total price
sender

It is the sender of the shipment if different from the contract holder.

code(string) The code to assign to the sender for a better identification
businessName(string) Business name
street(string) Address
city(string) City
state(string) Province
postCode(string) Postal code
country(string) Country in format ISO 3166-1 alpha-2 (Example: IT)
email(string) Sender email
telephone(string) Sender telephone
referent(string) Contact person of the sender
isDefault(bool) It is true if the sender will be saved as default for all other shipments
Response Body200


            
            
Description
version(string) The number version of this API
result(string) It is "OK" if the transmission was successful, "KO" in case of an error
error(string) Possible error message in case of "KO" result
count(int) Number of orders sent in the request
orders(array)

It is an array that corresponds to the number of orders sent in the request.

row(int) Number of row
reference(string) The order reference sent in the request
orderID(int) Possible order numeric ID sent in the request
action(string) It includes the following values:
  • imp: imported order
  • upd: updated order
  • del: deleted order
  • skp: no action taken
  • ext: order already existing
  • err: report an error
error(string) Possible error on loading of this order
imported(int) Counter of imported orders
updated(int) Counter of updated orders
deleted(int) Counter of deleted orders
skipped(int) Counter of skipped orders
existing(int) Counter of existing orders
Errors
The error message is reported in the "error" field.

        

getOrder

getOrder allows you to recover an order.
GEThttps://api.qapla.it/1.2/getOrder/?apiKey=[API_KEY]&reference=[ORDER_REFERENCE]
Parameters
Parameter Description
apiKey*(string) The API Key assigned to the channel we want to query
reference*(string) The order reference
Response Body200

        

getOrders

getOrders allows you to receive the list of orders imported from Qapla'.
GEThttps://api.qapla.it/1.2/getOrders/?apiKey=[API_KEY]&[DATE]
Parameters
Parameter Description
apiKey*(string) The API Key assigned to the channel we want to query
[DATE]
updatedAt Order update date in format ISO 8601 "YYYY-MM-DD"
createdAt Order date in format ISO 8601 "YYYY-MM-DD"
dateIns Upload date in format ISO 8601 "YYYY-MM-DD"
dateFrom / dateTo Date range for the value "updatedAt" in format ISO 8601 "yyyy-mm-dd hh:mm:ss"
If no [DATE] parameter is transferred the default is dateFrom = 1 hour ago at 00.
Response Body200

        

deleteOrder

deleteOrder allows you to delete an order.
DELETEhttps://api.qapla.it/1.2/deleteOrder/


            
Parameters
Parameter Description
apiKey*(string) The API Key assigned to the channel we want to query
reference*(string) The order reference
Response Body200

        

updateOrder

updateOrder is replaced by the pushOrder setting and the updatedAt parameter is used to determine whether the order should be updated.
updatedAt*(YYYY-MM-DD HH:MM:SS) Order update date
Attention
This date is used to determine whether to update the order on Qapla', or if the order has already been imported from Qapla'. A more recent value in this field will cause Qapla' to treat it as an "updated order" and then update all previously imported data.

undeleteOrder

undeleteOrder allows you to restore a deleted order.
PATCHhttps://api.qapla.it/1.2/undeleteOrder/


            
Parameters
Parameter Description
apiKey*(string) The API Key assigned to the channel we want to query
reference*(string) The order reference
Response Body200

        

Labels

createLabel

createLabel allows you to create a label in PDF or ZPL format (Settings should be configured on the control panel).
Attention
This API is currently being tested. Ask for activation to Customer Care.
POSThttps://api.qapla.it/1.2/createLabel/
Test
It is possible to obtain a test "dummy label" using the courier with GENERIC code.
Request


            
Parameters

*Mandatory Parameters

Parameter Description
apiKey*(string) The channel'sAPI Key
sandbox(boolean) It is true if using the sandbox (test mode)
Attention: this parameter works if the courier has already been set correctly on the channel.
Contact Qaplà's Customer Care.
origin(string) Shipment origin, permitted values:
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) Order's alphanumeric reference
orderID(string) Possible order's numeric reference
courier*(string) The Qapla' courier code
courierService(string) Possible kind of courier service; for example it can be the contract code of GLS Italy or the tariff code of BRT. To be agreed.
name*(string) Recipient name
address*(string) Recipient address
city*(string) Recipient city
state*(string) Recipient province
postCode*(string) Recipient Postal Code
country*(string) Recipient country in format ISO 3166-1 alpha-2 (I.E.: IT)
email(string) Recipient email
telephone(string) Recipient telephone
amount(float) Shipment cost
isCOD(boolean) It is true if payment is cash on delivery
notes(string) Any order note
weight(float) Potential weight of the order
parcels(int) Any order packages
length(float) Potential measures: lenght
width(float) Potential measures: width
height(float) Potential measures: height
shippingInsurance(float) Potential insured amount
shippingDeliveryOptions(string) It currently works only for BRT, now the values ​​are

A: by appointment
P: delivery on the floor

separated by commas in case you want to use both
example: A,P
shippingRequiredDeliveryDate(YYYY-MM-DD) The delivery request date in the format YYYY-MM-DD
shippingCODPaymentOption(string) Payment method of cash on delivery if different from default settings (to be agreed)
gSpedPrinterID(int) Possible printer id (user_id) for the Gsped Labeling Machine (to be agreed)
Response Body200


            
Parameter Description
isShipped(boolean) It istrue if the order has alredy been labeled and returns the label alredy created.
id(int) Shipment ID. Important to invoke other APIs.
trackingNumber(string) Shipment tracking number.
labels(array) An array with the base64 of the labels obtained (there may be multiple labels for multiple packages or returns, etc.).

Oppure

The ZPL for printing on Zebra, as configured on the Control Panel.
Errors
In case of error the "result" field will contain "KO" and the "error" field will contain the description of the error.

deleteLabel

deleteLabel allows you to delete a label created with createLabel.
Attention
This API is currently being tested. Ask for activation to Customer Care.
DELETEhttps://api.qapla.it/1.2/deleteLabel/


            
Parameters
Parameter Description
apiKey*(string) The API Key assigned to the channel we want to query
id*(int) The label id returned from createLabel
Response Body200

        

createReturnLabel

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


            
Parameters

*Mandatory parameters

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.

confirmLabel

confirmLabel allows you to confirm and send to the courier labels created with createLabel and to obtain the Loading List (borderò / manifest) in PDF format.
Attention
This API is currently being tested. Ask for activation to Customer Care.
POSThttps://api.qapla.it/1.2/confirmLabel/
Request


            
Parameters
Attention Use "labelCreationDate" or "labelID".

*Mandatory Parameter

Parameter Description
apiKey*(string) The channel's API Key
courier*(string) The Qapla' courier code
labelCreationDate*(date) The label’s date of creation in ISO 8601 format is "YYYY-MM-DD"
labelID*(array) An array of shipments ID obtained with createLabel
Response Body200


            
Parameter Description
courier(string) Courier code
number(string) Confirmation number
date(string) Confirmation date
shipments(int) Number of confirmed shipments
manifest(string) Manifest in Base64 encoded PDF
Errors
In case of error, the "result" field will contain "KO" and the "error" field the description of the error.

Couriers

getCouriers

getCouriers allows to request the couriers' list both in total and by individual country/region.
GEThttps://api.qapla.it/1.2/getCouriers/?apiKey=[API_KEY]&country=[COUNTRY_LIST]&code=[COURIER_CODE]
Parameters
Parameter Description
apiKey the API Key assigned to the channel we want to query
Optional parameters
country empty for all couriers, or a comma-separated list of country values
country=it,fr,global
The available values are:
AustriaatAustria
BelgiumbeBelgium
SwitzerlandchSwitzerland
ChinacnChina
CypruscyCyprus
Czech RepublicczCzech Republic
GermanydeGermany
DenmarkdkDenmark
EstoniaeeEstonia
SpainesSpain
eu
FinlandfiFinland
FrancefrFrance
United KingdomgbUnited Kingdom
global
GreecegrGreece
Hong KonghkHong Kong
CroatiahrCroatia
HungaryhuHungary
IrelandieIreland
ItalyitItaly
South KoreakrSouth Korea
LithuanialtLithuania
LatvialvLatvia
MaltamtMalta
MalaysiamyMalaysia
NetherlandsnlNetherlands
PolandplPoland
PortugalptPortugal
RussiaruRussia
SwedenseSweden
SloveniasiSlovenia
USAusUSA
South AfricazaSouth Africa
code The Qapla' code of the courier
code=BRT
Response Body200
The following URL
GEThttps://api.qapla.it/1.2/getCouriers/?apiKey=[API_KEY]&country=global
will result:

        

detectCourier

detectCourier tries to determine the courier from the tracking number provided, responding with a list of couriers.
GEThttps://api.qapla.it/1.2/detectCourier/?apiKey=[API_KEY]&trackingNumber=[TRACKING_NUMBER]
Parameters
Parameter Description
apiKey The API Key assigned to the channel we want to query
trackingNumber The tracking number to be identified
Response Body200

        

Channels

getChannel

getChannel allows you to obtain information on the channel connected to the API Key and the company who created it.
GEThttps://api.qapla.it/1.2/getChannel/?apiKey=[API_KEY]
Parameters
Parameter Description
apiKey The API Key assigned to the channel we want to query
Optional Parameters
data It obtains information on the configuration of the channel with respect to the platform and/or marketplaces.

Possible values (all, platform, marketplaces)

Response Body200

        

Misc

getCredits

getCredits allows you to get the remaining credits on your premium account.
GEThttps://api.qapla.it/1.2/getCredits/?apiKey=[API_KEY]
Parameters
Parameter Description
apiKey The API Key assigned to the channel we want to query
Response Body200


            
Description
result(string) The result of the operation: OK or KO in case of error
error(string) The error in case of result: KO
credits(int) Remaining credits
date(string) Count update date

getQaplaStatus

getQaplaStatus allows you to get the detailed list of Qapla' shipping status
GEThttps://api.qapla.it/1.2/getQaplaStatus/?apiKey=[API_KEY]&lang=[LANG]&id=[ID]
Parameters
Parameter Description
apiKey(string) The API Key assigned to the channel we want to query
Optional parameters
lang(string) The language of the names of the Qapla' status (it, en, es), default: it.

Example:

&lang=en
id(int) Possible id of which you want to get informations

Example:

&id=3
Response Body200


            
result(string) The result of the operation: OK or KO in case of error
error(string) The error in case of result: KO
version(string) The version of API
qaplaStatus(array) It is an array of status
statusID(int) The Qapla' status
status(string) Name of the status
statusDescription(string) Description of the status
color(string) The color assigned to the status
icon(string) The icon assigned to the status
statusDetailID(int) Possible status detail
statusDetail(string) Name of the detail
statusDetailDescription(string) Description of the detail

Script

Qapla's APIs can be efficiently queried using JavaScript scripts.

Tracking Script

By entering and configuring our Tracking Script, you can get tracking anywhere on the site.

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

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

<!-- Place this element where you want to display the Qapla' Tracking -->
<div id="qapla-tracking"></div>
Parameters
ParameterDescription
apiKey*(string)The "public" API KEY present in the configuration of the sales channel on the Qapla' Control Panel (CP).
reference*/ trackingNumber*(string)Track by order reference or by tracking number.
noCSS(bool)If true not include the standard css, allowing an override.
Result
The result is an HTML that will be inserted into the element with id qapla-tracking having the following content. tracking

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
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
APP2DELIVERY APP2DELIVERY App2delivery it
ARAMEX ARAMEX Aramex http://www.aramex.com global
ARCO ARCO Arco Spedizioni http://www.arco.it/ it
ASENDIA ASENDIA Asendia Europe https://www.asendia.com eu
ASENDIA-DE ASENDIA-DE ASENDIA Germany http://www.asendia.de/ de
ASENDIA-USA ASENDIA-USA ASENDIA USA http://www.asendiausa.com/ us
ASM ASM ASM http://www.asmred.com es
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
BULGARIAN-POSTS BULGARIAN-POSTS Bulgarian Posts https://www.bgpost.bg/en BG
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
GO-EXPRESS GO-EXPRESS GO! Express & Logistics https://www.general-overnight.com de
HERMES-DE HERMES-DE Hermes Germany https://www.myhermes.de de
HERMES-IT HERMES-IT Hermes Italy http://www.hermes-italy.it/ it
HERMES HERMES Hermes UK https://www.myhermes.co.uk gb
HONG-KONG-POST HONG-KONG-POST Hong Kong Post https://www.hongkongpost.hk/en/home/index.html hk
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
LUXEMBOURG-POST LUXEMBOURG-POST Luxembourg Post https://www.post.lu lu
MAGYAR-POSTA MAGYAR-POSTA Magyar Posta https://www.posta.hu/ hu
MBE-IT MBE-IT Mail Boxes Etc. Italia https://www.mbe.it/ it
MALTA-POST MALTA-POST Malta Post https://www.maltapost.com/ mt
MILKMAN MILKMAN 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
PALLEX PALLEX Pallex https://www.pallex.it/ IT
PARCEL-FORCE PARCEL-FORCE Parcel Force http://www.parcelforce.com gb
POCZTA-POLSKA POCZTA-POLSKA Poczta Polska http://www.poczta-polska.pl pl
POS-MALAYSIA POS-MALAYSIA Pos Malaysia https://www.pos.com.my/ my
POSTA-ROMANA POSTA-ROMANA Poșta Română https://www.posta-romana.ro/ RO
SLOVENIA-POST SLOVENIA-POST Pošta Slovenije https://www.posta.si si
PTI PTI Poste Italiane http://www.poste.it it
POSTEN-NORGE POSTEN-NORGE Posten Norge https://www.posten.no/ no
POSTI POSTI Posti https://www.posti.fi/ fi
POSTNL-INT POSTNL-INT PostNL International http://www.postnl.post/ nl
POSTNL-3S POSTNL-3S PostNL International 3S https://www.internationalparceltracking.com nl
POSTNORD-DENMARK POSTNORD-DENMARK PostNord Denmark https://www.postnord.dk dk
POSTNORD-SWEDEN POSTNORD-SWEDEN PostNord Sweden https://www.postnord.se/ se
QHD QHD QHD https://www.qhditalia.it/ global
RDA RDA Ramoneda http://www.ramoneda.com/ es
ROYAL-MAIL ROYAL-MAIL Royal Mail http://www.royalmail.com gb
RPOST RPOST RPost https://www.errepost.it/ IT
RUSSIAN-POST RUSSIAN-POST Russian Post https://www.pochta.ru ru
SF-EXPRESS SF-EXPRESS S.F. Express http://www.sf-express.com cn
SAILPOST SAILPOST Sailpost http://www.sailpost.it it
SMM-IT SMM-IT San Marino Mail http://www.sanmarinomail.sm it
SDA SDA SDA http://wwww.sda.it it
SDA-RACCOMANDATA SDA-RACCOMANDATA SDA Raccomandata http://wwww.sda.it it
SENDABOX SENDABOX Sendabox http://www.sendabox.it/ it
SENDING SENDING Sending Transporte Urgente https://www.sending.es es
SEUR SEUR Seur http://www.seur.com es
SGT SGT SGT Corriere Espresso http://www.sgt.it/ it
SINOTRANS SINOTRANS Sinotrans http://www.sinotrans-csc.com/ cn
SKYNET-ITA SKYNET-ITA SkyNet Italy http://www.skynetitaly.it it
SKYNET SKYNET SkyNet Worldwide Express http://www.skynetwwe.com/ global
SOUTH-AFRICAN-POST SOUTH-AFRICAN-POST South African Post https://www.postoffice.co.za za
SPEDIAMO SPEDIAMO Spediamo.it http://www.spediamo.it/ it
SPRING-GDS SPRING-GDS Spring GDS https://www.spring-gds.com/ eu
SUSA SUSA Susa https://flex.susa.it/Home IT
SWISS-POST SWISS-POST Swiss Post https://www.post.ch/ ch
TWS TWS T.W.S. Express Courier http://www.twsexpresscourier.it it
TECNO-TRANS TECNO-TRANS Tecnotrans http://www.tecnotrans.eu it
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