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.

Qapla' API is based on REST.
Accepts GET, POST, PUT and DELETE JSON encoded requests.
Returns JSON encoded values.
The reference time zone is CEST, which corresponds to UTC + 2 when daylight saving time is in effect, or UTC + 1 when standard time is in effect.

New Version Available

The latest available API version is 1.3

Previous versions

Previous versions of this API are still active, but considered as deprecated.

API 1.2 DEPRECATED
API 1.1 DEPRECATED
API 1.0

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.

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 limit applies per channel (API Key): 150 tokens every 60 seconds.

Limit	150	Tokens available per channel in one window
Window	60 s	Starts with the first request; when it expires the counter is reset

Warning
A multiple request consumes one token per element: a pushShipment or pushOrder with 100 shipments or orders is worth 100 tokens.

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"

After a 429 tokens are not refilled gradually: wait for the current window to end, at most 60 seconds. Rejected requests consume tokens too, without extending the window: retrying before it expires only produces more 429s.

Abuse

The abuse of the use will lead to a BAN of the API Key.

Sandbox

There isn't any proper sandbox environment. However you can use the sandbox field in the API methods (where supported) to use the test infrastructure, without having operational effects (like costs, picking requests sent to the carries, etc...)

Test

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

Postman Collection

A Postman Collection is available.

Shipments

The primary key to identify a shipment is:

Channel, represented by API Key
Courier, "courier"
Tracking number, "trackingNumber"

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
RESPONSE

Request

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

{
                    "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.23,
                            "pod": false,
                            "shipping": 8.32,
                            "custom1": "valore custom 1",
                            "custom2": "valore custom 2",
                            "custom3": "valore custom 3",
                            "note": "This is a note",
                            "language": "fr",
                            "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.35,
                                "total": 6.35,
                                "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.38,
                                "total": 1.90,
                                "isReturnable": true
                            }]
                        }
                    ]
            }

Parameters

There are 3 types of shipment loading modes.

"minimum" containing 3 mandatory fields^*
"necessary" to activate additional communication services to the customer such as transactional emails, etc.^•
"complete" always with the first 3 mandatory fields, but containing all the information

^*Mandatory parameter

^•Parameter required to activate transactional emails and / or SMS

⚠
The maximum number of shipments that can be sent for individual request is 100.

apiKey(string)

The API Key assigned to the channel into which you want to import shipments

pushShipment(array)

It is an array of maximum 100 shipments to load.

trackingNumber^*(string)

The tracking number / shipping number / waybill of the courier

courier^*(string)

The Qapla' courier code

shipDate^*(string)

Shipment date

reference^•(string)

Order reference

platformOrderID(string)

Optional numeric or alphanumeric ID, used as additional order reference

orderDate(string)

Order date

weight(float)

Potential weight of the shipment

parcels(int)

Any packages of the shipment

length(float)

Potential measures: lenght

width(float)

Potential measures: width

height(float)

Potential measures: height

name^•(string)

Recipient Name

street(string)

Recipient address

city(string)

Recipient City

ZIP(string)

Recipient postal code

state(string)

Recipient province

country(string)

Recipient country in format ISO 3166-1 alpha-2 (Example: IT)

email^•(string)

Recipient email

telephone^•(string)

Recipient telephone

agent(string)

Email address of a customer business contact

amount(float)

Potential amount of the shipment (to be communicated to the customer. Ex: cash on delivery)

pod(boolean)

It is true if payment is cash on delivery

shipping(float)

Potential cost of shipment

custom1(string)

Custom value 1

custom2(string)

Custom value 2

custom3(string)

Custom value 3

note(string)

A note regarding the shipment (max 255 chars)

language(string)

Shipment language ( ISO 639-1 , ex: 'fr').
A null or unrecognized value will indicate the shipment as 'it'.

origin(string)

Origin of shipment, 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, mediaMarkt_de, bricobravo, miravia_es
                                        

isReturnable(bool)

If it is true, it indicates the possibility of returning the entire shipment.

deliveryDate(string)

Potential delivery request date

tag(string)

A "tag" to identify shipments belonging to a group.

isTrackingNumber(bool)

It is true when placed in the trackingNumber field it is the real tracking number of the shipment.

rows

It is an array of "order lines".

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

sku^*(string)	Article code
name^*(string)	Article description
qty^*(int)	Quantity
weight(float)	Potential article weight
url(string)	The specific url of the product
imageUrl(string)	The url of the product image
price^*(float)	Price
total(float)	Total price
isReturnable(bool)	If it is true, it indicates the possibility of returning the single item

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

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]

REQUEST
RESPONSE

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)
history	Minimum data + shipment tracking history
rows	Minimum data + product rows

The parameter can be combined separated by commas, for example

&data=consignee,history

in order to get only these data.

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,"courierEstimatedDeliveryDate":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"}]},"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"}}]}]}}

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, the one declared by whoever created the shipment
courierEstimatedDeliveryDate	Possible delivery date announced by the courier (`YYYY-MM-DD`), `null` until the courier publishes one. Same information as `note`, read as a date instead of a sentence
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

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

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]

REQUEST
RESPONSE

Parameters

Parameter	Description
apiKey	the API Key assigned to the channel we want to query
[DATE]^*
shipDate	shipment date in format ISO 8601 "YYYY-MM-DD"
orderDate	order date in format ISO 8601 "YYYY-MM-DD"
dateIns	upload date in format ISO 8601 "YYYY-MM-DD"

^*If no parameter is set, it will be used by default dateIns and current date.

Response Body`200`

{"getShipments":{"result":"OK","error":null,"version":"1.2.8","search":"shipDate=2019-06-20","count":2,"shipments":[{"id":1000000000001,"getShipment":"https://api.qapla.it/1.2/getShipment/?apiKey=[API_KEY]&id=000000000002","reference":"0101000101002","trackingNumber":"XX000001","isDeleted":false,"isArchived":false,"origin":"spartoo_it","courier":"GLS-ITA","statusID":2,"statusDetailID":0,"shipDate":"2019-06-20","orderDate":"2019-06-19","dateIns":"2019-06-20 11:21:10","language":"it","custom1":null,"custom2":null,"custom3":null,"isCOD": true,"deliveredDate": null},{"id":2000000000002,"getShipment":"https://api.qapla.it/1.2/getShipment/?apiKey=[API_KEY]&id=000000000002","reference":"0101000101001","trackingNumber":"XX000002","isDeleted":false,"isArchived":false,"origin":"spartoo_it","courier":"BRT","statusID":3,"statusDetailID":0,"shipDate":"2019-06-20","orderDate":"2019-06-19","dateIns":"2019-06-20 11:21:10","language":"it","custom1":null,"custom2":null,"custom3":null,"isCOD": false,"deliveredDate": "2019-06-27 10:19:23"}]}}

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
isCOD(boolean)	It is true if payment is cash on delivery
deliveredDate(string)	Delivered date

Errors

updateShipment

updateShipment allows you to update a shipment.

PUThttps://api.qapla.it/1.2/updateShipment/

REQUEST
RESPONSE

Parameters

The shipment is identified by

trackingNumber
courier

Not every pushShipment field can be updated: only these ones can

reference, orderDate, shipDate, deliveryDate
name, street, city, ZIP, state, country, email, telephone
amount, shipping, pod, agent, tag, note
custom1, custom2, custom3
isTrackingNumber

Any other field (for example origin, rows, parcels) is not applied and is listed in ignoredFields in the response. The call still answers OK when at least one updatable field has been updated: check ignoredFields to know what was not applied.

Fields with an empty value, 0 or false are skipped: a field cannot be cleared, and pod and isTrackingNumber cannot be set to false. If no updatable field has a value, the response is KO with error data is empty.

Response Body`200`

If the request contains fields that cannot be updated, the response lists them:

{"updateShipment":{"result":"OK","error":null,"ignoredFields":["origin"]}}

deleteShipment

deteleShipment allows you to delete a shipment.

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

REQUEST
RESPONSE

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

undeleteShipment

undeleteShipment allows you to restore a shipment.

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

REQUEST
RESPONSE

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

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/?apiKey=[API_KEY]

GEThttps://api.qapla.it/1.2/trackingByTimeFrame/?apiKey=[API_KEY]&dateFrom=[YYYY-MM-DD HH:MM:SS]&dateTo=[YYYY-MM-DD HH:MM:SS]

GEThttps://api.qapla.it/1.2/trackingByTimeFrame/?apiKey=[API_KEY]&dateFrom=2019-10-29%2017:00:00&dateTo=2019-10-29%2023:59:59&lang=en

Without dates it returns the shipments updated in the last hour. In the query string the space between date and time must be encoded (%20).

REQUEST
RESPONSE

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)	default: today at 23:59:59. In format ISO 8601 "yyyy-mm-dd hh:mm:ss", time included
lang	The language of the names of the Qapla' status (it, en, es), default: it. Example: &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
		}]
	}
}

If no shipment was updated in the timeframe the response has "result" set to "KO" and "error" set to "no shipments found".

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
shipments	The description of shipment

Orders

The primary key to identify an order is:

Channel, represented by API Key
Order reference, "reference"
Tracking number, "trackingNumber

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/

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.25,
      "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"
      },
      "invoice":{
        "number": "A00012345/2022"
      }
    }
  ]
}

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

origin(string)

Origin of order, 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, mediaMarkt_de, bricobravo, miravia_es
                            

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. If the courier is not associated with the channel or does not generate shipments, it will be evaluated with 0.

courierService(string) Possible kind of courier service. If the field is empty or not sent, the default is '0'.
GLS Italy: the field holds the merchant's GLS contract code, not a service code. If it is empty, the first contract configured on the channel is used; if the channel has none, the call returns KO. GLS accessory services (e.g. 22 EXPRESS 12, 02 ORA FISSA) go in shippingDeliveryOptions as comma-separated codes (02, not ORA FISSA). For 02 ORA FISSA there is currently no field for the delivery time.

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

Attention: for AMAZON-SHIPPING, when used with a pickup point (PUDO object), the recipient email is mandatory.

telephone(string) Recipient telephone

amount(float) Shipment amount.
Specify only one separator (the dot) to indicate decimals, and do not use separators to indicate thousands. Give a maximum of two decimal digits. Example: 2340.23

currencyCode(string) Currency code ISO 4217 (default: EUR)

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

isReturnable(bool) If it is true, it indicates the possibility of returning the entire order.

shippingCODPaymentOption(string) Payment method of cash on delivery if different from default settings (to be agreed)

shippingInsurance(float | string)

General
GLS-ITA
SDA
CRONO-PTI

Potential insured amount

ALL-IN: insert into "shippingDeliveryOptions" the following string: ALLIN

To generate directly with SDA, the value must be passed in the form of a string, specifying one of the following codes:

Code	Insurance type
	If no parameters are specified, no insurance type will be applied
AS01	UP TO EURO 258,23
AS02	UP TO EURO 516,46
AS03	UP TO EURO 1.549,37
AS04	UP TO EURO 2.582,28
AS05	ASSICURATA INTERNAZIONALE UP TO 1.500,00
AS12	ASSICURATA ROAD EUROPE
AS13	ASSICURATA EXPORT BOX

To generate directly with CRONO PTI, the value must be passed in the form of a string, specifying one of the following codes:

Code	Insurance type
	If no parameters are specified, no insurance type will be applied
AS01	UP TO EURO 258,23
AS02	UP TO EURO 516,46
AS03	UP TO EURO 1.549,37
AS04	UP TO EURO 2.582,28
AS05	ASSICURATA INTERNAZIONALE UP TO 1.500,00
AS12	ASSICURATA ROAD EUROPE
AS13	ASSICURATA EXPORT BOX
AS14	ASSICURATA CRONO INTERNAZIONALE

shippingDeliveryOptions(string | JSON)

General
PTI

If two values are to be used, they must be separated by commas
Example: A,P or 22,07

For PTI courier you need to use a JSON structured as follows

shippingRequiredDeliveryDate(YYYY-MM-DD) The delivery request date in the format YYYY-MM-DD

pickUpDate(YYYY-MM-DD) The collection date requested to the courier in format YYYY-MM-DD

custom1,1,3(string) Potential custom fields

pickupPoint(string) Possible code of a pickup point

content(string) The content of the goods that may be present on the label (depends on the courier)

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^*(float)	Price
total(float)	Total price
weight(float)	Potential article weight
url(string)	The specific url of the product
imageUrl(string)	The url of the product image
notes(string)	Product notes

assemblyTypes(array)

Possible list of assembly types, one per product, for couriers who support this information

General
FERCAM

code^*(string)	The code of the selected type of assembly

Available for the "courierService" 20 (HD). One element must be specified for each element of rows.

Available values for "code":

Code	Description
5	Appliance Activation
09	Built-in ovens/cookers with declaration of conformity
08	Built-in refrigerators
07	Built-in dishwashers and washing machines
11	DUAL Air Conditioning Installation with piping to be prepared
14	DUAL Air Conditioning Installation with pre-prepared piping
10	MONO Air Conditioning Installation with piping to be prepared
13	MONO Air Conditioning Installation with pre-prepared piping
12	TRIAL Air Conditioning Installation with piping to be prepared
15	TRIAL Air Conditioning Installation with pre-prepared piping
K	Basic HD Installation
Z	Complex HD Installation
Y	Medium HD Installation
W	Simple HD Installation
06	Wall-mounted TV Installation
20	Assembly of 30
17	Exercise Bike Assembly
18	Elliptical Assembly
4	Multifunctional Structure Assembly
16	Treadmill Assembly
1	Assembly of Treadmill, Exercise Bike, and Elliptical
2	Ping Pong Table Assembly
3	Rowing Machine Assembly

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

PUDO(object)

Allows you to set a Pick-up or Drop-off point for the collection of goods. Each field must be completed according to the courier's need. Refer to the tables below

id^*(string)	PUDO identification
type(string)	Type of Service
name(string)	Service Name
address(string)	Address of the Pick-up or Drop-off point
city(string)	City of the Pick-up or Drop-off point
state(string)	Province of the Pick-up or Drop-off point
country(string)	Country of the Pick-up or Drop-off point
postalCode(string)	Postal code of the Pick-up or Drop-off point
description(string)	Description
harmonisedId(string)	Additional numeric ID of the Pick-up o Drop-off, derived from getPudos. Es. 104
keyword(string)	Keyword of the Pick-up o Drop-off, derived from getPudos. Es 'DHL Servicepoint'
psfKey(string)	PsfKey of the Pick-up o Drop-off, derived from getPudos. Es 'ES-0004240'
postnumber(string)	Postnumber of the Pick-up o Drop-off, only if 'packstation' type. It is a code that the end customer personally owns

**DHL / BRT / INPOST / FEDEX / MRW / SENDING / MONDIALRELAY / AMAZON-SHIPPING**
Attribute	Value
id^*(string)	PUDO identification

**TNT ITA / GLS-ITA**
Attribute	Value
id^*(string)	Possible values: TNT: identification code of TNT point/Locker; GLS-IT: identification code called SHOP_ID;
type^*(string)	Possible values: TNT: 3 (TNT point) o 5 (TNT Locker); GLS-IT: identification code called PARTNER_SHOP_ID;

**PTI(Poste Italiane)**
Attribute	Value
id^*(string)	PUDO identification
type^*(string)	Possible values: `ConsegnaPuntoPoste` `ConsegnaUfficioPostale` `ConsegnaLocker` `ConsegnaPUDOUPS`
name^*(string)	Name of the Pick-up Point
address^*(string)	Address of the Pick-up Point
postalCode^*(string)	Postal Code of the Pick-up Point
city^*(string)	City/Location of the Pick-up Point
province^*(string)	Province of the Pick-up Point
country^*(string)	Country of the Pick-up Point

**UPS**
Attribute	Value
id^*(string)	PUDO identification
address^*(string)	Address
city^*(string)	City
country^*(string)	Country
name^*(string)	Name
postalCode^*(string)	Postal Code
state^*(string)	State

**SDA**
Attribute	Value
id^*(string)	PUDO identification
address^*(string)	Address
city^*(string)	City
name^*(string)	Name
postalCode^*(string)	Postal code
state^*(string)	State

**DHL-PAKET**
Attribute	Value
id^*(string)	PUDO identification
type^*(string)	Type of PUDO ("locker" or "postoffice")
city^*(string)	City
name^*(string)	Name of PUDO
country^*(string)	Country
postalCode^*(string)	Postal code
postnumber(string)	PostNumber. Mandatory for "postoffice"

**DHLPARCEL-ES**
Attribute	Value
id^*(string)	PUDO identification
address^*(string)	Address
city^*(string)	City
country^*(string)	Country
postalCode^*(string)	Postal code
harmonisedId^*(string)	Harmonized Id
keyword^*(string)	Keyword
psfKey^*(string)	PsfKey
postnumber(string)	PostNumber

**CORREOS-EXPRESS**
Attribute	Value
id^*(string)	PUDO identifier
address^*(string)	Address
city^*(string)	City
country^*(string)	Country
postalCode^*(string)	Postal Code

**GLS-SPAIN**
Attribute	Value
id^*(string)	PUDO identification
name^*(string)	PUDO name
address^*(string)	Address
city^*(string)	City
country^*(string)	Country
postalCode^*(string)	Postal code

**SEUR**
Attribute	Value
id^*(string)	PUDO identification

**TIPSA**
Attribute	Value
id^*(string)	PUDO identifier
address^*(string)	Address
city^*(string)	City
name^*(string)	PUDO name
postalCode^*(string)	Postal Code

invoice(object)

It allows you to set information regarding the invoice associated with the shipment, useful for shipments that have to go through customs.
Mandatory for DHL

number^*(string)	Invoice number

Response Body`200`

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]

REQUEST
RESPONSE

Parameters

^* Mandatory parameter

^° At least one of the parameters is mandatory

Parameter	Description
apiKey^*(string)	The API Key assigned to the channel we want to query
reference^°(string)	The order reference
reference^°(string)	Alternative order reference

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 allows you to receive the list of orders imported from Qapla'.

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

REQUEST
RESPONSE

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

deleteOrder

deleteOrder allows you to delete an order.

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

REQUEST
RESPONSE

Parameters

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

Response Body`200`

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/

REQUEST
RESPONSE

Parameters

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

Response Body`200`

detectOrderCourier

Attention

Ask for activation to Customer Care.

detectOrderCourier allows you to get the courier to assign to the order, following preset rules (settings to be configured on the Control Panel).

Useful before of a createLabel to identify in advance the courier to use.

The rules identify the courier according to weight, any cash on delivery amount, the destination zip code and — when configured — the product codes (SKU) of the order rows, the order tag and the custom fields.

