REST API - Flex
The REST API supports listing Flex products based on selection.
Endpoint
/flex/list
Headers
A valid JWT token in the request is needed along with the version number to authenticate and authorize the request.
Replace ACCESS_TOKEN with a valid access token.
Authorization: Bearer ACCESS_TOKEN
Api-Version: 3.0
Content-Type: application/json
List Request
Retrieve a list of products based on the provided parameters.
Method: POST
Response: 200 OK
| Parameter | Type | Required | Comment |
|---|---|---|---|
| Quantity | int | Yes | Quantity of the bulk |
| Weight | int | Yes | Based on the weight type: The weight of the bulk in grams or per piece in grams |
| WeightType | int | Yes | 1 = Total weight, 2 = Weight per piece |
| Destination | int | Yes | 1 = NL, 2 = Europe, 3 = World |
| SendDate | date | Yes | Date when the bulk will be tendered at the carrier. Not in weekends and holidays. |
Below you can find a request for a list of Flex products.
{
"quantity": 125,
"weight": 58,
"weightType": 2,
"destination": 1,
"sendDate": "2022-09-09"
}
List Response
The response format is a JSON body with http code 200 OK.
If an error occurred an Error response will be generated.
{
"products": [
{
"carrier": "PostNL",
"zoneId": 1,
"zone": "Nederland",
"productId": 1,
"productCode": "2821",
"product": "Gemengd",
"service": 24,
"serviceDescription": "24 uur",
"quantity": 125,
"grossPrice": 243.13,
"netPriceExlVat": 243.13,
"netPriceInclVat": 294.19,
"vat": 51.06,
"piecePrice": 1.95,
"pieceWeight": 58.0,
"minimumOrder": "Minimaal € 17,50",
"isMinimumOrder": false,
"characteristics": [
"Formaat: mag verschillen",
"Verpakking: mag verschillen",
"Inhoud: mag verschillen",
"Uiterlijk: mag verschillen"
]
},
{
"carrier": "PostNL",
"zoneId": 1,
"zone": "Nederland",
"productId": 1,
"productCode": "1831",
"product": "Gemengd",
"service": 72,
"serviceDescription": "48-72 uur",
"quantity": 125,
"grossPrice": 178.38,
"netPriceExlVat": 178.38,
"netPriceInclVat": 215.84,
"vat": 37.46,
"piecePrice": 1.43,
"pieceWeight": 58.0,
"minimumOrder": "Minimaal € 17,50",
"isMinimumOrder": false,
"characteristics": [
"Formaat: mag verschillen",
"Verpakking: mag verschillen",
"Inhoud: mag verschillen",
"Uiterlijk: mag verschillen"
]
}
]
}