- Qapla' API is based on REST.
- Accepts GET, POST, PUT e DELETE JSON encoded requests.
- Returns JSON encoded values.
Previous versionsPrevious versions of this API are still active, but to be considered as deprecated.
WebhookQapla' also has a Webhook service which is an integral part of the API.
API KeyTo be able to use the APIs you need to be aware of the Private API Keys assigned to your channel(s), which can be found on the Control Panel under:
Settings \ [CHANNEL_NAME]
This API key must be protected and kept secret.
|[API_VERSION]||is the versioning value of the API.|
|[ENDPOINT]||is the endpoint you need to call.|
The system uses the TokenBucket algorithm with the following parameters:
|Bucket capacity||10||Maximum of ten requests|
|Tokens per second||1||Refilling at a rate of one per second|
HTTP Response Status CodesExceeding the limit will lead to the following HTTP response
and the following response error by any API involved
429Too Many Requests
"error": "Too Many Requests"
AbuseThe abuse of the use will lead to a BAN of the API Key.
|Plain PHP SDK||https://github.com/qapla-it/php-sdk|
|PHP 7 Package (API 1.2)||https://packagist.org/packages/maioradv/qapla created by MaiorADV|
|Laravel 5 SDK||https://packagist.org/packages/w3designweb/laravel-qapla created by w3designweb|
pushShipmentpushShipment 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.
pushOrderpushOrder allows you to upload one or more orders via a POST of data in JSON format.
getChannelgetChannel allows you to get information about the channel connected to the API Key and to the company that created it.
It's the interpretation of the status of the shipment with values that Qapla' assigns to each possible state of the courier.
|1||PENDING||Shipment found but any news yet from courier.|
|2||INFO RECEIVED||The courier didn’t pick up the shipment yet.|
|3||IN TRANSIT||The goods are in transit.|
|4||OUT FOR DELIVERY||Shipment in delivery.|
|5||FAILED ATTEMPT||Delivery failed. Early warning for potential problems.|
|8||DELAY||Shipment is suffering delay.|
|6||EXCEPTION||There is a problem; generic or explained by additional icons.|
|10||PICKUP POINT||Delivered to a PickUp Point.|
|95||RETURNED||Shipment returned to sender.|
|99||DELIVERED||The shipment has been delivered to the recipient.|
Any additional status details.