If you have clear rules such as the following:

weight	COD	CAP
less than or equal to 3Kg			GLS
greater than 3 Kg	less than 100 €		BRT
greater than 3 Kg	greater than 100 €	less than 70000 (north)	GLS
greater than 3 Kg	greater than 100 €	greater than 70000 (south)	BRT

it is possible to predetermine and pre-assign the courier to the order before the label is created, for example with the createLabel.

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

REQUEST
RESPONSE

Request

Parameters

^*Mandatory Parameter

Parameter Description

apiKey^*(string) The channel's API Key

country^*(string) Recipient country in format ISO 3166-1 alpha-2 (Example: IT)

weight^*(float) Potential weight of the order

cod(float) Amount of the shipment, if the shipment is cash on delivery

postCode(string) Recipient postal code

rows(array)

The order rows. They are needed only if the channel has rules on the product code (SKU): without them such a rule cannot be satisfied, and the evaluation moves on to the next rule, or to the default one.

Same shape as createLabel, so a payload already built for that one can be reused as is: the other row fields are accepted and ignored, only the sku is read here. Items with no sku are not taken into account.

sku^*(string)	Item code, 50 characters at most

How the comparison works: the rule is satisfied when at least one order row matches an included code — case insensitively, and by prefix if the rule is configured that way. An excluded code makes the rule fail instead, even when another row matches an included one.

An order carrying no rows matches no rule with a SKU list, not even one made of excluded codes only.

tag(string)

The order tag, if the channel has rules on it. One of green, yellow, orange, blue, cyan, red: anything else answers with the Invalid tag value error.

The tag has to be passed in the very call that creates the order (pushOrder 1.3 or createLabel): rules are evaluated on order creation only, so a tag assigned later on — markOrderReady included — does not reassign the courier. pushOrder 1.2 does not support the tag at all.

custom1
custom2
custom3(string)

The three custom order fields, if the channel has rules on them. 255 characters at most each: a longer value is truncated and stops matching the one configured on the rule.

The comparison is case insensitive and ignores leading and trailing spaces. A rule can list several accepted values separated by a semicolon (e.g. vip;gold).

Response Body`200`

Parameter	Description
courier(json)	Contains id, code and name of the identified courier
rule(json)	Contains id, and name of the identified rule
request(json)	The parameters of the request

Errors

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

No courier found ("result":"KO", "error":"No courier found") has two possible meanings:

no channel rule matches the order parameters (or no rule is configured at all);
the courier of the matching rules is temporarily suspended. From the Control Panel (Channel settings → Couriers → Availability for the automatic rules) a courier can be excluded until a given date (strikes) or after a daily cutoff time (missed pickup). The suspension applies to the default rule as well: while the window is open an order can be left without a courier.

To stay independent from the rules during a suspension, set the courier explicitly in createLabel (courier parameter).

apiVirtual

apiVirtual allows you to update the status of a virtual courier shipment.

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

REQUEST
RESPONSE

Parameters

^*Mandatory parameter

apiKey^*(string)

The API Key assigned to the channel we want to query

apiVirtual(array)

It is an array that can hold maximum 100 updates.

trackingNumber^*(string)	The tracking number of the shipment to be updated
statusID / statusDetailID^*(float)	The ID of the status of the shipment and any statusDetailID
status(string)	The textual description of the shipment status
place(string)	The location where the shipment is located
date(YYYY-MM-DD HH:MM:S)	The date in ISO 8601 format "yyyy-mm-dd hh: mm: ss"
note(string)	Any shipping notes

Response Body`200`

Errors

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

Platforms

A series of tools to communicate directly with your platform / marketplace already configured on the channel, without going through Qapla'

fetchPlatformOrders

fetchPlatformOrders allows you to receive the list of orders on a platform.

GEThttps://api.qapla.it/1.2/fetchPlatformOrders/?apiKey=[API_KEY]&platform=[PLATFORM]&orderFormat=[ORDERFORMAT]&skip

REQUEST
RESPONSE

Parameters

Parameter	Description
apiKey^*(string)	The API Key assigned to the channel we want to query
platform(string)	The associated platform. If it is not indicated, the platform (CMS) associated with the channel is considered. If no platform is associated with the channel, the parameter becomes mandatory to indicate a marketplace. Possible values: amazon, carrefour, cdiscount, ebay, ecwid, eprice, ibs, magento, magento2, manomano, prestashop, privalia, shopify, spartoo, storeden^¤, teamsystemcommerce^¤, vtex, woocommerce, worten, leroymerlin, greenweez, maisondumonde, mediamarkt, bigcommerce, commercelayer, shopware6, aliexpress, allegro, sprinter, decathlon, bricobravo, miravia, tiktokshop, temu, redcarepharmacy, etsy, vivino, modivo, conforama, elcorteingles, pccomponentes ^¤storeden and teamsystemcommerce can be used as synonyms With etsy and vivino dateTo is ignored: the orders from dateFrom to now are returned. etsy returns only paid orders not yet shipped. With temu the response time grows with the number of orders: prefer short timeframes, one day at most.
dateFrom / dateTo(timestamp)	Date range for the value "updatedAt" in format ISO 8601 "yyyy-mm-dd hh:mm:ss"
orderFormat(string)	If the value (platform) is passed, orders will be returned in original format. If no value is passed, the results will be returned in standard format (qapla).
latestShipDate / latestDeliveryDate(timestamp)	Currently filled in only for Ebay and Amazon, these are the date values for "lastest shipping date" and lastest delivery date" in format ISO 8601 "yyyy-mm-dd"
skip(string)	Skip order statuses.

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,
                "latestShipDate":"2020-11-05", 
                "latestDeliveryDate":"2020-11-15", 
                "rows": [
                {
                "sku": "IBSMP1234567",
                "name": "Ritorno al futuro",
                "qty": 1,
                "price": 10.2,
                "total": 15.1,
                "url": null,
                "imgUrl": null,
                "weight": null
                }
                ]
                }
                ]
                }
                }

Errors

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

{
"fetchPlatformOrders": {
    "result": "KO",
    "error": "[ERROR_MESSAGE]"
}
}

updatePlatformOrder

updatePlatformOrder allows you to update orders on a platform.

PUThttps://api.qapla.it/1.2/updatePlatformOrder/

REQUEST
RESPONSE

Authentication

Authentication takes place via the APIKey of the channel, passing Q-API-Key in the request header

Parameter	Description
Q-API-Key^*(string)	The channel's API Key

Parameters

Parameter	Description
platform^*(string)	The associated platform, for example a marketplace. Allowed values: magento, magento2, prestashop, shopify, woocommerce, amazon, ibs, manomano, spartoo, carrefour, leroymerlin, greenweez, maisondumonde, mediamarkt, bigcommerce, commercelayer, cdiscount, ecwid, shopware6, storeden^¤, teamsystemcommerce^¤, vtex, aliexpress, allegro, ebay, eprice, privalia, sprinter, worten, decathlon, bricobravo, miravia, tiktokshop, temu, redcarepharmacy ^¤storeden and teamsystemcommerce can be used as synonyms
reference(string)	Order alphanumeric reference. To be entered, if required, based on the specific platform used.
orderID(int)	Order numeric reference. To be entered, if required, based on the specific platform used.
courier^*(string)	The Qapla' courier code
trackingNumber^*(string)	The tracking number of the order to be updated
setShipped(bool)	It is true if shipment is set. To be used according to the peculiarities of the platform used.
setDelivered(bool)	It is true if delivery is set. To be used according to the peculiarities of the platform used.
storeCountry(string)	The country code in ISO 2 format of the marketplace. (if requested)
trackingUrl(string)	An URL to view tracking information
amazonDirectUpdate(bool)	Updates Amazon directly (new mode). In case of errors reported by Amazon, the "errorDetails" array will be populated in the response.

Either setShipped or setDelivered is required.

The update request with setShipped and trackingNumber must be repeated twice with at least a 1-hour interval due to marketplace policy that requires a 1-hour interval between the Ready To Ship and Shipped statuses.

The update request with setDelivered must be made only once at least 12 hours after the second request with setShipped due to marketplace policy that requires a 12-hour interval between the Shipped and Delivered statuses.

Amazon updates are not performed directly but are queued in a batch for subsequent processing. It is possible to update Amazon directly without queuing in the batch by using the "amazonDirectUpdate" option set to "true".

Starting July 1st 2026, shipment confirmations for shipments originating from geographic areas outside the EU and destined for the European Union, where the item price is equal to or less than € 150 (excluding VAT, shipping costs, and promotional discounts), will be validated against the list of carriers authorized by Amazon. Shipments using unsupported carrier names or associated with invalid codes will be rejected.

It is recommended to use "amazonDirectUpdate: true" to immediately obtain the result of the update from Amazon.

OK
Errors (amazonDirectUpdate)

Response Body`200`

Labels

createLabel

createLabel allows you to create a label in PDF or ZPL format (Settings should be configured on the control panel).

Attention

Ask for activation to Customer Care.

POSThttps://api.qapla.it/1.3/createLabel/

REQUEST
RESPONSE

Test

It is possible to obtain a test "dummy label" using the courier with GENERIC code.

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.25,
    "currencyCode": "EUR",
    "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",
    "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"
    },
    "invoice":{
      "number": "A00012345/2022"
    },
    "dangerousGoods": [
        {
           "parcel":"1",
           "type":"battery",
           "batteryPackingType":"CONTAINED_IN_EQUIPMENT",
           "batteryMaterialType":"LITHIUM_METAL"
        }
     ]
  }
}

Parameters

^*Mandatory Parameters

Parameter Description

apiKey^*(string) The channel's API 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, mediaMarkt_de, bricobravo, miravia_es
                            

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. If the field is empty or not sent, the default is '0'.
GLS Italy: the field holds the merchant's GLS contract code, not a service code. If it is empty, the first contract configured on the channel is used; if the channel has none, the call returns KO. GLS accessory services (e.g. 22 EXPRESS 12, 02 ORA FISSA) go in shippingDeliveryOptions as comma-separated codes (02, not ORA FISSA). For 02 ORA FISSA there is currently no field for the delivery time.

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

Attention: for AMAZON-SHIPPING, when used with a pickup point (PUDO object), the recipient email is mandatory.

telephone(string) Recipient telephone

amount(float) Shipment amount.
Specify only one separator (the dot) to indicate decimals, and do not use separators to indicate thousands. Give a maximum of two decimal digits. Example: 2340.23

currencyCode(string) Currency code ISO 4217 (default: EUR)

isCOD(boolean) It is true if payment is cash on delivery

payment(string) Possible order's payment method. Can be set to CONTRASSEGNO only if isCOD is also set to true

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

shippingCODPaymentOption(string) Payment method of cash on delivery if different from default settings (to be agreed)

shippingInsurance(float | string)

General
GLS-ITA
SDA
CRONO-PTI

Potential insured amount

ALL-IN: insert into "shippingDeliveryOptions" the following string: ALLIN

To generate directly with SDA, the value must be passed in the form of a string, specifying one of the following codes:

Code	Insurance type
	If no parameters are specified, no insurance type will be applied
AS01	UP TO EURO 258,23
AS02	UP TO EURO 516,46
AS03	UP TO EURO 1.549,37
AS04	UP TO EURO 2.582,28
AS05	ASSICURATA INTERNAZIONALE UP TO 1.500,00
AS12	ASSICURATA ROAD EUROPE
AS13	ASSICURATA EXPORT BOX

To generate directly with CRONO PTI, the value must be passed in the form of a string, specifying one of the following codes:

Code	Insurance type
	If no parameters are specified, no insurance type will be applied
AS01	UP TO EURO 258,23
AS02	UP TO EURO 516,46
AS03	UP TO EURO 1.549,37
AS04	UP TO EURO 2.582,28
AS05	ASSICURATA INTERNAZIONALE UP TO 1.500,00
AS12	ASSICURATA ROAD EUROPE
AS13	ASSICURATA EXPORT BOX
AS14	ASSICURATA CRONO INTERNAZIONALE

shippingDeliveryOptions(string | JSON)

General
PTI

If two values are to be used, they must be separated by commas
Example: A,P or 22,07

For PTI courier you need to use a JSON structured as follows

shippingRequiredDeliveryDate(YYYY-MM-DD) The delivery request date in the format YYYY-MM-DD

pickupDate(YYYY-MM-DD) The collection date requested to the courier in format YYYY-MM-DD

For the SDA courier, if this field is not specified when creating the label, during the transmission of the label it will be automatically assigned the working day following that of transmission.

printNodePrinterID(int | string) Possible id or name of the printer to be used with PrintNode (to be agreed)

forceReprint(int) If set to 1, it forces the label to be printed again via PrintNode; valid when used with "printNodePrinterID"

content(string) The content of the goods that may be present on the label (depends on the courier)

custom1(string) A custom field

custom2(string) A custom field

custom3(string) A custom field

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

tradeDocuments

Electronic documents to be sent to the courier. You can upload more than one file per shipment. The maximum size of each file is 5 MB.

For the moment only available for DHL, FedEx and UPS couriers.

Passed as an array of objects, with three mandatory elements each:

type(string)	The type of the file, which varies according to the courier (see table)
name(string)	The name of the file
content(string)	File content in base64 encoding

	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)

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^*(float)	Price
total(float)	Total price
weight(float)	Potential article weight
url(string)	The specific url of the product
imageUrl(string)	The url of the product image
notes(string)	Product notes
isReturnable(bool)	Product eligible for returns. If not set it is true

assemblyTypes(array)

Possible list of assembly types, one per product, for couriers who support this information

General
FERCAM

code^*(string)	The code of the selected type of assembly

Available for the "courierService" 20 (HD). One element must be specified for each element of rows.

Available values for "code":

Code	Description
5	Appliance Activation
09	Built-in ovens/cookers with declaration of conformity
08	Built-in refrigerators
07	Built-in dishwashers and washing machines
11	DUAL Air Conditioning Installation with piping to be prepared
14	DUAL Air Conditioning Installation with pre-prepared piping
10	MONO Air Conditioning Installation with piping to be prepared
13	MONO Air Conditioning Installation with pre-prepared piping
12	TRIAL Air Conditioning Installation with piping to be prepared
15	TRIAL Air Conditioning Installation with pre-prepared piping
K	Basic HD Installation
Z	Complex HD Installation
Y	Medium HD Installation
W	Simple HD Installation
06	Wall-mounted TV Installation
20	Assembly of 30
17	Exercise Bike Assembly
18	Elliptical Assembly
4	Multifunctional Structure Assembly
16	Treadmill Assembly
1	Assembly of Treadmill, Exercise Bike, and Elliptical
2	Ping Pong Table Assembly
3	Rowing Machine Assembly

PUDO(object)

Allows you to set a Pick-up or Drop-off point for the collection of goods. Each field must be completed according to the courier's need. Refer to the tables below

id^*(string)	PUDO identification
type(string)	Type of Service
name(string)	Service Name
address(string)	Address of the Pick-up or Drop-off point
city(string)	City of the Pick-up or Drop-off point
state(string)	Province of the Pick-up or Drop-off point
country(string)	Country of the Pick-up or Drop-off point
postalCode(string)	Postal code of the Pick-up or Drop-off point
description(string)	Description
harmonisedId(string)	Additional numeric ID of the Pick-up o Drop-off, derived from getPudos. Es. 104
keyword(string)	Keyword of the Pick-up o Drop-off, derived from getPudos. Es 'DHL Servicepoint'
psfKey(string)	PsfKey of the Pick-up o Drop-off, derived from getPudos. Es 'ES-0004240'
postnumber(string)	Postnumber of the Pick-up o Drop-off, only if 'packstation' type. It is a code that the end customer personally owns

**DHL / BRT / INPOST / FEDEX / MRW / SENDING / MONDIALRELAY / AMAZON-SHIPPING**
Attribute	Value
id^*(string)	PUDO identification

**TNT ITA / GLS-ITA**
Attribute	Value
id^*(string)	Possible values: TNT: identification code of TNT point/Locker; GLS-IT: identification code called SHOP_ID;
type^*(string)	Possible values: TNT: 3 (TNT point) o 5 (TNT Locker); GLS-IT: identification code called PARTNER_SHOP_ID;

**PTI(Poste Italiane)**
Attribute	Value
id^*(string)	PUDO identification
type^*(string)	Possible values: `ConsegnaPuntoPoste` `ConsegnaUfficioPostale` `ConsegnaLocker` `ConsegnaPUDOUPS`
name^*(string)	Name of the Pick-up Point
address^*(string)	Address of the Pick-up Point
postalCode^*(string)	Postal Code of the Pick-up Point
city^*(string)	City/Location of the Pick-up Point
province^*(string)	Province of the Pick-up Point
country^*(string)	Country of the Pick-up Point

**UPS**
Attribute	Value
id^*(string)	PUDO identification
address^*(string)	Address
city^*(string)	City
country^*(string)	Country
name^*(string)	Name
postalCode^*(string)	Postal Code
state^*(string)	State

**SDA**
Attribute	Value
id^*(string)	PUDO identification
address^*(string)	Address
city^*(string)	City
name^*(string)	Name
postalCode^*(string)	Postal code
state^*(string)	State

**DHL-PAKET**
Attribute	Value
id^*(string)	PUDO identification
type^*(string)	Type of PUDO ("locker" or "postoffice")
city^*(string)	City
name^*(string)	Name of PUDO
country^*(string)	Country
postalCode^*(string)	Postal code
postnumber(string)	PostNumber. Mandatory for "postoffice"

**DHLPARCEL-ES**
Attribute	Value
id^*(string)	PUDO identification
address^*(string)	Address
city^*(string)	City
country^*(string)	Country
postalCode^*(string)	Postal code
harmonisedId^*(string)	Harmonized Id
keyword^*(string)	Keyword
psfKey^*(string)	PsfKey
postnumber(string)	PostNumber

**CORREOS-EXPRESS**
Attribute	Value
id^*(string)	PUDO identifier
address^*(string)	Address
city^*(string)	City
country^*(string)	Country
postalCode^*(string)	Postal Code

**GLS-SPAIN**
Attribute	Value
id^*(string)	PUDO identification
name^*(string)	PUDO name
address^*(string)	Address
city^*(string)	City
country^*(string)	Country
postalCode^*(string)	Postal code

**SEUR**
Attribute	Value
id^*(string)	PUDO identification

**TIPSA**
Attribute	Value
id^*(string)	PUDO identifier
address^*(string)	Address
city^*(string)	City
name^*(string)	PUDO name
postalCode^*(string)	Postal Code

