Sign in
Documents

Retrieve a waybill

Returns a waybill for letter products.

get/documents/waybill

Query parameters

carrier_code'deutsche_post' | 'asendia' | 'bring' | 'dhl_parcel' required

Carrier code to be included in the filter

bag_quantityinteger

Quantity of bags to be declared <br> <strong>Note:</strong> <ul>

<li>Required for Deutsche Post, but is only used if an open order is being closed</li> <li>For DHL Parcel it is added to container_quantity, and one of the two must be stated</li></ul>
container_quantityinteger

Quantity of containers to be declared <br> <strong>Note:</strong> <ul>

<li>Required for DHL Parcel unless bag_quantity is stated, but is only used if an open order is being closed</li> <li>If used with Deutsche Post it is just added to bag_quantity</li></ul>
from_timestring date-time required

"From" timestamp for the waybill document. Examples:

  • 2018-06-19T11:00:00.305+02:00
  • 2018-06-19 will be transformed into 2018-06-19T00:00:00.000+02:00
to_timestring date-time required

"To" timestamp for the waybill document. Examples:

  • 2018-06-20T11:00:00.305+02:00
  • 2018-06-20 will be transformed into 2018-06-20T00:00:00.000+02:00

Response

Successful.

base64string

PDF file of the document in Base64 format.

Example response

{
  "base64": "JVBERi0xLjMKJf//////AAAAAA..."
}

Changes