REST API - Label

The REST API supports retrieving the labels.
Generating a label will pre announce the shipment to the specified Carrier.
After the pre announcement it's not possible to delete the shipment anymore.

Endpoint

/parcel/label

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

Label Request

Method: POST
Response: 200 OK
Max 100 labels at once can be created

Labels

Field	Type	Comment
Output	int	1 = Label10x15, 2 = PositionsA4_A, 3 = PositionsA4_B, 4 = PositionsA4_C, 5 = PositionsA4_D, 6 = Doculop, 7 = DirectPrint
Ids	int[]	Array of shipment ids

{
    "output": 1,
    "ids":  [
        1100001,
        1110002,
        1154120
    ]
}

Label Response

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

Field	Type	Comment
Labels	Label	1 = Label10x15, 2 = PositionsA4_A, 3 = PositionsA4_B, 4 = PositionsA4_C, 5 = PositionsA4_D, 6 = Doculop, 7 = DirectPrint
ContentPDF	byte[]	Base64 encoded PDF byte array. Not applicable on Output DirectPrint

Label

Field	Type	Comment
Id	int	Id of shipment
Barcode	string	Generated barcode of shipment
TrackTraceUrl	string	Url for Track & Track of shipment

{
    "labels": [
        {
            "id": 1100001,
            "barcode": "3S1100001",
            "trackTraceUrl": "https://tracking.postnl.nl/track-and-trace/3S1100001-NL-1000AA"
        },
        {
            "id": 1110002,
            "barcode": "3S1110002",
            "trackTraceUrl": null
        },
        {
            "id": 1154120,
            "barcode": "3S1154120"            
            "trackTraceUrl": null
        }
    ],
    "contentPDF": "JVBERi0xLjMKJeLjz9MKNSAwIG9iago8PAovQ29udGVudHMgNiAwIFIKL01lZGlhQm94IFsgMCAwID..."
}