Global additions
Base url: http://exportpaczka.pl/api/v1/globalAdditions
Description
Global additions are additions for whole order, such as insurance or COD. Global additions should be provided as array inside order object:
{
"parcelType": "package",
"countryFrom": "PL",
"countryTo": "SK",
"parcelData": [
...
],
"isOwnTransport": true,
"collectionDate": "2019-12-19",
"collectionHour": 12,
"description": "order desc",
"globalAdditions": ["cod", "insurance5000"]
}
Please note that, you have to use the code attribute of global addition when passing it inside of global additions array.
Available methods:
List of all available global additions
- Method
GET - Url
/list - Full url
http://exportpaczka.pl/api/v1/globalAdditions/list - Example success response:
{
"success": true,
"body": [
{
"name": "Insurance up to 900 PLN",
"code": "insurance900"
},
{
"name": "Insurance up to 1000 PLN",
"code": "insurance1000"
},
{
"name": "Insurance up to 2000 PLN",
"code": "insurance2000"
},
{
"name": "Insurance up to 4000 PLN",
"code": "insurance4000"
},
{
"name": "Insurance up to 5000 PLN",
"code": "insurance5000"
},
{
"name": "Insurance up to 50000 PLN",
"code": "insurance50000"
},
{
"name": "Charge",
"code": "cod"
},
{
"name": "Phone information",
"code": "phoneInfo1"
},
{
"name": "SMS information",
"code": "smsInfo"
}
]
}
Find available additions for given parcel type, country from and country to
- Method
GET - Url
/find - Full url
http://exportpaczka.pl/api/v1/globalAdditions/find - Example of request body:
{
"parcelType": "package",
"countryFrom": "SK",
"countryTo": "PL"
}
- Example success response:
{
"body": [
{
"name": "Insurance up to 5000 PLN",
"price": "0,00",
"code": "insurance5000"
}
],
"success": true
}