invoice(object)

It allows you to set information regarding the invoice associated with the shipment, useful for shipments that have to go through customs.
Mandatory for DHL

number^*(string)	Invoice number

dangerousGoods(JSON)

FEDEX

For FEDEX courier you need to use a JSON structured as follows

parcel: represents the number of the parcels that contains the dangerous goods (in the example a shipment with 3 parcels and only the first and the third contain dangerous goods)

type: battery

batteryPackingType: It can take 2 values

CONTAINED_IN_EQUIPMENT
PACKED_WITH_EQUIPMENT

batteryMaterialType: It can take 2 values

LITHIUM_METAL
LITHIUM_ION

Response Body`200`

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.
returnTrackingNumber(string)	If a returnn label is requested
format(string)	Label format: PDF (base64) JPG (base64) ZPL
labels(array)	An array with the base64 of the labels obtained (there may be multiple labels for multiple packages or returns, etc.). Or 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.

The label is also cancelled with the courier, where the courier supports it, and the order it was created from becomes available again for a new createLabel.

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

REQUEST
RESPONSE

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

getLabel

getLabel allows you to download a label created on Qapla' in the orignal courier format (PDF, JPG or ZPL).

GEThttps://api.qapla.it/1.3/getLabel/?apiKey=[API_KEY]&trackingNumber=[TRACKING_NUMBER]

GEThttps://api.qapla.it/1.3/getLabel/?apiKey=[API_KEY]&reference=[ORDER_REFERENCE]

GEThttps://api.qapla.it/1.3/getLabel/?apiKey=[API_KEY]&id=[SHIPMENT_ID]

REQUEST
RESPONSE

Parameters

Parameter	Description
apiKey^*(string)	The API Key assigned to the channel we want to query
Exclusive parameters
trackingNumber(string)	Concerned tracking number
reference(string)	Order reference
parcel(int\|string)	The parcel number corresponding to the label (default = 1) - Only for PDF labels. With all it returns every parcel in a single document: for PDF one file with a page per parcel, each in the courier's original size; for ZPL the whole string. Without "parcel" the response is still the first parcel. Example: &parcel=all
id(int)	the shipment id
json(string)	if used (eg: &json) force a JSON response
getReturnLabel(string)	if used (eg: &getReturnLabel) returns the contextual return label

Response Body`200`

The label with the proper content type (JPG, PDF or txt for ZPL)

Otherwise, if the &json param is used

"label" holds the parcel requested with "parcel" (the first one if omitted; all of them joined, with "parcel=all"). "labels" always holds every parcel, one per element, as in createLabel: for ZPL a single element with the whole string.

Label not ready yet`200`

Some couriers create the shipment before the label exists (SpediamoPro and InPost, for instance): the shipment is already created and paid for, the file follows shortly after, and on InPost the tracking number may take a few hours. Until the courier has produced it, this endpoint answers with "labelStatus" set to "PENDING" and "label" set to null, instead of the label.

PENDING is not an error: "result" is "OK" and the shipment exists. It is the answer to read again a few minutes later, by repeating the same call. Do not call createLabel again to get the label — a second call may create and charge a second shipment.

The tracking number and the label complete independently, so you may read the tracking number while the label is still null, and the other way round. This answer is returned with or without the &json parameter: an empty file would not be a useful answer.

Errors

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

error	When
label not available	The shipment exists but has no label. You will never see this on a courier that produces the label after creation: there the answer is "labelStatus": "PENDING" (see above).
return label not available	A shipment with no return label was requested with "&getReturnLabel". This is the common case: most shipments do not have one, and it is not "being produced" — it was never ordered.
label temporarily unavailable	The label exists but could not be read right now. Unlike the two above, this one is worth retrying.
requested parcel 'N' is out of range	"parcel" is lower than 1 or greater than the number of parcels of the shipment.
parcel 'all' not available for JPG labels: add json to get every parcel in labels	"parcel=all" on a multi-parcel JPG label: images are not joined into one file. With "&json" you get every parcel in "labels".
parcel 'all' not available for this label: add json to get every parcel in labels	"parcel=all" on a courier PDF that cannot be joined. Here too, "&json" returns every parcel in "labels".

checkLabel

checkLabel allows you to check the status of a previously created label.

GEThttps://api.qapla.it/1.2/checkLabel/?apiKey=[API_KEY]&trackingNumber=[TRACKING_NUMBER]

GEThttps://api.qapla.it/1.2/checkLabel/?apiKey=[API_KEY]&reference=[ORDER_REFERENCE]

GEThttps://api.qapla.it/1.2/checkLabel/?apiKey=[API_KEY]&id=[SHIPMENT_ID]

REQUEST
RESPONSE

Parameters

Parameter	Description
apiKey^*(string)	The API Key assigned to the channel we want to query
Exclusive parameters
trackingNumber(string)	Concerned tracking number
reference(string)	Order reference
id(int)	The label id

Response Body`200`

Errori

In case of an error the "result" field will contain "KO" and the "error" field 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

Ask for activation to Customer Care.

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

REQUEST
RESPONSE

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)	General GLS-AT An array of shipments ID obtained with createLabel Parameter not supported for this carrier, use labelCreationDate parameter only

Response Body`200`

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]

REQUEST
RESPONSE

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:

	at	Austria
	be	Belgium
	ch	Switzerland
	cn	China
	cy	Cyprus
	cz	Czech Republic
	de	Germany
	dk	Denmark
	ee	Estonia
	es	Spain
	eu
	fi	Finland
	fr	France
	gb	United Kingdom
	global
	gr	Greece
	hk	Hong Kong
	hr	Croatia
	hu	Hungary
	ie	Ireland
	it	Italy
	kr	South Korea
	lt	Lithuania
	lv	Latvia
	mt	Malta
	my	Malaysia
	nl	Netherlands
	pl	Poland
	pt	Portugal
	ru	Russia
	se	Sweden
	si	Slovenia
	us	USA
	za	South Africa

code

The Qapla' code of the courier

code=BRT

hasLabels

Returns couriers who have label generation on Qapla'

Response Body`200`

The following URL

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

will result:

The `variants` field

Each courier includes a variants array with any variants configured for the channel. Variants are alternative configurations of the same courier (e.g. different contracts) and have their own unique code.

id(int)	Internal variant ID
code(string)	Variant code to use in the `courier` field of pushShipment, pushOrder and createLabel
name(string)	Descriptive name of the variant

If the channel has no variants configured for a courier, variants is an empty array. Variants do not appear as top-level couriers.

detectCourier

detectCourier tries to determine the courier from the tracking number provided and responds with a list of candidates, the most likely first. Many couriers share the same tracking number format, so there can be more than one candidate; if the format is not recognised the list is empty.

Detection is based only on the format of the tracking number, measured on real shipments: it does not check that the tracking number exists at the courier. The couriers configured on the API Key's channel come first in the list.

Warning: detectCourier is meant for when the courier is not known. If you already know which courier you shipped with, pass it directly in pushShipment: do not call detectCourier and do not use the first result instead of the actual courier.

Recognised couriers: BRT, FEDEX, SENDING, SKYNET, GLS-ITA, FERCAM, DHL, PTI, SPRING-GDS, TWS, SDA, AMAZON-SHIPPING, AG-LOGISTICA, MONDIALRELAY, LICCARDI, INPOST-GROUP-V3, INPOST, TNT-ITA, CEVA-LOGISTICS, ARCO, UPS, DHLPARCEL-CONNECT, DHL-PAKET, CTT-EXPRESS, TIPSA, GLS-SPAIN, SEUR, MRW-ES, CORREOS-EXPRESS, GLS, CRONO-PTI.

GEThttps://api.qapla.it/1.2/detectCourier/?apiKey=[API_KEY]&trackingNumber=[TRACKING_NUMBER]

REQUEST
RESPONSE

Parameters

Parameter	Description
apiKey	The API Key assigned to the channel we want to query
trackingNumber	The tracking number to be identified

Response Body`200`

{
                    "detectCourier": {
                        "result": "OK",
                        "error": null,
                        "version": "1.2.12",
                        "count": 2,
                        "couriers": [{
                            "code": "GLS-ITA",
                            "name": "GLS",
                            "url": "http://www.gls-italy.com",
                            "trackingUrl": "https://gls-group.com/IT/it/servizi-online/ricerca-spedizioni?type=NAT&match=A1234567890",
                            "dateFormat": "d/m/Y H:i",
                            "hasWebService": true,
                            "country": "it",
                            "hasPickUpPoint": true,
                            "icon": "https://cdn.qapla.it/courier/GLS-ITA.svg"
                        }, {
                            "code": "FERCAM",
                            "name": "FERCAM Logistics",
                            "url": "http://www.fercam.com/",
                            "trackingUrl": "https://tracktrace.fercam.com/DirektRefA1234567890",
                            "dateFormat": "d/m/Y H:i",
                            "hasWebService": true,
                            "country": "it",
                            "hasPickUpPoint": true,
                            "icon": "https://cdn.qapla.it/courier/FERCAM.svg"
                        }]
                    }
                }

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]

REQUEST
RESPONSE

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

checkChannel

It allows you to verify the connections with the marketplace platform configured on the channel.

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

REQUEST
RESPONSE

Parameters

Parameter	Description
apiKey	The API Key assigned to the channel we want to query

Response Body`200`

Errors

In the event of an error, the "result" field will contain "KO" and the "error" field will contain the description of the error.

createChannel

It allows to create a new channel.

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

REQUEST
RESPONSE

Request

{
                  "apiKey": "[API_KEY]",
                  "createChannel": {
                    "code": "MYC1",
                    "name": "My channel name",
                    "url": "https://www.example.it",
                    "orderSettings": {
                      "import": "auto"
                    },
                    "platform": {
                      "shopify": {
                        "shopName": "qapla",
                        "apiKey": "3d445tg6yhujuuj8",
                        "password": "eedr5rg6yhu7uj",
                        "updateSettings": {
                          "updateWhenShipped": true,
                          "updateWhenShippedLocationID":1234567,
                          "updateWithShipmentStatus": true
                        }
                      }
                    },
                    "marketplaces": {
                      "amazon":{
                        "active": true,
                        "update": true,
                        "amazonSellerID": "13456787",
                        "amazonMWSAuthorisationToken": "fe3rtgh55y",
                        "amazonMarketplacesID":[
                          {
                            "country":"IT",
                            "marketplaceID":"123456"
                          },
                          {
                            "country":"ES",
                            "marketplaceID":"123456"
                          },
                          {
                            "country":"FR",
                            "marketplaceID":"123456"
                          },
                          {
                            "country":"DE",
                            "marketplaceID":"123456"
                          },
                          {
                            "country":"GB",
                            "marketplaceID":"123456"
                          }
                        ]
                      },
                      "carrefour":{
                        "active": true,
                        "update": true,
                        "settings":[
                          {
                            "country":"ES",
                            "apiKey":"123456"
                          }
                        ]
                      },
                      "cdiscount": {
                        "active": true,
                        "username": "myusername",
                        "password": "mypassword"
                      },
                      "eprice":{
                        "active": true,
                        "update": true,
                        "apiKey": "1234567"
                      },
                      "ibs": {
                        "active": true,
                        "update": true,
                        "apiKey": "fj94fr3fj034jf034fj"
                       },
                       "manomano":{
                          "apiKey":"12345678",
                          "settings":[
                            {
                              "active": true,
                              "country": "IT",
                              "login": "1234567",
                              "password": "123456"
                            },
                            {
                              "active": true,
                              "country": "ES",
                              "login": "1234567",
                              "password": "123456"
                            },
                            {
                              "active": true,
                              "country": "FR",
                              "login": "1234567",
                              "password": "123456"
                            },
                            {
                              "active": true,
                              "country": "DE",
                              "login": "1234567",
                              "password": "123456"
                            },
                            {
                              "active": true,
                              "country": "GB",
                              "login": "1234567",
                              "password": "123456"
                            }
                          ]
                       },
                       "privalia":{
                          "active": true,
                          "update": true,
                          "settings":[
                            {
                              "country": "IT",
                              "apiKey": "1234567"
                            },
                            {
                              "country": "ES",
                              "apiKey": "1234567"
                            }
                          ]
                       },
                       "spartoo":{
                          "active": true,
                          "update": true,
                          "apiKey": "1wdefrgtr3",
                          "domainsCountry":["it","es","fr","de","gb","pt","nl","gr","be","pl","cn"]
                       },
                       "worten":{
                          "active": true,
                          "update": true,
                          "settings":[
                            {
                              "country": "PT",
                              "apiKey": "1234567"
                            }
                          ]
                       }
                    }
                  }
                }

Parameters

^*Mandatory parameter

Parameter

Description

apiKey^*(string)

The API Key assigned to the channel we want to query

createChannel^*(object)

code^*(string)

The channel code (Ex. "MOC", "MYCH" )

name^*(string)

The channel name (Ex. "This is my channel name")

url^*(string)

Absolute url of your website/ecommerce (Ex. https://www.example.org)

orderSettings(object)

import(string)

Import type definition

Code	Import type
none	No import
auto	Auto import
manual	Manual import

platform(object)

ecwid(object)

storeID^*(string)
accessToken^*(string)

magento(object)

username^*(string)
storeID^*(string)

magento2(object)

username^*(string)
password^*(string)
storeID^*(string)

prestashop(object)

accessToken^*(string)

shopify(object)

shopName^*(string)

apiKey^*(string)

password^*(string)

updateSettings^*(object)

updateWhenShipped(bool)	Update the order to "shipped" when the shipment is created
updateWhenShippedLocationID(string)	Location ID retrieved from your Shopify account
updateWithShipmentStatus(bool)	Update with shipping statuses

storeden(object)

accessKey^*(string)
accessToken^*(string)

vtex(object)

domain^*(string)
appToken^*(string)
appKey^*(string)

woocommerce(object)

consumerKey^*(string)
secretKey^*(string)

marketplaces(object)

amazon(object)

active^*(bool)

Enable/disable marketplace

update^*(bool)

Order update

amazonSellerID^*(string)

amazonMWSAuthorisationToken^*(string)

amazonMarketplacesID(array object)

country^*(string)

Admitted values:

Code	Country
IT	Italy
GB	Great Britain
ES	Spain
FR	French
DE	Germany

marketplaceID^*(string)

carrefour(object)

active^*(bool)

Enable/disable marketplace

update^*(bool)

Order update

settings(array object)

country^*(string)	Admitted value: ES
apiKey^*(string)

cdiscount(object)

active^*(bool)	Enable/disable marketplace
username^*(string)
password^*(string)

ebay(object)

eprice(object)

active^*(bool)	Enable/disable marketplace
update^*(bool)	Order update
apiKey^*(string)

ibs(object)

active^*(bool)	Enable/disable marketplace
update^*(bool)	Order update
apiKey^*(string)

manomano(object)

apiKey^*(string)

settings^*(array object)

active^*(bool)

Enable/disable marketplace

country^*(string)

Admitted values:

Code	Country
IT	Italy
GB	Great Britain
ES	Spain
FR	French
DE	Germany

password^*(string)

apiKey(string)

Mandatory for REST API

sellerContractId(string)

Mandatory for REST API

privalia(object)

active^*(bool)

Enable/disable marketplace

update^*(bool)

Order Update

settings(array object)

apiKey^*(bool)
country^*(string)	Admitted values: IT, ES

spartoo(object)

active^*(bool)	Enable/disable marketplace
update^*(bool)	Order update.
apiKey^*(string)
domainsCountry^*(array)	Admitted values: "it","es","fr","de","gb","pt","nl","gr","be","pl","cn"

worten(object)

active^*(bool)

Enable/disable marketplace

update^*(bool)

Order update.

settings(array object)

apiKey^*(bool)
country^*(string)	Admitted value: PT

Response Body`200`

Errors

In the event of an error, the "result" field will contain "KO" and the "error" field will contain the description of the error.

updateChannel

It allows to change some channel settings.

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

REQUEST
RESPONSE

Request

Parameters

^*Mandatory parameter

Parameter	Description
apiKey^*(string)	The API Key assigned to the channel we want to query
updateChannel^*(object)	Like create object

Response Body`200`

Errors

In the event of an error, the "result" field will contain "KO" and the "error" field will contain the description of the error.

deleteChannel

It allows to delete a specific channel.

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

REQUEST
RESPONSE

Request

Parameters

^*Mandatory parameter

Parameter

Description

deleteChannel^*(object)

apiKey^*(string)	The API Key assigned to the channel we want to query

Response Body`200`

Errors

In the event of an error, the "result" field will contain "KO" and the "error" field will contain the description of the error.

Misc

getCredits

getCredits allows you to get the remaining credits on your premium account.

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

REQUEST
RESPONSE

Parameters

Parameter	Description
apiKey	The API Key assigned to the channel we want to query

Response Body`200`

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]

REQUEST
RESPONSE

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

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

getPudos

getPudos allows you to request the list of PUDOs (Pick Up Drop Off points) of several couriers at the same time.

Attention

Ask for activation to Customer Care.

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

REQUEST
RESPONSE
RESPONSE (unifiedResults)

Request

Parameters

^*Mandatory Parameters

Parameter	Description
apiKey^*(string)	The API Key of the channel. Alternatively, it can be provided as a query parameter in the request URL, always using the http POST method. Example: POSThttps://api.qapla.it/1.2/getPudos/?apiKey=[API_KEY]
postCode^*(string)	Postal code of the locality you intend to search for PUDOs
country^*(string)	ISO 3166-2 code of the country where the postcode is located. No quality control of the code is performed
couriers(array)	List of Qapla's "Courier Codes" whose PUDOs you want to know. Valid courier codes are UPS, BRT, GLS, GLS-ITA, GLS-SPAIN, GLS-AT, DHL, PTI, INPOST-GROUP, INPOST-GROUP-V3, INPOST (deprecated), INPOST_PL (deprecated), FEDEX, DHLPARCEL-ES, CORREOS, SEUR, TIPSA, MRW-ES, NACEX-ES, CORREOS-EXPRESS, SENDING, DHL-PAKET, SPRING-GDS, TNT-ITA and AMAZON-SHIPPING. If this parameter is not specified or left empty, PUDO locations for all valid and configured couriers in Qapla' will be retrieved
province(string)	Province of the locality being searched
city(string)	Town/city of the location being searched (required for TIPSA)
street(string)	Address, complete with house number if applicable
radius(number)	Radius, expressed in KM, within which to limit the search for PUDOs. Specifying a value ≤ 0 is equivalent to specifying no radius
limit(number)	Number of PUDOs returned per courier. Specifying a value ≤ 0 is equivalent to specifying no limit, in which case the courier will return its default
unifiedResults(bool)	If set to true, it changes the structure of the response obtained. In the data field there will be a list of pick-up points found without subdivision into courier blocks. Each item in the list will have the same structure as the items of `servicePointList` plus the `courier` field to identify the courier assigned to the pick-up point.

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"
  }
}

