REST API - Products

The REST API supports retrieving the products available to ship to a specific county.

Endpoint

/parcel/products/{countryCode}

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

Products Request

Based on the provided country code the products available for shipping will be retrieved.

Method: GET
Response: 200 OK

Parameter	Type	Comment
countryCode	string	Country code for which to retrieve products

Products Response

The response format is a JSON body array with http code 200 OK.
If an error occurred an Error response will be generated.

Parameter	Type	Comment
carrier	int	The carrierId of the shipment
carrierName	string	The name of the carrier
type	int	The type of the shipment
code	string	The product code of the shipment
product	string	The product name of the shipment
coverValue	decimal	The cover value of the shipment
isTraceable	boolean	Indicates if the shipment provids Track & Trace
hasReference	boolean	Indicates if the reference is printed on the label
weight	string	The weight name of the shipment
weightMin	int	The minimum weight of the shipment in grams
weightMax	int	The maximum weight of the shipment in grams
grossPrice	decimal	The gross price of the shipment
netPrice	decimal	The net price of the shipment
handlingFee	decimal	The handling fee of the shipment
properties	Properties	Array of properties of the shipment

Properties

Field	Type	Comment
item	string	Item description
serviceId	int	ServiceId it item is of type service

{[
    {
        "carrier": 2,
        "carrierName": "PostNL",
        "type": 1,
        "code": "3085",
        "product": "Pakket",
        "coverValue": null,
        "isTraceable": true,
        "hasReference": true,
        "weight": "0 - 10 kg",
        "weightMin": 0,
        "weightMax": 10000,
        "grossPrice": 7.4000,
        "netPrice": 7.4000,
        "handlingFee": 4.8500,
        "properties": [
            {
                "item": "Track & Trace",
                "serviceId": null
            },
            {
                "item": "Excl. energietoeslag",
                "serviceId": null
            }
        ]
    },
    {
        "carrier": 2,
        "carrierName": "PostNL",
        "type": 1,
        "code": "3085",
        "product": "Pakket",
        "coverValue": null,
        "isTraceable": true,
        "hasReference": true,
        "weight": "10 - 20 kg",
        "weightMin": 10001,
        "weightMax": 20000,
        "grossPrice": 9.9500,
        "netPrice": 9.9500,
        "handlingFee": 4.8500,
        "properties": [
            {
                "item": "Track & Trace",
                "serviceId": null
            },
            {
                "item": "Excl. energietoeslag",
                "serviceId": null
            }
        ]
    }
]}