KeenDelivery API
latest
  • Authentication
  • Shipping methods
  • Shipments
  • Print labels
    • Request values
    • Reponse values
    • Error codes
  • Parcel Shops finder
KeenDelivery API
  • Docs »
  • Print labels
  • Edit on GitHub

Print labels¶

To combine the labels of multiple shipments into one file to print them, you should make to following request:

$ curl -X "POST" "https://portal.keendelivery.com/api/v2/label?api_token=YourAPIToken" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d $'{
      "shipments": [
         1234567,
         1234568,
         1234569
      ]
    }'

Request values¶

Field Type Description
shipments array The array with one or more ID’s of the shipment to fetch the labels for

Reponse values¶

The response will be like this (shortened for readability):

{
  "labels": "",
}
Property Description
labels Contains the labels encoded with base64. The format of the labels is according to the settings in the portal. (Instellingen > Print instellingen)

Error codes¶

Code Cause
401 The supplied API token is incorrect
422 Something is wrong with the request. The errors are returned in the response body as a JSON object
<?php

use GuzzleHttp\Client;

$client = new Client([
    'base_uri' => 'https://portal.keendelivery.com/api/v2/',
    'headers' => [
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'query' => ['api_token' => 'YourApiToken'],
]);

$response = $client->post(
    'label',
    ['body' => ['shipments' => [123456, 123457, 123458]]]
);

file_put_contents('labels.pdf', base64_decode(json_decode($response->getBody())->labels));
Next Previous

© Copyright 2018, KeenDelivery B.V. Revision 9382db28.

Built with Sphinx using a theme provided by Read the Docs.