Parameter

Description

result(string)

Indicates whether the operation was successful, possible values are 'OK' and 'KO'

error(string)

Contains the description of the error, if any, that was raised, empty if result = 'OK'

data(array)

Array of objects containing the list of PUDOs. Each element of the array corresponds to the response obtained from a courier

statusCode(int)

Error code, result of the query made to the courier

200(int)	OK/No error
404(int)	NOT FOUND; the courier's webservice returned an empty list of PUDOs
408(int)	TIMEOUT; the courier's webservice took too long to respond
500(int)	GENERIC ERROR;
501(int)	EMPTY RESPONSE; the courier's webservice did not return a response
522(int)	UNPROCESSABLE RESPONSE; the courier webservice returned an output that could not be interpreted (e.g. invalid JSON or XML)
599(int)	CUSTOM ERROR; the webservice replied with an error specific to the courier queried, more information on the error can be found in the 'error' field

courier(string)

Code of the courier company queried (e.g. GLS, DHL, PTI, etc.)

error(string)

Possible description of the error if one was raised during the query of the individual courier

servicePointList(array)

Array of objects containing the list of PUDOs. Each element of the array corresponds to the response obtained from a courier

ID(string)	Internal identifier used by the courier
partnerID(string,optional)	Additional identifier if provided by the courier
name(string)	Name of exercise/shop/locker
type(string)	Identifies the type of PUDO: SHOP = shop, LOCKER = post office, LOCKER = locker, SHOPINSHOP = shop within another shop (used by GLS)
telephone(string)	Telephone number
street(string)	PUDO address
postCode(string)	PUDO postal code
city(string)	City/town of PUDO
province(string)	PUDO Province
country(string)	PUDO country code (2 characters)
coordinates(oggetto)	It contains two attributes, 'latitude' and 'longitude', of float type, which respectively contain the latitude and longitude of the geographical point where the PUDO is located
distance(float)	The distance in km from the address/location being researched
notes(string)	Any notes/indications
businessDays(array)	Indicates the days and hours when the PUDO is open, see dedicated section
availableServices(array)	Array of objects consisting of two attributes 'serviceCode' and 'serviceDescription', both of type string; they represent the services available from the PUDO; the 'serviceCode' field may be absent if not provided by the courier
courierSpecific(array)	Array of objects consisting of two attributes 'name' and 'value', both of type string; they represent specific fields for a given courier (e.g. harmonisedId for DHLPARCEL-ES)
holidays(array di oggetti)	Array of objects consisting of two attributes 'startDate' and 'endDate', both of type string and representing respectively start and end dates of scheduled closing periods. The dates are in the format "yyyy-mm-dd"
pushOrderPUDO(oggetto)	JSON object that can be passed to the 'pushOrder' API and can have different fields depending on the courier. For more information see pushOrder

Business Days

An object of the array businessDays represents a weekly opening day and has several attributes:

Parameter	Description
day(int)	Indicates the number of the day of the week according to ISO 8601 coding ( 1 = Monday...7 = Sunday)
dayName(string)	The name of the day of the week in English
dayNameIT(string)	The name of the day of the week in Italian
businessHours(array)	Array of objects consisting of two attributes, 'open' and 'close', both of type string, representing a time in the format 'hh: mm'

Response Body with unifiedResults = true`200`

{
  "getPudos": {
    "result": "OK",
    "data": [
      {
        "ID": "IT12348",
        "name": "Posta Privata Nazionale - Milano",
        "businessDays": [
          {
            "day": 1,
            "dayName": "Monday",
            "dayNameIT": "lunedì",
            "businessHours": [
              {
                "open": "08:30",
                "close": "13:30"
              }
            ]
          },
          {
            "day": 2,
            "dayName": "Tuesday",
            "dayNameIT": "martedì",
            "businessHours": [
              {
                "open": "08:30",
                "close": "13:30"
              }
            ]
          },
          {
            "day": 3,
            "dayName": "Wednesday",
            "dayNameIT": "mercoledì",
            "businessHours": [
              {
                "open": "08:30",
                "close": "13:30"
              }
            ]
          },
          {
            "day": 4,
            "dayName": "Thursday",
            "dayNameIT": "giovedì",
            "businessHours": [
              {
                "open": "08:30",
                "close": "13:30"
              }
            ]
          },
          {
            "day": 5,
            "dayName": "Friday",
            "dayNameIT": "venerdì",
            "businessHours": [
              {
                "open": "08:30",
                "close": "13:30"
              }
            ]
          }
        ],
        "telephone": null,
        "distance": 0.665,
        "holidays": [],
        "notes": "",
        "availableServices": [],
        "courierSpecific": [],
        "type": "SHOP",
        "pushOrderPUDO": {
          "id": "IT12348",
          "courierID": 4,
          "type": null,
          "name": "Posta Privata Nazionale - Milano",
          "address": "Via Borromini Angolo con via Zamenhof, 2",
          "city": "Milano",
          "state": "MI",
          "country": "IT",
          "postalCode": "20136",
          "description": null,
          "psfKey": null,
          "keyword": null,
          "postnumber": null,
          "harmonisedId": null
        },
        "street": "Via Borromini Angolo con via Zamenhof, 2",
        "postCode": "20136",
        "city": "Milano",
        "province": "MI",
        "country": "IT",
        "coordinates": {
          "latitude": 45.44500521478,
          "longitude": 9.1799026828
        },
        "courier": "BRT"
      },
      {
        "ID": "IT_ITLMI07601P",
        "name": "presso Fumetteria",
        "businessDays": [
          {
            "day": 1,
            "dayName": "Monday",
            "dayNameIT": "lunedì",
            "businessHours": [
              {
                "open": "14:00",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 2,
            "dayName": "Tuesday",
            "dayNameIT": "martedì",
            "businessHours": [
              {
                "open": "10:00",
                "close": "13:00"
              },
              {
                "open": "15:00",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 3,
            "dayName": "Wednesday",
            "dayNameIT": "mercoledì",
            "businessHours": [
              {
                "open": "10:00",
                "close": "13:00"
              },
              {
                "open": "15:00",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 4,
            "dayName": "Thursday",
            "dayNameIT": "giovedì",
            "businessHours": [
              {
                "open": "10:00",
                "close": "13:00"
              },
              {
                "open": "15:00",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 5,
            "dayName": "Friday",
            "dayNameIT": "venerdì",
            "businessHours": [
              {
                "open": "10:00",
                "close": "13:00"
              },
              {
                "open": "15:00",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 6,
            "dayName": "Saturday",
            "dayNameIT": "sabato",
            "businessHours": [
              {
                "open": "14:00",
                "close": "19:00"
              }
            ]
          }
        ],
        "telephone": null,
        "distance": 0.669,
        "holidays": [],
        "notes": "",
        "availableServices": [
          {
            "serviceDescription": "PARCEL_COLLECT"
          },
          {
            "serviceDescription": "PARCEL_SEND"
          }
        ],
        "courierSpecific": [
          {
            "name": "location247",
            "value": false
          },
          {
            "name": "locationType",
            "value": "OUTDOOR"
          }
        ],
        "type": "SHOP",
        "pushOrderPUDO": {
          "id": "IT_ITLMI07601P",
          "courierID": 531,
          "type": "PUDO",
          "name": "presso Fumetteria",
          "address": "Viale Toscana, 9",
          "city": "Milano",
          "state": "MI",
          "country": "IT",
          "postalCode": "20141",
          "description": null,
          "psfKey": null,
          "keyword": null,
          "postnumber": null,
          "harmonisedId": null
        },
        "street": "Viale Toscana, 9",
        "postCode": "20141",
        "city": "Milano",
        "province": "MI",
        "country": "IT",
        "coordinates": {
          "latitude": 45.44636,
          "longitude": 9.19641
        },
        "courier": "INPOST-GROUP"
      },
      {
        "ID": "IT21930",
        "name": "Visionottica Meda",
        "businessDays": [
          {
            "day": 2,
            "dayName": "Tuesday",
            "dayNameIT": "martedì",
            "businessHours": [
              {
                "open": "09:30",
                "close": "12:30"
              },
              {
                "open": "15:00",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 3,
            "dayName": "Wednesday",
            "dayNameIT": "mercoledì",
            "businessHours": [
              {
                "open": "09:30",
                "close": "12:30"
              },
              {
                "open": "15:00",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 4,
            "dayName": "Thursday",
            "dayNameIT": "giovedì",
            "businessHours": [
              {
                "open": "09:30",
                "close": "12:30"
              },
              {
                "open": "15:00",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 5,
            "dayName": "Friday",
            "dayNameIT": "venerdì",
            "businessHours": [
              {
                "open": "09:30",
                "close": "12:30"
              },
              {
                "open": "15:00",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 6,
            "dayName": "Saturday",
            "dayNameIT": "sabato",
            "businessHours": [
              {
                "open": "09:30",
                "close": "12:30"
              },
              {
                "open": "15:00",
                "close": "19:30"
              }
            ]
          }
        ],
        "telephone": null,
        "distance": 0.742,
        "holidays": [],
        "notes": "",
        "availableServices": [],
        "courierSpecific": [],
        "type": "SHOP",
        "pushOrderPUDO": {
          "id": "IT21930",
          "courierID": 4,
          "type": null,
          "name": "Visionottica Meda",
          "address": "Via G. Meda, 6",
          "city": "Milano",
          "state": "MI",
          "country": "IT",
          "postalCode": "20136",
          "description": null,
          "psfKey": null,
          "keyword": null,
          "postnumber": null,
          "harmonisedId": null
        },
        "street": "Via G. Meda, 6",
        "postCode": "20136",
        "city": "Milano",
        "province": "MI",
        "country": "IT",
        "coordinates": {
          "latitude": 45.44571735,
          "longitude": 9.17922488
        },
        "courier": "BRT"
      },
      {
        "ID": "IT27079",
        "name": "Sorsi e Sorrisi",
        "businessDays": [
          {
            "day": 1,
            "dayName": "Monday",
            "dayNameIT": "lunedì",
            "businessHours": [
              {
                "open": "07:30",
                "close": "15:30"
              },
              {
                "open": "17:00",
                "close": "23:45"
              }
            ]
          },
          {
            "day": 2,
            "dayName": "Tuesday",
            "dayNameIT": "martedì",
            "businessHours": [
              {
                "open": "07:30",
                "close": "15:30"
              },
              {
                "open": "17:00",
                "close": "23:45"
              }
            ]
          },
          {
            "day": 3,
            "dayName": "Wednesday",
            "dayNameIT": "mercoledì",
            "businessHours": [
              {
                "open": "07:30",
                "close": "15:30"
              },
              {
                "open": "17:00",
                "close": "23:45"
              }
            ]
          },
          {
            "day": 4,
            "dayName": "Thursday",
            "dayNameIT": "giovedì",
            "businessHours": [
              {
                "open": "07:30",
                "close": "15:30"
              },
              {
                "open": "17:00",
                "close": "23:45"
              }
            ]
          },
          {
            "day": 5,
            "dayName": "Friday",
            "dayNameIT": "venerdì",
            "businessHours": [
              {
                "open": "07:30",
                "close": "15:30"
              },
              {
                "open": "17:00",
                "close": "23:45"
              }
            ]
          },
          {
            "day": 6,
            "dayName": "Saturday",
            "dayNameIT": "sabato",
            "businessHours": [
              {
                "open": "07:30",
                "close": "15:30"
              },
              {
                "open": "17:00",
                "close": "23:45"
              }
            ]
          }
        ],
        "telephone": null,
        "distance": 0.775,
        "holidays": [],
        "notes": "",
        "availableServices": [],
        "courierSpecific": [],
        "type": "SHOP",
        "pushOrderPUDO": {
          "id": "IT27079",
          "courierID": 4,
          "type": null,
          "name": "Sorsi e Sorrisi",
          "address": "Via Tabacchi, 3",
          "city": "Milano",
          "state": "MI",
          "country": "IT",
          "postalCode": "20136",
          "description": null,
          "psfKey": null,
          "keyword": null,
          "postnumber": null,
          "harmonisedId": null
        },
        "street": "Via Tabacchi, 3",
        "postCode": "20136",
        "city": "Milano",
        "province": "MI",
        "country": "IT",
        "coordinates": {
          "latitude": 45.44754986,
          "longitude": 9.18027533
        },
        "courier": "BRT"
      },
      {
        "partnerID": "PRP_IT",
        "ID": "463122",
        "name": "Il Mercante dei Navigli",
        "businessDays": [
          {
            "day": 1,
            "dayName": "Monday",
            "dayNameIT": "lunedì",
            "businessHours": [
              {
                "open": "15:00",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 2,
            "dayName": "Tuesday",
            "dayNameIT": "martedì",
            "businessHours": [
              {
                "open": "10:00",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 3,
            "dayName": "Wednesday",
            "dayNameIT": "mercoledì",
            "businessHours": [
              {
                "open": "10:00",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 4,
            "dayName": "Thursday",
            "dayNameIT": "giovedì",
            "businessHours": [
              {
                "open": "10:00",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 5,
            "dayName": "Friday",
            "dayNameIT": "venerdì",
            "businessHours": [
              {
                "open": "10:00",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 6,
            "dayName": "Saturday",
            "dayNameIT": "sabato",
            "businessHours": [
              {
                "open": "10:00",
                "close": "13:30"
              },
              {
                "open": "15:00",
                "close": "19:00"
              }
            ]
          }
        ],
        "telephone": null,
        "distance": 0.77530193,
        "holidays": [],
        "notes": "E-SM S.N.C. DI CASIMINO STEFANO E STRACCHI MARCO",
        "availableServices": [
          {
            "serviceDescription": "offersParcelCollection"
          },
          {
            "serviceDescription": "offersReturnDropOff"
          }
        ],
        "courierSpecific": [],
        "type": "SHOP",
        "pushOrderPUDO": {
          "id": "463122",
          "courierID": "GLS-ITA",
          "type": "PRP_IT",
          "name": "Il Mercante dei Navigli",
          "address": "Via Giuseppe Meda, 11",
          "city": "Milano",
          "state": "MI",
          "country": "IT",
          "postalCode": "20136",
          "description": null,
          "psfKey": null,
          "keyword": null,
          "postnumber": null,
          "harmonisedId": null
        },
        "street": "Via Giuseppe Meda, 11",
        "postCode": "20136",
        "city": "Milano",
        "province": "MI",
        "country": "IT",
        "coordinates": {
          "latitude": 45.4454166,
          "longitude": 9.1794442
        },
        "courier": "GLS-ITA"
      },
      {
        "partnerID": "PRP_IT",
        "ID": "12923",
        "name": "Nikan Store",
        "businessDays": [
          {
            "day": 1,
            "dayName": "Monday",
            "dayNameIT": "lunedì",
            "businessHours": [
              {
                "open": "09:30",
                "close": "13:00"
              },
              {
                "open": "14:30",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 2,
            "dayName": "Tuesday",
            "dayNameIT": "martedì",
            "businessHours": [
              {
                "open": "09:30",
                "close": "13:00"
              },
              {
                "open": "14:30",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 3,
            "dayName": "Wednesday",
            "dayNameIT": "mercoledì",
            "businessHours": [
              {
                "open": "09:30",
                "close": "13:00"
              },
              {
                "open": "14:30",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 4,
            "dayName": "Thursday",
            "dayNameIT": "giovedì",
            "businessHours": [
              {
                "open": "09:30",
                "close": "13:00"
              },
              {
                "open": "14:30",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 5,
            "dayName": "Friday",
            "dayNameIT": "venerdì",
            "businessHours": [
              {
                "open": "09:30",
                "close": "13:00"
              },
              {
                "open": "14:30",
                "close": "19:00"
              }
            ]
          }
        ],
        "telephone": null,
        "distance": 0.93835735,
        "holidays": [],
        "notes": "Nikan Store di Nicholas Panzarino",
        "availableServices": [
          {
            "serviceDescription": "offersParcelCollection"
          },
          {
            "serviceDescription": "offersReturnDropOff"
          }
        ],
        "courierSpecific": [],
        "type": "SHOP",
        "pushOrderPUDO": {
          "id": "12923",
          "courierID": "GLS-ITA",
          "type": "PRP_IT",
          "name": "Nikan Store",
          "address": "Via Atto Vannucci, 2",
          "city": "Milano",
          "state": "MI",
          "country": "IT",
          "postalCode": "20135",
          "description": null,
          "psfKey": null,
          "keyword": null,
          "postnumber": null,
          "harmonisedId": null
        },
        "street": "Via Atto Vannucci, 2",
        "postCode": "20135",
        "city": "Milano",
        "province": "MI",
        "country": "IT",
        "coordinates": {
          "latitude": 45.4492509,
          "longitude": 9.1975994
        },
        "courier": "GLS-ITA"
      },
      {
        "ID": "IT25589",
        "name": "Esdra Nails And Beauty",
        "businessDays": [
          {
            "day": 2,
            "dayName": "Tuesday",
            "dayNameIT": "martedì",
            "businessHours": [
              {
                "open": "10:00",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 3,
            "dayName": "Wednesday",
            "dayNameIT": "mercoledì",
            "businessHours": [
              {
                "open": "10:00",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 4,
            "dayName": "Thursday",
            "dayNameIT": "giovedì",
            "businessHours": [
              {
                "open": "10:00",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 5,
            "dayName": "Friday",
            "dayNameIT": "venerdì",
            "businessHours": [
              {
                "open": "10:00",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 6,
            "dayName": "Saturday",
            "dayNameIT": "sabato",
            "businessHours": [
              {
                "open": "09:00",
                "close": "18:00"
              }
            ]
          }
        ],
        "telephone": null,
        "distance": 0.958,
        "holidays": [],
        "notes": "",
        "availableServices": [],
        "courierSpecific": [],
        "type": "SHOP",
        "pushOrderPUDO": {
          "id": "IT25589",
          "courierID": 4,
          "type": null,
          "name": "Esdra Nails And Beauty",
          "address": "Corso San Gottardo, 26",
          "city": "Milano",
          "state": "MI",
          "country": "IT",
          "postalCode": "20136",
          "description": null,
          "psfKey": null,
          "keyword": null,
          "postnumber": null,
          "harmonisedId": null
        },
        "street": "Corso San Gottardo, 26",
        "postCode": "20136",
        "city": "Milano",
        "province": "MI",
        "country": "IT",
        "coordinates": {
          "latitude": 45.44950294,
          "longitude": 9.17967502
        },
        "courier": "BRT"
      },
      {
        "ID": "IT29501",
        "name": "Ecostore - Via Ripamonti",
        "businessDays": [
          {
            "day": 1,
            "dayName": "Monday",
            "dayNameIT": "lunedì",
            "businessHours": [
              {
                "open": "08:30",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 2,
            "dayName": "Tuesday",
            "dayNameIT": "martedì",
            "businessHours": [
              {
                "open": "08:30",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 3,
            "dayName": "Wednesday",
            "dayNameIT": "mercoledì",
            "businessHours": [
              {
                "open": "08:30",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 4,
            "dayName": "Thursday",
            "dayNameIT": "giovedì",
            "businessHours": [
              {
                "open": "08:30",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 5,
            "dayName": "Friday",
            "dayNameIT": "venerdì",
            "businessHours": [
              {
                "open": "08:30",
                "close": "19:00"
              }
            ]
          }
        ],
        "telephone": null,
        "distance": 0.998,
        "holidays": [],
        "notes": "",
        "availableServices": [],
        "courierSpecific": [],
        "type": "SHOP",
        "pushOrderPUDO": {
          "id": "IT29501",
          "courierID": 4,
          "type": null,
          "name": "Ecostore - Via Ripamonti",
          "address": "Via Ripamonti, 113",
          "city": "Milano",
          "state": "MI",
          "country": "IT",
          "postalCode": "20141",
          "description": null,
          "psfKey": null,
          "keyword": null,
          "postnumber": null,
          "harmonisedId": null
        },
        "street": "Via Ripamonti, 113",
        "postCode": "20141",
        "city": "Milano",
        "province": "MI",
        "country": "IT",
        "coordinates": {
          "latitude": 45.4401065,
          "longitude": 9.2000441
        },
        "courier": "BRT"
      },
      {
        "partnerID": "PRP_IT",
        "ID": "47644",
        "name": "computerland",
        "businessDays": [
          {
            "day": 1,
            "dayName": "Monday",
            "dayNameIT": "lunedì",
            "businessHours": [
              {
                "open": "10:00",
                "close": "13:00"
              },
              {
                "open": "15:30",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 2,
            "dayName": "Tuesday",
            "dayNameIT": "martedì",
            "businessHours": [
              {
                "open": "10:00",
                "close": "13:00"
              },
              {
                "open": "15:30",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 3,
            "dayName": "Wednesday",
            "dayNameIT": "mercoledì",
            "businessHours": [
              {
                "open": "10:00",
                "close": "13:00"
              },
              {
                "open": "15:30",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 4,
            "dayName": "Thursday",
            "dayNameIT": "giovedì",
            "businessHours": [
              {
                "open": "10:00",
                "close": "13:00"
              },
              {
                "open": "15:30",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 5,
            "dayName": "Friday",
            "dayNameIT": "venerdì",
            "businessHours": [
              {
                "open": "10:00",
                "close": "13:00"
              },
              {
                "open": "15:30",
                "close": "19:00"
              }
            ]
          }
        ],
        "telephone": null,
        "distance": 1.0074232,
        "holidays": [],
        "notes": "computerland sas",
        "availableServices": [
          {
            "serviceDescription": "offersParcelCollection"
          },
          {
            "serviceDescription": "offersReturnDropOff"
          }
        ],
        "courierSpecific": [],
        "type": "SHOP",
        "pushOrderPUDO": {
          "id": "47644",
          "courierID": "GLS-ITA",
          "type": "PRP_IT",
          "name": "computerland",
          "address": "viale bligny, 43",
          "city": "Milano",
          "state": "MI",
          "country": "IT",
          "postalCode": "20136",
          "description": null,
          "psfKey": null,
          "keyword": null,
          "postnumber": null,
          "harmonisedId": null
        },
        "street": "viale bligny, 43",
        "postCode": "20136",
        "city": "Milano",
        "province": "MI",
        "country": "IT",
        "coordinates": {
          "latitude": 45.4510869,
          "longitude": 9.1957608
        },
        "courier": "GLS-ITA"
      },
      {
        "partnerID": "PRP_IT",
        "ID": "263627",
        "name": "GOLDBET",
        "businessDays": [
          {
            "day": 1,
            "dayName": "Monday",
            "dayNameIT": "lunedì",
            "businessHours": [
              {
                "open": "14:00",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 2,
            "dayName": "Tuesday",
            "dayNameIT": "martedì",
            "businessHours": [
              {
                "open": "10:30",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 3,
            "dayName": "Wednesday",
            "dayNameIT": "mercoledì",
            "businessHours": [
              {
                "open": "10:30",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 4,
            "dayName": "Thursday",
            "dayNameIT": "giovedì",
            "businessHours": [
              {
                "open": "10:30",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 5,
            "dayName": "Friday",
            "dayNameIT": "venerdì",
            "businessHours": [
              {
                "open": "10:30",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 6,
            "dayName": "Saturday",
            "dayNameIT": "sabato",
            "businessHours": [
              {
                "open": "10:30",
                "close": "19:00"
              }
            ]
          },
          {
            "day": 7,
            "dayName": "Sunday",
            "dayNameIT": "domenica",
            "businessHours": [
              {
                "open": "10:30",
                "close": "19:00"
              }
            ]
          }
        ],
        "telephone": null,
        "distance": 1.1167239,
        "holidays": [],
        "notes": "COMBOBET SNC",
        "availableServices": [
          {
            "serviceDescription": "offersParcelCollection"
          },
          {
            "serviceDescription": "offersReturnDropOff"
          }
        ],
        "courierSpecific": [],
        "type": "SHOP",
        "pushOrderPUDO": {
          "id": "263627",
          "courierID": "GLS-ITA",
          "type": "PRP_IT",
          "name": "GOLDBET",
          "address": "VIA VOLVINIO, 46",
          "city": "Milano",
          "state": "MI",
          "country": "IT",
          "postalCode": "20141",
          "description": null,
          "psfKey": null,
          "keyword": null,
          "postnumber": null,
          "harmonisedId": null
        },
        "street": "VIA VOLVINIO, 46",
        "postCode": "20141",
        "city": "Milano",
        "province": "MI",
        "country": "IT",
        "coordinates": {
          "latitude": 45.4341372,
          "longitude": 9.1834563
        },
        "courier": "GLS-ITA"
      },
      {
        "ID": "IT_ITLMI04797P",
        "name": "presso Riparazione Cellulari Usati",
        "businessDays": [
          {
            "day": 1,
            "dayName": "Monday",
            "dayNameIT": "lunedì",
            "businessHours": [
              {
                "open": "10:30",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 2,
            "dayName": "Tuesday",
            "dayNameIT": "martedì",
            "businessHours": [
              {
                "open": "10:30",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 3,
            "dayName": "Wednesday",
            "dayNameIT": "mercoledì",
            "businessHours": [
              {
                "open": "10:30",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 4,
            "dayName": "Thursday",
            "dayNameIT": "giovedì",
            "businessHours": [
              {
                "open": "10:30",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 5,
            "dayName": "Friday",
            "dayNameIT": "venerdì",
            "businessHours": [
              {
                "open": "10:30",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 6,
            "dayName": "Saturday",
            "dayNameIT": "sabato",
            "businessHours": [
              {
                "open": "10:30",
                "close": "19:30"
              }
            ]
          }
        ],
        "telephone": null,
        "distance": 1.15,
        "holidays": [],
        "notes": "",
        "availableServices": [
          {
            "serviceDescription": "PARCEL_COLLECT"
          },
          {
            "serviceDescription": "PARCEL_SEND"
          }
        ],
        "courierSpecific": [
          {
            "name": "location247",
            "value": false
          },
          {
            "name": "locationType",
            "value": "INDOOR"
          }
        ],
        "type": "SHOP",
        "pushOrderPUDO": {
          "id": "IT_ITLMI04797P",
          "courierID": 531,
          "type": "PUDO",
          "name": "presso Riparazione Cellulari Usati",
          "address": "Via Lodovico Montegani, 10",
          "city": "Milano",
          "state": "MI",
          "country": "IT",
          "postalCode": "20141",
          "description": null,
          "psfKey": null,
          "keyword": null,
          "postnumber": null,
          "harmonisedId": null
        },
        "street": "Via Lodovico Montegani, 10",
        "postCode": "20141",
        "city": "Milano",
        "province": "MI",
        "country": "IT",
        "coordinates": {
          "latitude": 45.43651,
          "longitude": 9.17795
        },
        "courier": "INPOST-GROUP"
      },
      {
        "ID": "IT_ITLMI08455P",
        "name": "presso Caf Usc",
        "businessDays": [
          {
            "day": 1,
            "dayName": "Monday",
            "dayNameIT": "lunedì",
            "businessHours": [
              {
                "open": "10:30",
                "close": "13:30"
              },
              {
                "open": "15:30",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 2,
            "dayName": "Tuesday",
            "dayNameIT": "martedì",
            "businessHours": [
              {
                "open": "10:30",
                "close": "13:30"
              },
              {
                "open": "15:30",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 3,
            "dayName": "Wednesday",
            "dayNameIT": "mercoledì",
            "businessHours": [
              {
                "open": "10:30",
                "close": "13:30"
              },
              {
                "open": "15:30",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 4,
            "dayName": "Thursday",
            "dayNameIT": "giovedì",
            "businessHours": [
              {
                "open": "10:30",
                "close": "13:30"
              },
              {
                "open": "15:30",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 5,
            "dayName": "Friday",
            "dayNameIT": "venerdì",
            "businessHours": [
              {
                "open": "10:30",
                "close": "13:30"
              },
              {
                "open": "15:30",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 6,
            "dayName": "Saturday",
            "dayNameIT": "sabato",
            "businessHours": [
              {
                "open": "10:30",
                "close": "14:30"
              }
            ]
          }
        ],
        "telephone": null,
        "distance": 1.155,
        "holidays": [],
        "notes": "",
        "availableServices": [
          {
            "serviceDescription": "PARCEL_COLLECT"
          },
          {
            "serviceDescription": "PARCEL_SEND"
          }
        ],
        "courierSpecific": [
          {
            "name": "location247",
            "value": false
          },
          {
            "name": "locationType",
            "value": "INDOOR"
          }
        ],
        "type": "SHOP",
        "pushOrderPUDO": {
          "id": "IT_ITLMI08455P",
          "courierID": 531,
          "type": "PUDO",
          "name": "presso Caf Usc",
          "address": "Via Lodovico Montegani, 17",
          "city": "Milano",
          "state": "MI",
          "country": "IT",
          "postalCode": "20141",
          "description": null,
          "psfKey": null,
          "keyword": null,
          "postnumber": null,
          "harmonisedId": null
        },
        "street": "Via Lodovico Montegani, 17",
        "postCode": "20141",
        "city": "Milano",
        "province": "MI",
        "country": "IT",
        "coordinates": {
          "latitude": 45.43629,
          "longitude": 9.17815
        },
        "courier": "INPOST-GROUP"
      },
      {
        "partnerID": "PRP_IT",
        "ID": "163261",
        "name": "ENEL",
        "businessDays": [
          {
            "day": 1,
            "dayName": "Monday",
            "dayNameIT": "lunedì",
            "businessHours": [
              {
                "open": "09:30",
                "close": "13:30"
              }
            ]
          },
          {
            "day": 2,
            "dayName": "Tuesday",
            "dayNameIT": "martedì",
            "businessHours": [
              {
                "open": "09:30",
                "close": "13:30"
              }
            ]
          },
          {
            "day": 3,
            "dayName": "Wednesday",
            "dayNameIT": "mercoledì",
            "businessHours": [
              {
                "open": "09:30",
                "close": "13:30"
              }
            ]
          },
          {
            "day": 4,
            "dayName": "Thursday",
            "dayNameIT": "giovedì",
            "businessHours": [
              {
                "open": "09:30",
                "close": "13:30"
              }
            ]
          },
          {
            "day": 5,
            "dayName": "Friday",
            "dayNameIT": "venerdì",
            "businessHours": [
              {
                "open": "09:30",
                "close": "13:30"
              }
            ]
          }
        ],
        "telephone": null,
        "distance": 1.1828501,
        "holidays": [],
        "notes": "PLAN SRL",
        "availableServices": [
          {
            "serviceDescription": "offersParcelCollection"
          },
          {
            "serviceDescription": "offersReturnDropOff"
          }
        ],
        "courierSpecific": [],
        "type": "SHOP",
        "pushOrderPUDO": {
          "id": "163261",
          "courierID": "GLS-ITA",
          "type": "PRP_IT",
          "name": "ENEL",
          "address": "VIA IMPERIA, 11",
          "city": "Milano",
          "state": "MI",
          "country": "IT",
          "postalCode": "20142",
          "description": null,
          "psfKey": null,
          "keyword": null,
          "postnumber": null,
          "harmonisedId": null
        },
        "street": "VIA IMPERIA, 11",
        "postCode": "20142",
        "city": "Milano",
        "province": "MI",
        "country": "IT",
        "coordinates": {
          "latitude": 45.4416663,
          "longitude": 9.1740051
        },
        "courier": "GLS-ITA"
      },
      {
        "ID": "IT_ITLMI06863P",
        "name": "presso Cartoleria",
        "businessDays": [
          {
            "day": 1,
            "dayName": "Monday",
            "dayNameIT": "lunedì",
            "businessHours": [
              {
                "open": "09:30",
                "close": "13:00"
              },
              {
                "open": "15:00",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 2,
            "dayName": "Tuesday",
            "dayNameIT": "martedì",
            "businessHours": [
              {
                "open": "09:30",
                "close": "13:00"
              },
              {
                "open": "15:00",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 3,
            "dayName": "Wednesday",
            "dayNameIT": "mercoledì",
            "businessHours": [
              {
                "open": "09:30",
                "close": "13:00"
              },
              {
                "open": "15:00",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 4,
            "dayName": "Thursday",
            "dayNameIT": "giovedì",
            "businessHours": [
              {
                "open": "09:00",
                "close": "13:00"
              },
              {
                "open": "15:00",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 5,
            "dayName": "Friday",
            "dayNameIT": "venerdì",
            "businessHours": [
              {
                "open": "09:00",
                "close": "13:00"
              },
              {
                "open": "15:00",
                "close": "19:30"
              }
            ]
          },
          {
            "day": 6,
            "dayName": "Saturday",
            "dayNameIT": "sabato",
            "businessHours": [
              {
                "open": "09:00",
                "close": "13:00"
              },
              {
                "open": "15:30",
                "close": "19:30"
              }
            ]
          }
        ],
        "telephone": null,
        "distance": 1.429,
        "holidays": [],
        "notes": "",
        "availableServices": [
          {
            "serviceDescription": "PARCEL_COLLECT"
          },
          {
            "serviceDescription": "PARCEL_SEND"
          }
        ],
        "courierSpecific": [
          {
            "name": "location247",
            "value": false
          },
          {
            "name": "locationType",
            "value": "INDOOR"
          }
        ],
        "type": "SHOP",
        "pushOrderPUDO": {
          "id": "IT_ITLMI06863P",
          "courierID": 531,
          "type": "PUDO",
          "name": "presso Cartoleria",
          "address": "Via Giuseppe Ripamonti, 186",
          "city": "Milano",
          "state": "MI",
          "country": "IT",
          "postalCode": "20141",
          "description": null,
          "psfKey": null,
          "keyword": null,
          "postnumber": null,
          "harmonisedId": null
        },
        "street": "Via Giuseppe Ripamonti, 186",
        "postCode": "20141",
        "city": "Milano",
        "province": "MI",
        "country": "IT",
        "coordinates": {
          "latitude": 45.43367,
          "longitude": 9.2009
        },
        "courier": "INPOST-GROUP"
      },
      {
        "ID": "IT_ITLMI06073P",
        "name": "presso Mail Express",
        "businessDays": [
          {
            "day": 1,
            "dayName": "Monday",
            "dayNameIT": "lunedì",
            "businessHours": [
              {
                "open": "09:00",
                "close": "13:00"
              },
              {
                "open": "15:00",
                "close": "18:30"
              }
            ]
          },
          {
            "day": 2,
            "dayName": "Tuesday",
            "dayNameIT": "martedì",
            "businessHours": [
              {
                "open": "09:00",
                "close": "13:00"
              },
              {
                "open": "15:00",
                "close": "18:30"
              }
            ]
          },
          {
            "day": 3,
            "dayName": "Wednesday",
            "dayNameIT": "mercoledì",
            "businessHours": [
              {
                "open": "09:00",
                "close": "13:00"
              },
              {
                "open": "15:00",
                "close": "18:30"
              }
            ]
          },
          {
            "day": 4,
            "dayName": "Thursday",
            "dayNameIT": "giovedì",
            "businessHours": [
              {
                "open": "09:00",
                "close": "13:00"
              },
              {
                "open": "15:00",
                "close": "18:30"
              }
            ]
          },
          {
            "day": 5,
            "dayName": "Friday",
            "dayNameIT": "venerdì",
            "businessHours": [
              {
                "open": "09:00",
                "close": "13:00"
              },
              {
                "open": "15:00",
                "close": "18:30"
              }
            ]
          }
        ],
        "telephone": null,
        "distance": 1.947,
        "holidays": [],
        "notes": "",
        "availableServices": [
          {
            "serviceDescription": "PARCEL_COLLECT"
          },
          {
            "serviceDescription": "PARCEL_SEND"
          }
        ],
        "courierSpecific": [
          {
            "name": "location247",
            "value": false
          },
          {
            "name": "locationType",
            "value": "INDOOR"
          }
        ],
        "type": "SHOP",
        "pushOrderPUDO": {
          "id": "IT_ITLMI06073P",
          "courierID": 531,
          "type": "PUDO",
          "name": "presso Mail Express",
          "address": "Via Giuseppe Ripamonti, 242",
          "city": "Milano",
          "state": "MI",
          "country": "IT",
          "postalCode": "20141",
          "description": null,
          "psfKey": null,
          "keyword": null,
          "postnumber": null,
          "harmonisedId": null
        },
        "street": "Via Giuseppe Ripamonti, 242",
        "postCode": "20141",
        "city": "Milano",
        "province": "MI",
        "country": "IT",
        "coordinates": {
          "latitude": 45.42862,
          "longitude": 9.20232
        },
        "courier": "INPOST-GROUP"
      }
    ]
  }
}

Parameter

Description

result(string)

Indicates whether the operation was successful, possible values are 'OK' and 'KO'

error(string)

Contains the description of the error, if any, that was raised, empty if result = 'OK'

data(array)

Array of objects representing the list of PUDOs.

ID(string)	Internal identifier used by the courier
partnerID(string, optional)	Additional identifier if provided by the courier
name(string)	Name of exercise/shop/locker
type(string)	Identifies the type of PUDO: SHOP = shop, POSTOFFICE = post office, LOCKER = locker, SHOPINSHOP = shop within another shop (used by GLS)
telephone(string)	Telephone number
street(string)	PUDO address
postCode(string)	PUDO postal code
city(string)	City/town of PUDO
province(string)	PUDO Province
country(string)	PUDO country code (2 characters)
coordinates(object)	It contains two attributes, 'latitude' and 'longitude', of float type, which respectively contain the latitude and longitude of the geographical point where the PUDO is located
distance(float)	The distance in km from the address/location being researched
notes(string)	Any notes/indications
businessDays(array)	Indicates the days and hours when the PUDO is open, see dedicated section
availableServices(array)	Array of objects consisting of two attributes 'serviceCode' and 'serviceDescription', both of type string; they represent the services available from the PUDO; the 'serviceCode' field may be absent if not provided by the courier
courierSpecific(array)	Array of objects consisting of two attributes 'name' and 'value', both of type string; they represent specific fields for a given courier (e.g. harmonizedId for DHLPARCEL-ES)
holidays(array of objects)	Array of objects consisting of two attributes 'startDate' and 'endDate', both of type string and representing respectively start and end dates of scheduled closing periods. The dates are in the format "yyyy-mm-dd"
pushOrderPUDO(object)	JSON object that can be passed to the 'pushOrder' API and can have different fields depending on the courier. For more information see pushOrder
courier(string)	Courier identification code

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">
    let apiKey = "7b1b7235"; // your channel's public API Key
    let reference = "104"; // your order's reference
    // let noCSS = true;
    // let compact = true;
    // let lang = "en";
</script>

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

<!-- Place this element where you want to display the Qapla' Tracking -->
<div id="qapla-tracking"></div>

Parameters

Parameter

Description

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.

compact(bool)

If true a compact version is displayed.

lang(string)

if set it shows the courier statuses in the selected language. If not set, the default ('it') is used

lang(string)

Languages in which courier statuses can be displayed

it(string)	Italian
en(string)	English
de(string)	German
fr(string)	French
es(string)	Spanish
pt(string)	Portuguese
zh(string)	Chinese
ru(string)	Russian
jp(string)	Japanese
cs(string)	Czech
rn(string)	Romanian
hu(string)	Hungarian
ar(string)	Arabic
sk(string)	Slovak
pl(string)	Polish
kr(string)	Korean

Result

The result is an HTML that will be inserted into the element with id qapla-tracking having the following content.

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.

id	name	Description
0	PROCESSING WAIT	Shipment found but any news yet from courier.
1	PENDING	Shipment found but any news yet from courier.
2	WAITING FOR PICK-UP	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 DELIVERY 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.

The AMAZON code is not in the list: it stands for Amazon Prime shipments of Amazon orders fulfilled by the seller (Merchant Fulfilled Network), and it is used in createLabel and pushOrder on channels that have the Amazon courier configured. Not to be confused with AMAZON-SHIPPING (Amazon Shipping), which is in the list.

Code	Name	URL
TWOGO	2GO	https://www.parcel2go.com/tracking/
THREE-JMS-LOGISTICS	3JMS Logistics	https://www.aftership.com/carriers/3jmslogistics
FOURPX	4PX	http://express.4px.com/
NINENINE-MINUTOS	99minutos	https://tracking.99minutos.com/
A1-POST	A1 Post	https://a1post.bg/en/track/
ABF-FREIGHT	ABF Freight	https://arcb.com/tools/tracking.html#/
ACS-COURIER	ACS Courier	https://www.acscourier.net/en/
AG-LOGISTICA	AG Logistica	http://www.aglogisticasrl.it/
AIR-EXPRESS-IT	Air Express	https://airexpress.it/
AIRMEE	Airmee	https://www.airmee.com/
AIRPAK-EXPRESS	Airpak Express	https://tracking.airpak-express.com/tracking.aspx?stid=airpak&cn=
AIRTRANS	AirTrans	https://track.wqxs.com/93/
ALBANIA-POST	Albania Post	https://www.postashqiptare.al/
ALI-BUSINESS-LOGISTICS	Ali Business Logistics
ALIEXPRESS	Aliexpress	https://www.aliexpress.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/
ANJUN-LOGISTICS	Anjun Logistics	http://www.szanjuntrack.com/Szanjuntrack.asp
APP2DELIVERY	App2delivery
ARAMEX	Aramex	http://www.aramex.com
ARAMEX-AT	Aramex AT	https://www.aramex.com.au/tools/track?l=
ARAMEX-AU	Aramex AU	https://www.aramex.com.au/
ARAMEX-NZ	Aramex NZ	https://www.aramex.co.nz/tools/track?l=
ARAS-KARGO	Aras Kargo	https://kargotakip.araskargo.com.tr/mainpage.aspx?code=
ARCO	Arco Spedizioni	http://www.arco.it/
ARMENIA-POST	Armenia Post	https://www.haypost.am/hy/track-and-trace
ASENDIA	Asendia Europe	https://www.asendia.com
ASENDIA-DE	ASENDIA Germany	http://www.asendia.de/
ASENDIA-HK	Asendia HK	https://www.asendia.hk/cn/tracking/
ASENDIA-UK	Asendia UK	https://www.asendia.co.uk/tracking/
ASENDIA-UK-PREMIUM	Asendia UK Premium	https://watchmyparcel.com/asendia
ASENDIA-USA	ASENDIA USA	http://www.asendiausa.com/
ASM	ASM	http://www.asmred.com
ATLANTIC	Atlantic International Express	https://atlanticcourier.net/
AUEXPRESS	Auexpress	https://www.auexpress.com/order_track.php
AUSTRALIA-POST	Australia Post	https://auspost.com.au/
AUSTRIAN-POST	Austrian Post	https://www.post.at
AXLEHIRE	AxleHire	https://tracking.axlehire.com/
BETSERVICE	B&T Service	http://www.betservice.net/
BAHRAIN-POST	Bahrain Post	http://www.bahrain.bh/
BEJOT-LOGISTICS	Bejot Logistics	https://bejotlogistics.com/order/tracking/
BELPOCHTA	Belpochta	https://belpost.by/
BENIN-POST	Benin Post	http://courrier.laposte.bj/IPSWebTracking/
BH-POSTA	BH Posta	https://www.posta.ba/
BIZ-COURIER	Biz Courier	https://www.bizcourier.eu/
BLUECARE-EXPRESS	Bluecare Express	https://www.bluecare.express/Home/About
BORDER-EXPRESS	Border Express	https://www.borderexpress.com.au/tracking/?cn=
BA-POST	Bosnia And Herzegovina Post	http://www.posta.ba//en/track-trace-2/
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
BUFFALO-SOUTH-AFRICA	Buffalo South Africa	https://www.buffaloex.co.za/track.html?number=
BULGARIAN-POSTS	Bulgarian Posts	https://www.bgpost.bg/en
CACESA-POSTAL	Cacesa Postal	https://www.cacesapostal.com/Tracking?q=
CAINIAO	Cainiao	https://global.cainiao.com/detail.htm?mailNoList=&spm=a3708.7860688.0.d01
CARGO-INTERNATIONAL	Cargo International	https://www.cargointernational.de/sendungsverfolgung/tracking/
CARGUS	Cargus	https://app.urgentcargus.ro/Private/Tracking.aspx
CBL-LOGISTICA	CBL Logistica	http://www.cbl-logistica.com
CDEK-EXPRESS	CDEK Express	https://www.cdek.ru/ru/tracking?order_id=
CDEK-TURKEY	CDEK Turkey	https://www.cdek.com.tr/en
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/
CHIT-CHATS	Chit Chats	https://chitchats.com/tracking/
CHOICE-LOGISTICS	CHOICE Logistics	https://track.choicelogistics.com/elekta
CHRONOPOST-FR	Chronopost France	http://www.chronopost.fr/
CHRONOPOST-PORTUGAL	Chronopost Portugal(DPD)	https://chronopost.pt/en/node/167
CHUKOU1-LOGISTICS	Chukou1 Logistics	http://www.chukou1.com/LogistictsTrack.aspx?trackNo=
CHUNGHWA-POST	Chunghwa POST	http://postserv.post.gov.tw/pstmail/main_mail.html
CIRRO	CIRRO	https://www.cirroparcel.com/en/tracking-results/?id=&year=2023
CJ-LOGISTICS	CJ Logistics	https://www.cjlogistics.com/cn/tool/international/tracking
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
COLLIVERY	Collivery	https://collivery.net/tracking
COMONE-EXPRESS	ComOne Express	http://www.com1logistics.com/tracking.html?trackNo=
CON-WAY-FREIGHT	Con-way Freight	https://app.ltl.xpo.com/appjs/tracking/#/tracking
COORDINADORA	Coordinadora	https://www.coordinadora.com/
CORREO-URUGUAYO	Correo Uruguayo	https://ahiva.correo.com.uy/servicioConsultaTntIps-wsWeb/seguimientoEnvios/eventosweb?codigoPieza=&retry=433
CORREOS	Correos	http://www.correos.es
CORREOS-EXPRESS	Correos Express	https://www.correosexpress.com
COSCO-EGLOBAL	COSCO eGlobal	https://elines.coscoshipping.com/ebusiness/
COURANT	Courant	https://track.aftership.com/trackings?courier=courant-plus&language=fr&tracking-numbers=
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
CTC-EXPRESS	CTC Express	http://www.ctc-express.com.tw/
CTS_GROUP	CTS GROUP	https://www.ctsgroup.nl/en/
CTT	CTT	https://www.ctt.pt
CTT-EXPRESS	CTT Express	https://www.cttexpress.com/
CUBYN	Cubyn	https://www.cubyn.com/
CYPRUS-POST	Cyprus Post	https://www.cypruspost.post/
DAC-IT	D.A.C	https://dac-it.com/
DACHSER	Dachser	https://www.dachser.com/
DAI-POST	DAI Post	https://www.daipost.com/
DAO365	DAO365	https://www.dao.as/en/private/track-your-parcel?stregkode=
DAY-AND-ROSS	Day & Ross	https://dayross.com/view-shipment-tracking?division=Freight
DAYLIGHT-TRANSPORT	Daylight Transport	https://mydaylight.dylt.com/external/shipment?probill=
DBSCHENKER	DB Schenker	https://www.dbschenker.com/
DELCART	Delcart	http://www.delcart.in/tracking_details_3.php
DELNEXT	Delnext	https://www.delnext.com/IT/track_your_parcel
DEUTSCHE-POST	Deutsche Post	https://www.deutschepost.de/
DHL-DE	Deutsche Post DHL	http://www.dpdhl.com/
DEX-I	DEX-I	https://www.dexi.com.my/
DHL-ECOMMERCE	DHL eCommerce	http://webtrack.dhlglobalmail.com/
DHL	DHL Express	http://www.dhl.com/
DHL-FREIGHT	DHL Freight	https://www.logistics.dhl
DHL-GLOBAL-MAIL-ASIA	DHL Global Mail Asia	https://ecommerceportal.dhl.com/track/?ref=
DHL-HONG-KONG	DHL Hong Kong	https://www.logistics.dhl/hk-zh/home/tracking.html
DHL-PAKET	DHL Paket	https://www.dhl.de/
DHLPARCEL-CONNECT	DHL Parcel Connect	http://www.dhl.com/
DHLPARCEL-NL	DHL Parcel NL	https://www.dhlparcel.nl/
DHLPARCEL-ES	DHL Parcel Spain
DIDADI-LOGISTICS-TECH	DIDADI LOGISTICS TECH
DMM	DMM Network	http://www.dmmnetwork.it/
DOTZOT	Dotzot	http://dotzot.in/index-web.html
DPD	DPD	http://www.dpd.com/
DPD-HR	DPD Croatia	https://www.dpd.com/hr/en/receiving-parcels/parcel-tracking/
DPD-CZ	DPD CZ	https://www.dpdgroup.com/cz/mydpd/my-parcels/incoming?parcelNumber=
DPD-FR	DPD France	http://www.dpd.fr
DPD-IE	DPD Ireland	https://dpd.ie/tracking?deviceType=5&consignmentNumber=
DPD-NL	DPD Netherlands	https://www.dpd.com/nl/en/receiving/track/
DPD-PL	DPD Poland	https://www.dpd.com.pl/
DPD-PT	DPD Portugal	https://tracking.dpd.pt/track-and-trace?reference=
DPD-RO	DPD Romania	https://tracking.dpd.ro/
DPD-RU	DPD Russia	https://www.dpd.ru/dpd/search/search.do2
DPD-CH	DPD Switzerland	https://www.dpd.com/ch/en/mydpd/
DPD-UK	DPD UK	http://www.dpd.co.uk/
DPE-EXPRESS	DPE Express	http://www.dpe.net.cn/Tracking.php
DPEX	DPEX	https://dpex.com/track-and-trace/
DSV	DSV	http://www.dsv.com/
DX-DELIVERY	DX Delivery	https://www.dxdelivery.com/consumer/my-tracking/
EARLY-BIRD	Early Bird	https://earlybird.se/tracking/
EASY-SHIP	Easy Ship	https://www.trackmyshipment.co/shipment-tracking/
ECMS-EXPRESS	ECMS Express	https://ese.ecmsglobal.com/#/ecms/tracking?order_number=
ECOM-EXPRESS	Ecom Express	https://ecomexpress.in/tracking/?awb_field=
ECOSCOOTING	ECOSCOOTING	https://play.ecoscooting.com/tracking
ECUADOR-POST	Ecuador Post	https://www.correosdelecuador.gob.ec/rastreo-de-envios/
EFMX	eFMX	https://www.fmx.asia/cn/result_detail.php?p=1&conno=
EFS-ASIA	EFS Asia	http://web.efs.asia/script/users/tracking.php
ELOG-LUXEMBOURG	Elog Luxembourg	https://www.elog-luxembourg.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/
EQUICK	Equick	http://www.equick.cn/F10003.aspx
ESTAFETA-USA	Estafeta USA	https://rastreositecorecms.azurewebsites.net/Rastreo/Resultados/
ESTES	Estes	http://www.estes-express.com/WebApp/ShipmentTracking/MainServlet
EWE-GLOBAL-EXPRESS	EWE Global Express	https://www.ewe.com.au/html/track.html?cno=#track-results
EXELOT	Exelot	https://my.exelot.com/public/track/
EXPRESS-COURIER	Express Courier	https://expresscourierintl.com/tracking-results/?tracking_id=
FAR-INTERNATIONAL-LOGISTICS	Far International Logistics	https://www.far800.com/
FAROE-ISLANDS-POST	Faroe Islands Post	https://www.posta.fo/search?cc=
FAST-WL	FAST WORLD LOGISTIC	http://www.fastwl.com/
FASTWAY-NZ	Fastway New Zealand	https://www.fastway.co.nz/tools/track/
FBA-AU-SWISHIP	FBA AU Swiship	https://www.swiship.com.au/track/?id=
FBA-CA-SWISHIP	FBA CA Swiship	https://www.swiship.ca/track/?loc=zh-CN&id=*****
FBA-DE-SWISHIP	FBA DE Swiship	https://www.swiship.de/track/?id=
FBA-FR-SWISHIP	FBA FR Swiship	https://www.swiship.fr/track?id=
FBA-IT-SWISHIP	FBA IT Swiship	https://www.swiship.it/track?loc=it-IT&id=
FBA-JP-SWISHIP	FBA JP Swiship	https://www.swiship.jp/track/?loc=ja-JP&id=
FBA-UK-SWISHIP	FBA UK Swiship	https://www.swiship.co.uk/track/?id=
FBA-USA-SWISHIP	FBA USA Swiship	https://www.swiship.com/track/?id=
FEDEX	FedEx	http://www.fedex.com/
FEDEX-FIMS	Fedex FIMS	http://mailviewrecipient.fedex.com/recip_package_summary.aspx?PostalID=
FEDEX-POLAND-DOMESTIC	FedEx Poland Domestic	https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=&cntry_code=pl&locale=pl_PL
FERCAM	FERCAM Logistics	http://www.fercam.com/
FERMOPOINT	Fermopoint	https://www.fermopoint.it
FIJI-POST	Fiji Post	http://www.postfiji.com.fj/pages.cfm/services/track-trace/
FINESSO	Finesso	https://www.finesso.it/
FINLAND-POST-POSTI	Finland Post - Posti	https://www.posti.fi/private/tracking/#/?lang=en
FIRSTMILE	FirstMile	https://track.firstmile.com/detail.php?n=
FLASHEXPRESS-PH	FlashExpress PH	https://flashexpress.com/fle/tracking
FLYT-EXPRESS	Flyt Express	http://www.flytexpress.com/Home/LogisticsTracking#orderIds=
FREIGHTQUOTE	Freightquote	https://www.freightquote.com/track-shipment/?bol=
GDEX	GDEX	https://web3.gdexpress.com/official/iframe/etracking_v4.php?input=&choice=cnGdex
GEBRUDER-WEISS-GERMANY	Gebrüder Weiss Germany	https://www.gw-world.com/#/
GEIS-CZ	Geis CZ	https://www.geis-group.cz/en/tracking-tracing?p=
GEL-EXPRESS	GEL Express	https://srv4.thalmaier.de/gel/send/EN-en/TrackingAndTracing.aspx?sp=1&snr=&submit.x=13&submit.y=7
GENIKI-TAXYDROMIKI	Geniki Taxydromiki	https://www.taxydromiki.com/track/
GEODIS	Geodis	https://geodis.com/
GLOBALTR	Global Trasporti	http://www.globaltrasporti.com/
GLOBEGISTICS-INC	Globegistics Inc.	https://us.mytracking.net/globegistics/portal/ExternalTracking.aspx?track=
GLS-ITA	GLS	http://www.gls-italy.com
GLS-AT	GLS Austria	https://gls-group.com/AT/en/home
GLS-CA	GLS Canada	https://gls-canada.com/en/express/tracking/result
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-DE	GLS Germany	https://www.gls-pakete.de/en/parcel-tracking?match=
GLS-PL	GLS Poland	https://gls-group.com/PL/en/parcel-tracking
GLS-SK	GLS Slovakia	https://gls-group.eu/SK/en/parcel-tracking.html?match=
GLS-SPAIN	GLS Spain	https://m.gls-spain.es/
GLS-US	GLS US	https://www.gls-us.com/Tracking/PackageDetail
GO-EXPRESS	GO! Express & Logistics	https://www.general-overnight.com
GOGLOBAL-POST	Goglobal Post	https://www.goglobalpost.com/track-detail/?t=
GRAND-SLAM-EXPRESS	Grand Slam Express	http://icms.grandslamexpress.in/webtracking/WebTracking.aspx
GUERNSEY-POST	Guernsey Post	https://www.guernseypost.com/track-trace
HAPPY-POST	Happy Post	https://happy-post.com/en/track/
HEPSIJET	HepsiJET	https://www.hepsijet.com/gonderi-takibi/
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
HKD	HKD	http://www.hkdexpress.net/index.php?m=track&a=index
HONG-KONG-POST	Hong Kong Post	https://www.hongkongpost.hk/en/home/index.html
HOTWMS	HOTWMS	http://www.hotwms.com/trace.html
HRP	HR Parcel	https://www.hrparcel.com/
HRVATSKA-POSTA	Hrvatska pošta	https://www.posta.hr
HUA-HAN-LOGISTICS	Hua Han Logistics	http://www.hhddb.com/default/index/get-track-detail
HUNTER-EXPRESS	Hunter Express	https://www.hunterexpress.com.au/tracking/
ICS-COURIER	ICS courier	https://www.icscourier.ca/online-services/parcel-tracking.aspx
IDS-GERMANY	IDS Germany	https://www.ids-logistik.de/de/sendungsverfolgung?trackingNumber=
IMILE	iMile	https://www.imile.com/track/
INPOST	InPost	https://inpost.it/
INPOST-GROUP	InPostGroup	https://inpost.eu/
INPOST-GROUP-V3	InPostGroup V3	https://inpost.eu/
INSTALLO	Installo	https://www.installo.it/
INTEGRA2	Integra2	https://www.integra2.es/
INTELCOM	Intelcom	https://intelcomexpress.com/en/tracking/
INTEXPRESS	Intexpress	http://www.internetexpress.co.za/Home/TrackWBOnline
JT-BRAZIL	J&T Brazil	https://www.jtexpress.com.br/trajectoryQuery?waybillNo=
JT-EXPRESS	J&T Express	https://www.jet.co.id/track
JT-EXPRESS-PHILIPPINES	J&T Express Philippines	https://www.jtexpress.ph/index/query/gzquery.html
JT-EXPRESS-THAILAND	J&T Express Thailand	https://www.jtexpress.co.th/service/estimated-price
JT-EXPRESS-UAE	J&T Express UAE	https://www.jtexpress.ae/trajectoryQuery?waybillNo=&type=0
JANCO-ECOMMERCE	Janco Ecommerce	https://track.jancoecommerce.com/cargotracking_ecom/itxp/xpop/xpordertrack?as_order_no=
JCEX	JCEX	https://www.jcex.com/html/web/guijichaxun/index.html?nums=
JD-EXPRESS	JD Express	http://www.jdwl.com/order/search?waybillCodes=
JERSEY-POST	Jersey Post	https://www.jerseypost.com/
JNE	jne	https://cekresi.jne.co.id/
JTEXPRESS-VN	jtexpress-vn	https://jtexpress.vn/track?billcodes=&btn_track=
JUSDASR	JusdaSR	https://jusdaeurope.com/en/package-tracking/
KANGAROO-WORLDWIDE-EXPRESS	Kangaroo Worldwide Express	http://www.kangaroo.com.my/
KERRY-ECOMMERCE	Kerry eCommerce	https://kerry-ecommerce.com/en/track-trace/
KERRY-EXPRESS-TH	Kerry Express TH	https://th.kerryexpress.com/en/track/?track=
KERRY-EXPRESS-VN	Kerry Express VN	https://kerryexpress.com.vn/tracking.aspx?tc=
KERRY-LOGISTICS	Kerry Logistics	http://www.expba.com/emmis/www.kerryeas.com.html
KERRY-TJ-LOGISTICS	Kerry TJ Logistics	https://www.kerrytj.com/en/
KINTETSU-WORLD-EXPRESS	Kintetsu World Express	https://www.kwe.com
KOMON-EXPRESS	KOMON EXPRESS	http://www.komonexpress.com/
KOREA-POST	Korea Post	https://www.epost.go.kr
KYOUNGDONG	KYOUNGDONG
LA-POSTE	La Poste	https://www.laposte.fr/
LATAM-YOU	LATAM YOU	https://latamyou.com/#/newTrack?no=
LATVIJAS-PASTS	Latvijas Pasts	https://pasts.lv/
LBC-EXPRESS	LBC Express	https://www.lbcexpress.com/us/track/?tracking_no=
LD-LOGISTICS	LD Logistics	http://www.ldlog.com.cn/cxwl.asp
LEBANON-POST	Lebanon Post	https://www.libanpost.com/arabic/individuals/mailing
LEXSHIP	Lexship	https://track.lexship.com/
LICCARDI	Liccardi Trasporti	https://www.liccarditrasporti.com/
LIECHTENSTEIN-POST	Liechtenstein Post	https://www.tnt.com/express/de_ch/site/home/applications/tracking.html?searchType=CON&cons=
LIEFERGRUN	Liefergrün	https://en.liefergruen.de/sendungsverfolgung
LIETUVOS-PASTAS	Lietuvos PaÅ¡tas	https://www.post.lt/
LM-PARCEL	LM Parcel	https://www.lmparcel.com/search?nums=
LOGISTERS	Logisters
LONE-STAR-OVERNIGHT	Lone Star Overnight	https://www2.lso.com/access/package-tracking?seo_redirect=1
LP-EXPRESS	LP Express
LUXEMBOURG-POST	Luxembourg Post	https://www.post.lu
LWE	LWE	http://www.lwe.com.hk/tracking
MACEDONIA-POST	Macedonia Post	https://www.posta.com.mk/
MAGYAR-POSTA	Magyar Posta	https://www.posta.hu/
MBE-ES	Mail Boxed Etc	https://www.mbe.es/es/tracking?c=
MBE-IT	Mail Boxes Etc. Italia	https://www.mbe.it/
MAILAMERICAS	MailAmericas	http://tracking.mailamericas.com/search
MALTA-POST	Malta Post	https://www.maltapost.com/
MEEST-EXPRESS	Meest Express	https://t.meest-group.com/en
MOLDOVA-POST	Moldova Post	http://www.posta.md/en/tracking?id=
MONDIALRELAY	Mondial Relay	https://www.mondialrelay.fr
MONTENEGRO-POST	Montenegro Post	https://e-racuni.postacg.me/PracenjePosiljaka/
MRW-ES	MRW	http://www.mrw.es/
NACEX-ES	Nacex	https://www.nacex.es/
NANJING-WOYUAN	Nanjing Woyuan	http://www.nanjingwoyuan.com/
NEWAY	Neway	https://esmart.newaytransport.com/v6/tracking/Track.external?refno=
NEXIVE	Nexive	http://www.nexive.it/
NINJA-VAN-MALAYSIA	Ninja Van Malaysia	https://www.ninjavan.co/en-my
NINJA-VAN-SINGAPORE	Ninja Van Singapore	https://www.ninjavan.co/en-sg/tracking?id=
NINJA-VAN-VIETNAM	Ninja Van Vietnam	https://www.ninjavan.co/en-vn/tracking?id=
NIPPON-EXPRESS	Nippon Express
NOPAR	Nopar Solutions	http://noparsolutions.com/
NOVA-POSHTA	Nova Poshta	https://novaposhta.ua/tracking/index/cargo_number//no_redirect/1
NT-LOGISTICS-VN	NT Logistics VN	https://www.ntlogistics.vn/chi-tiet-van-don.html?bill=
NZCOURIERS	NZCouriers	https://www.nzcouriers.co.nz/nzc/servlet/ITNG_TAndTServlet?barcode_data=&page=1&VCCA=Enabled&Key_Type=BarCode#Detail_0
OMAN-POST	Oman Post	https://www.omanpost.om/track-trace
OMNI-PARCEL	Omni Parcel	http://track.omniparcel.com/?id=
OMNIVA	Omniva	https://www.omniva.ee
ONEXP	One Express	http://www.oneexpress.it
ONTRAC	OnTrac	http://www.ontrac.com
ORANGE-CONNEX	Orange Connex	http://www.orangeconnex.com.cn/tracking
ORANGEDS	OrangeDS	https://tracking.orangeds.com/
OVERSEAS-TERRITORY-US-POST	Overseas Territory US Post	https://tools.usps.com/go/TrackConfirmAction_input
PAACK	Paack
PACKETA	Packeta	https://tracking.packeta.com/
PALLETW	Palletways	http://www.palletways.com
PALLEX	Pallex	https://www.pallex.it/
PANDU-LOGISTICS	Pandu Logistics	https://pandulogistics.com/track
PARCEL-FORCE	Parcel Force	http://www.parcelforce.com
PARGO	Pargo	https://pargo.co.za/track-trace/
PASSALACQUA	Passalacqua	https://www.passalacquasrl.it/
PCA	PCA	https://www.pcaexpress.com.au/tracking/?c=
PFC-EXPRESS	PFC Express	http://www.pfcexpress.com/Manage/WebManage/Inquire.aspx?txtID=No
PICKRR	Pickrr	https://pickrr.com/tracking/#/?tracking_id=
PICKUPP	Pickupp	https://hk.pickupp.io/en/tracking
PIDGE	Pidge	https://tracking.pidge.in/login
PITNEY-BOWES	Pitney Bowes	https://trackpb.shipment.co/track
PITT-OHIO	Pitt Ohio	https://pittohio.com/myPittOhio/Shipping/LTL/TraceRequest
POCZTA-POLSKA	Poczta Polska	http://www.poczta-polska.pl
PONYU	PonyU
POS-MALAYSIA	Pos Malaysia	https://www.pos.com.my/
POST-HASTE	Post Haste	https://www.posthaste.co.nz/phl/servlet/ITNG_TAndTServlet?page=1&VCCA=Enabled&Key_Type=BarCode&barcode_data=
POST-ONE	Post One	https://postone.eu/en/track?code=
POSTA-ROMANA	Poșta Română	https://www.posta-romana.ro/
SLOVENIA-POST	Pošta Slovenije	https://www.posta.si
POSTAPLUS	PostaPlus	https://www.postaplus.com/?trackid=
PTI	Poste Italiane	http://www.poste.it
MILKMAN	PosteGoFresh	https://www.milkman.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/
PRESSIODE	Pressiode	http://pressiode.de/sendungsverfolgung
PRO-CARRIER	Pro Carrier	https://tracking.weareprocarrier.com/?tn=
PUROLATOR	Purolator	https://www.purolator.com/purolator/ship-track/tracking-summary.page
QHD	QHD	https://www.qhditalia.it/
QUIKENMX	QuikenMx	https://api.quiken.mx/track
RAIDEREX	RaidereX	https://app.detrack.com/w/#/tracking/s/c2ed7ab0c381d61e1959731ff286cbb0ba590cb4
RDA	Ramoneda	http://www.ramoneda.com/
REDUR	Redur
RHENUS	Rhenus Italia	https://www.rhenus.group/it/it/
RL-CARRIERS	RL Carriers	https://www.rlcarriers.com/shiptrace.asp
ROADRUNNER-FREIGHT	Roadrunner Freight	http://tools.rrts.com/LTLTrack/?searchValues=
ROYAL-MAIL	Royal Mail	http://www.royalmail.com
RPOST	RPost	https://www.errepost.it/
RUSSIAN-POST	Russian Post	https://www.pochta.ru
RUSTON	Ruston	http://www.ruston.cc/customer/xiaojianchaxun.html
RZY-EXPRESS	RZY Express	http://rzyexpress.com.sg/track.php
SF-EXPRESS	S.F. Express	http://www.sf-express.com
SAGAWA-GLOBAL	Sagawa Global	https://tracking.sagawa-sgx.com/sgx/trackeng.asp?enc=ENG&cat=AWB&awb=
SAIA-LTL-FREIGHT	Saia LTL Freight	https://www.saia.com/track
SAILPOST	Sailpost	http://www.sailpost.it
SMM-IT	San Marino Mail	http://www.sanmarinomail.sm
SAN-MARINO-POST	San Marino Post	https://www.poste.sm/on-line/home/servizi/servizi-on-line/tracciatura-oggetti-a-firma.html#service
SAP-EXPRESS	SAP Express	https://www.sap-express.id/en/track-awb
SAUDI-POST	Saudi Post	https://splonline.com.sa/en/shipmentdetailsstatic/?tid=
SDA	SDA	http://wwww.sda.it
SDA-RACCOMANDATA	SDA Raccomandata	http://wwww.sda.it
SDK-EXPRESS	SDK Express	http://www.sdk-express.cn/track.aspx
SENDABOX	Sendabox	http://www.sendabox.it
SENDING	Sending Transporte Urgente	https://www.sending.es
SETEL-EXPRESS	Setel Express	https://track.setel.com/t/
SEUR	Seur	http://www.seur.com
SF-INTERNATIONAL	SF International	http://www.sf-express.com/us/en/dynamic_function/waybill/#search/bill-number/
SGT	SGT Corriere Espresso	http://www.sgt.it/
SHIP-IT-ASIA	Ship It Asia	https://viewider.com/labs/shipment/track
SHIPA	Shipa	https://tracking.shipadelivery.com/?bc=
SHIPENTEGRA	ShipEntegra	https://track.shipentegra.com/result
SHIPROCKET	Shiprocket	https://www.shiprocket.in/shipment-tracking/
SHOPEE-EXPRESS-PHILIPINES	Shopee Express Philipines	https://spx.ph/#/detail/
SHOPEE-EXPRESS-VIETNAM	Shopee Express Vietnam	https://spx.vn
SHREE-ANJANI-COURIER	Shree Anjani Courier	http://anjanicourier.in/Doc_Track.aspx?No=
SINGAPORE-POST	Singapore Post	https://www.singpost.com/
SINOTRANS	Sinotrans	http://www.sinotrans-csc.com/
SKY-POSTAL	SKY Postal	https://tracking.skypostal.com/single-tracking.aspx?trck_number=
SKYNET-ITA	SkyNet Italy	http://www.skynetitaly.it
SKYNET-SOUTH-AFRICA	Skynet South Africa	https://api.skynet.co.za:3227/api/waybill/getWaybillTracking/?waybillReference=
SKYNET	SkyNet Worldwide Express	http://www.skynetwwe.com/
SLOVAK-PARCEL-SERVICE	Slovak Parcel Service	https://www.sps-sro.sk/en/track-trace/
SLOVAKIA-POST	Slovakia Post	https://tandt.posta.sk/en
SMSA-EXPRESS	SMSA Express	https://www.smsaexpress.com/trackingdetails?tracknumbers%5B0%5D=
SOUTH-AFRICAN-POST	South African Post	https://www.postoffice.co.za
SPEDIAMO	Spediamo.it	http://www.spediamo.it/
SPEDIAMOPRO	SpediamoPro	https://www.spediamopro.com/
SPEE-DEE-DELIVERY	Spee-Dee Delivery	https://speedeedelivery.com/track-a-shipment/
SPEED-POST	Speed Post
SPEEDAF-EXPRESS	Speedaf Express	https://speedaf.com/cn-cn
SPRING-GDS	Spring GDS	https://www.spring-gds.com/
STALLION-EXPRESS	Stallion Express	https://stallionexpress.ca/tracking/
STARKEN	Starken	https://www.starken.cl/
STEF-IT	STEF	https://www.stef.it/
STO-EXPRESS	STO Express	http://www.sto.cn
SUSA	Susa	https://flex.susa.it/Home
SWISS-POST	Swiss Post	https://www.post.ch/
SZENDEX	Szendex	https://erp.szendex.com/DlWebTrackingVWE/?seg=
T-CAT	T Cat	https://www.t-cat.com.tw/inquire/explain.aspx
TWS	T.W.S. Express Courier	http://www.twsexpresscourier.it
TEAM-GLOBAL-EXPRESS	Team Global Express	https://teamglobalexp.com/
TECNO-TRANS	Tecnotrans	http://www.tecnotrans.eu
TFORCE-FREIGHT	TForce Freight (UPS Freight)	https://www.tforcefreight.com/ltl/apps/Tracking?proNumbers=
THABIT-LOGISTICS	Thabit Logistics	https://thabit-logistics.com/track-shipment
TPC	The Professional Couriers (TPC)	https://www.tpcindia.com/Default.aspx
TIPSA	TIPSA	http://www.tip-sa.com/
TNT	TNT	http://www.tnt.com
TNT-AUSTRALIA	TNT Australia	https://www.tntexpress.com.au/interaction/trackntrace.aspx
TNT-CLICK	TNT Click	http://www.tnt-click.it
TNT-ES	TNT España	http://www.tnt.es
TNT-FRANCE	TNT France	http://www.tnt.fr/
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
TRACKNATOR	Tracknator	https://www.tracknator.com/#/track/
TRACKON-COURIER	Trackon Courier	http://trackoncourier.com/default.aspx
TRAKPAK	Trakpak	http://www.trackmytrakpak.com
TRANSAHER	Transaher	https://transaher.es/
TRUNKRS	Trunkrs	https://parcel.trunkrs.nl/
TTKD-EXPRESS	TTKD Express	http://www.ttkdex.com/staticFiles/pages/queryExpress.html
TYP	TYP	https://typ.delivery
UK-MAIL	UK Mail	https://www.dhl.com/gb-en/ecommerce/business-users/uk-mail.html
UNITED-DELIVERY-SERVICES	United Delivery Services	http://www.uniteddeliveryservice.com/packageTrack.php
UNIUNI	UniUni	https://uniexpress.ca/tracking?no=
UPS	UPS	http://www.ups.com/
UPS-GROUND	UPS Ground	https://www.ups.com/track?loc=en_US&tracknum=&requester=WT
UPS-MAIL-INNOVATIONS	UPS Mail Innovations	https://tracking.ups-mi.net/packageID/
USPS	USPS	https://www.usps.com/
V-XPRESS	V-Xpress	http://www.vxpress.in/track/
VASP-PT	VASP Expresso	https://www.vaspexpresso.pt/
VENIPAK	Venipak	https://venipak.com/tracking/track/
VIETNAM-POST	Vietnam Post	http://www.vnpost.vn/en-us/dinh-vi/buu-pham?key=
VIETTEL-POST	Viettel Post	http://en.viettelpost.com.vn/
WE-WORLD-EXPRESS	We World Express	https://www.weworldexpress.com/wwe/track
WEDO-LOGISTICS	WeDo Logistics	https://www.wedo.cz/
WHISTL	Whistl	https://trackmyitem.whistl.co.uk/tracking/
WINIT	Winit	http://track.winit.com.cn/tracking/index.php?s=/Index/result
WISHPOST	WishPost	https://wishpost.wish.com/tracking
WIZMO	Wizmo	https://shipwizmo.com/tracking
WNDIRECT	wnDirect	https://wndirect.com/tracking.php?type=OR&ref=&submit=#
XDP-EXPRESS	XDP Express	https://www.xdp.co.uk/track.php?c=00000&code=000
XPO-LOGISTICS	XPO Logistics	https://track.xpoweb.com/ltl-shipment/
XPRESSPOST	xpresspost	https://www.canadapost.ca/trackweb/en#/search?searchFor=
XQ-EXPRESS	XQ Express
YAKIT	Yakit	https://shipping.yakit.com/tracking?yakitId=
YAMATO	Yamato Transport
YANWEN	Yanwen	http://www.yw56.com.cn/
YDH	Ydh	http://www.ydhex.com/
YODEL	Yodel Domestic	http://www.yodel.co.uk/
YTO-EXPRESS	YTO Express	http://www.yto.net.cn/gw/service/Shipmenttracking.html
YUNEXPRESS	Yun Express	http://www.yunexpress.com/
YUNDA-EXPRESS	Yunda Express	http://www.udalogistic.com/index
YURTICI-KARGO	Yurtici Kargo	https://www.yurticikargo.com/tr/online-servisler/gonderi-sorgula?code=
ZAJIL	Zajil	https://zajil-express.com/en/
ZELERIS-ES	Zeleris	https://www.zeleris.com/
ZIM-LOGISTICS	ZIM Logistics	https://www.zim-logistics.com.cn/
ZJS-INTERNATIONAL	ZJS International	http://www.zjs.com.cn/yscp/index.jhtml
ZTO-EXPRESS	ZTO Express	https://www.zto.com/express/expressCheck.html?txtBill=
ZTO-INTERNATIONAL	ZTO International	http://kh.zto.com/kh-en/
ZUFALL-GERMANY	Zufall Germany	https://tracking.myzufall.de/Track/
ZUST	Züst Ambrosetti	http://www.zust.it/

Default
Default	0	0
ASENDIA
e-PAQ Plus
e-PAQ Select
BRT
Express	0
Priority	E
10:30	H
Circuito DPD	6
Circuito Euroexpress	7
Circuito Fedex	8
DPD Direct Infeed	9
CORREOS
Domestic
PAQ Estándar DOMICILIO
PAQ Estándar OFICINA
PAQ RETORNO PREMIUM CON Envío ASOCIADO
S0148 PAQ RETORNO
PAQ PREMIUM DOMICILIO
PAQ PREMIUM EN OFICINA
PAQ PREMIUM ENTREGA EN CITYPAQ
PAQ Estándar ENTREGA EN CITYPAQ
International
PAQ STANDARD INTERNACIONAL (I)
PAQ PREMIUM INTERNACIONAL (I)
PAQ INTERNACIONAL LIGH
CORREOS-EXPRESS
Domestic
Paq 10	20
Paq 14	21
Paq 24	22
Baleares Express	23
Canarias Express	24
Canarias Aéreo	25
Canarias Marítimo	26
Paq Empresa 14	29
ePaq 24	30
54 Entrega Plus	31
Express Islands	32
International
Paq 24	22
Internacional Estándar	27
Internacional Express	28
Paq Empresa 14	29
ePaq 24	30
54 Entrega Plus	31
CTT-EXPRESS
Domestic
CTT 10	C10
CTT 14	C14
CTT 24	C24
CTT 48	C48
CTT BALEARES ECONOMY	CBA48
CTT BALEARES EXPRESS	CBA24
CTT CANARIAS AEREO	CCA24
CTT CANARIAS DOCUMENTACIÓN	CCAE
CTT CANARIAS MARÍTIMO	CCAM
International
CTT INTERNACIONAL ECONOMY	CIES
CTT INTERNACIONAL EXPRESS	CIEX
Crono
Domestic
Express	P46
Economy	P49
Crono	P44
CRONOPLUS
ROAD EUROPE - EURODIS
Circuito Euroexpress
International
Internazionale	P48
DHL PARCEL CONNECT
Domestic
DHL Parcel Connect	connect
DHL Parcel Connect PLUS	connectPlus
International
DHL Parcel International	international
DHL-PAKET
Domestic
Paket	0
International
WeltPaket	6
Dhl
Domestic
Domestic Express
Domestic Express 10:30
Domestic Express 12:00
Domestic Express 9:00
Express Easy
International
The wording "doc" indicates services without customs, "non-doc" those with customs. If both are present, the choice is made at code level.
Economy Select (doc / non-doc)
Medical Express (doc / non-doc)
Parcel Product (doc / non-doc)
Express Worldwide H12 (doc / non-doc)
International Express Worldwide (doc / non-doc)
International Express 9:00 (doc / non-doc)
Air Capacity Sales (doc / non-doc)	70
ECONOMY BREAKBULK (doc)	71
EXPRESS 10:30 (doc / non-doc)	72
EXPRESS BREAKBULK (doc)	73
EXPRESS ENVELOPE (doc)	74
GLOBALMAIL (doc)	75
Placeholder (doc)	76
SAME DAY (doc)	77
SAMEDAY SPRINTLINE (doc)	78
EXPRESS EASY (non doc)	79
FREIGHT WORLDWIDE (non doc)	80
SAMEDAY JETLINE (non doc)	81
FERCAM
BOOK
FLEX
FIX
SPEED
Private
HD (check "assemblyTypes")
FedEx
Domestic
FedEx First	12
FedEx Priority Express	13
FedEx Priority	14
FedEx Economy	15
FedEx Priority Express Freight	16
FedEx Priority Freight	17
International
Priority
First
Economy
Connect plus
Regional Economy
GLS-AT
PARCEL	PARCEL
EXPRESS	EXPRESS
FREIGHT	FREIGHT
GLS-ES
CO1 - COURIER 14:00 Service
CO2 - COURIER BusinessParcel
CO3 - COURIER 10:00 Service
CO4 - COURIER SaturdayService
CO5 - COURIER MASIVO
CO6 - COURIER REC. EN NAVE
EC1 - EconomyParcel EconomyParcel
CA1 - CARGA MARITIMO
CO7 - COURIER ParcelShop
EC2 - EconomyParcel ParcelShop
EU1 - EUROBUSINESS PARCEL EBP
EU2 - EUROBUSINESS SMALL PARCEL EBP
AS1 - ASM TRAVELLERS ASM TRAVELLERS
Express 19:00
GLS-ITA
Codice contratto GLS / GLS contract code — vuoto: primo contratto del canale / empty: first channel contract. Servizi accessori / accessory services: shippingDeliveryOptions	<CodiceContrattoGls>
INPOST
InPost Locker Standard	1
Liccardi
Bancale	B
Dedicato	DE
Espresso	E
Reso	R
Store	ZS
MONDIALRELAY
Domestic – Merchant collection to Point Relais®	S01
Domestic – Point Relais® collection to Point Relais®	S02
International – Merchant collection to Point Relais®	S03
International – Point Relais® collection to Point Relais®	S04
International – Merchant collection to Home delivery	S05
MRW-ES
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
Standard
Premium
NACEX ES
NACEX 10:00H
NACEX 12:00H
INTERDIA mañana
INTERDIA tarde
INTERDIA aéreo
PLUS BAG 1
PLUS BAG 2
VALIJA
VALIJA IDA Y VUELTA
NACEX 19:00H
PUENTE URBANO mañana
PUENTE URBANO tarde
PUENTE URBANO nocturno.
DEVOLUCION ALBARAN CLIENTE
NACEX 08:30H
DEVOLUCION TALON
DEVOLUCION PLUS BAG 1
DEVOLUCION PLUS BAG 2
DEVOLUCION E-NACEX
NACEX SABADO
CANARIAS MARITIMO
CANARIAS 24H
PLUS PACK
E-NACEX
PREMIUM
NX-SHOP VERDE
NX-SHOP NARANJA
E-NACEX SHOP
C@MBIO
CANARIAS 48H
INMEDIATO
NACEX.SHOP
SWAP
RETORNO SWAP
DEV. ORIGEN
EURONACEX TERRESTRE
SERVICIO AEREO
EURONACEX ECONOMY
PLUSPACK EUROPA
BALEARES MARITIMO
PAACK
ST2 - Same day delivery - Timeslot available - 2 hours	ST2
PT2 - Precise day delivery - Timeslot available - 2 hours	PT2
CT2 - Two-day delivery - Timeslot available - 2 hours	CT2
WT2 - Any day delivery - Timeslot available - 2 hours	WT2
ST3 - Same day delivery - Timeslot available - 3 hours	ST3
ST4 - Same day delivery - Timeslot available - 4 hours	ST4
NT4 - Next day delivery - Timeslot available - 4 hours	NT4
PT4 - Precise day delivery - Timeslot available - 4 hours	PT4
CT4 - Two-day delivery - Timeslot available - 4 hours	CT4
WT4 - Any day delivery - Timeslot available - 4 hours	WT4
STH - Same day delivery - Timeslot available - morning or evening slots	STH
NTH - Next day delivery - Timeslot available - morning or evening slots	NTH
PTH - Precise day delivery - Timeslot available - morning or evening slots	PTH
CTH - Two-day delivery - Timeslot available - morning or evening slots	CTH
WTH - Any day delivery - Timeslot available - morning or evening slots	WTH
PTA - Precise day delivery - Timeslot available - All day	PTA
STZ - Same day delivery - Timeslot available - Other	STZ
NTZ - Next day delivery - Timeslot available - Other	NTZ
PTZ - Precise day delivery - Timeslot available - Other	PTZ
CTZ - Two-day delivery - Timeslot available - Other	CTZ
WTZ - Any day delivery - Timeslot available - Other	WTZ
XTZ - Same day / express delivery - Timeslot available - Other	XTZ
SF2 - Same day delivery - Fixed timeslot - 2 hours	SF2
NF2 - Next day delivery - Fixed timeslot - 2 hours	NF2
PF2 - Precise day delivery - Fixed timeslot - 2 hours	PF2
CF2 - Two-day delivery - Fixed timeslot - 2 hours	CF2
WF2 - Any day delivery - Fixed timeslot - 2 hours	WF2
XF2 - Same day / express delivery - Fixed timeslot - 2 hours	XF2
SF4 - Same day delivery - Fixed timeslot - 4 hours	SF4
NF4 - Next day delivery - Fixed timeslot - 4 hours	NF4
PF4 - Precise day delivery - Fixed timeslot - 4 hours	PF4
CF4 - Two-day delivery - Fixed timeslot - 4 hours	CF4
WF4 - Any day delivery - Fixed timeslot - 4 hours	WF4
XF4 - Same day / express delivery - Fixed timeslot - 4 hours	XF4
NFA - Next day delivery - Fixed timeslot - All day	NFA
PFA - Precise day delivery - Fixed timeslot - All day	PFA
CFA - Two-day delivery - Fixed timeslot - All day	CFA
WFA - Any day delivery - Fixed timeslot - All day	WFA
NFZ - Next day delivery - Fixed timeslot - Other	NFZ
PFZ - Precise day delivery - Fixed timeslot - Other	PFZ
CFZ - Two-day delivery - Fixed timeslot - Other	CFZ
WFZ - Any day delivery - Fixed timeslot - Other	WFZ
XFZ - Same day / express delivery - Fixed timeslot - Other	XFZ
PS2 - Precise day delivery - Fixed timeslot - 2 hours (custom)	PS2
Poste Delivery Business
Domestic
Standard nazionale	APT000902
Espresso nazionale	APT000901
International
Standard internazionale	APT000904
Espresso internazionale	APT000903
International Plus	APT001013
SDA
Extralarge	S09
Internazionale	S08
Economy	S24
Road Europe	S34
Export Box	S36
Crono Internazionale	P48
SEUR
Domestic
SEUR 24
SEUR 10
SEUR 13:30
SEUR FRIO 10
SEUR FRIO 13:30
Seur FRIO 48 (Baleares)
Seur 13 Saturday
Seur 24 PICKUP
International
Seur Internacional NON EU
Seur Classic (DPD) Internacional Terrestre
Seur Classic (DPD) Predict Crossborder
Seur NetExpress (SEUR) Internacional Terrestre
Seur Classic 2SHOP
Spring GDS
TRCK - TRACKED
SIGN - SIGNATURED
PPTT - PostNL Packet Tracked
PPTR - PostNL Packet Registered
PPNT - PostNL Packet Non Tracked
TIPSA
20 - DELEGATION
48 - ECONOMY
25 - FARMA
96 - MARITIMA
24 - PREMIUM
06 - TIPSA 06
10 - TIPSA 10
14 - TIPSA 14
MV - TIPSA,
50 - YUPICK
TNT IT
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
TWS
ESPRESSO	ESPRESSO
CAMIONISTICO	CAMIONISTICO
TWSPACKETEXP	TWSPACKETEXP
TWSPACKETCAM	TWSPACKETCAM
TWSPACKETDOC	TWSPACKETDOC
ESPRESSOGLS	ESPRESSOGLS
UPS
Domestic
Nazionale Express Saver	0
Nazionale Express	1
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

ARCO
Preavviso telefonico	S
Sponda idraulica	X
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
fermo deposito	F
ritiro contestuale	R
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 AT
08:00 Service	0800Service
09:00 Service	0900Service
10:00 Service	1000Service
12:00 Service	1200Service
Saturday 10:00 Service	Saturday1000Service
Saturday 12:00 Service	Saturday1200Service
Saturday Service	SaturdayService
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
MEZZO IDONEO	06
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

ARCO	G
CONTANTE	A
ASSEGNO BANCARIO INTESTATO AL MITTENTE	1
ASSEGNO CIRCOLARE INTESTATO AL MITTENTE	2
ACCETTARE EFFETTO COME EMESSO DA DESTINATARIO	9
BRT	G
CONTANTE	12
ASSEGNO INTESTATO AL MITTENTE [BP]	17
ASSEGNO CIRCOLARE INTESTATO ALLA MITTENTE [CM]	18
ASSEGNO BANCARIO INTESTATO ALLA MITTENTE [BM]	15
ASSEGNO CIRCOLARE INTESTATO AL MITTENTE ORIGINALE [OC]	10
ASSEGNO INTESTATO AL MITTENTE ORIGINALE [OM]	11
ASSEGNO BANCARIO INTESTATO CORRIERE CON MANLEVA [BB]	3
ACCETTARE ASSEGNO BANCARIO INTESTATO ALLA MITTENTE COSI COME RILASCIATO [TM]	19
DHL	G
CASH, POS	YYY
CONTANTE
ASSEGNO CIRCOLARE INTESTATO AL MITTENTE ORIGINALE	GGG
ASSEGNO BANCARIO INTESTATO AL MITTENTE ORIGINALE	QQQ
CONTANTI, POS, ASSEGNO O ASSEGNO POSTALE O ASSEGNO CIRCOLARE PAGABILE AL MITTENTE	KKK
ASSEGNO BANCARIO O ASSEGNO POSTALE INTESTATO CASA MANDANTE	RRR
ASS. CIRC. INT CASA MANDANTE	LLL
CASH, POS O ASSEGNO (BANC./POST./CIRCOLARE) INTESTATO CASA MANDANTE	JJJ
FERCAM	G
CONTANTE
ASSEGNO INTESTATO AL MITTENTE ORIGINALE
GLS-ITA	G
CONTANTE	CONT
ASSEGNO BANCARIO	AB
ASSEGNO CIRCOLARE/BANCARIO (NO POSTALE)	ABC
ASSEGNO BANCARIO/POSTALE (NO CIRCOLARE)	ABP
ASSEGNO CIRCOLARE	AC
ASSEGNO POSTALE	AP
ASSEGNO CIRCOLARE/BANCARIO/POSTALE	ASS
Ass. come rilasciato	ASR
Ass. come rilasciato int. Mittente	ARM
Ass. come rilasciato - no postale	ASRP
Ass. come rilasciato int. Mittente – no postale	ARMP
LICCARDI	G
SOLO CONTANTI	3
ASSEGNO CIRCOLARE INTESTATO AL MITTENTE	5
ASSEGNO BANCARIO INTESTATO AL MITTENTE	4
ASSEGNO A MITTENTE COME RILASCIATO	6
CONTANTI O ASSEGNO A MITTENTE COME RILASCIATO	8
POSTE DELIVERY BUSINESS	G
CONTANTE	12
ASSEGNO CIRCOLARE INTESTATO AL MITTENTE	10
ASSEGNO BANCARIO INTESTATO AL MITTENTE	11
ASSEGNO INTESTATO AL MITTENTE ORIGINALE
SDA	G
Tutti	VAR
Contanti	CON
Ass.Banc.Mittente	ABM
Ass.Banc.SDA	ABS
Ass.Circ.Mittente	ACM
Ass.Circ.SDA	ACS
TNT IT	G
CONTANTE	12
ASSEGNO INTESTATO AL MITTENTE ORIGINALE	15

Introduction

New Version Available

Previous versions

Webhook

API Key

Endpoint

Response

Rate limiting

HTTP Response Status Codes

Abuse

Sandbox

Test

Postman Collection

Shipments

pushShipment

Request

Parameters

Response Body200

Errors

getShipment

Parameters

Response Body200

Description

Errors

getShipments

Parameters

Response Body200

Description

Errors

updateShipment

Parameters

Response Body200

deleteShipment

Parameters

Response Body200

undeleteShipment

Parameters

Response Body200

trackingByTimeFrame

Parameters

Response Body200

Description

Orders

pushOrder

Parameters

Response Body200

Description

Errors

getOrder

Parameters

Response Body200

getOrders

Parameters

Response Body200

deleteOrder

Parameters

Response Body200

updateOrder

undeleteOrder

Parameters

Response Body200

detectOrderCourier

Request

Parameters

Response Body200

Errors

apiVirtual

Parameters

Response Body200

Errors

Platforms

fetchPlatformOrders

Parameters

Response Body200

Errors

updatePlatformOrder

Authentication

Parameters

Peculiarities

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`

Label not ready yet`200`

Response Body`200`

Response Body`200`

Response Body`200`

The `variants` field

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 with unifiedResults = true`200`