Skip to main content

Waybills

List, view and print waybills.

Note

Each waybill generates a master shipment. The service used for the master shipment depends on waybill type, and in some cases several different services can be used for the master shipment.

If only one service is available for the master shipment the service is locked and does not have to be provided in the request.

GET /shipment-waybills

Fetch a list with information about created waybills.

Note

Use the query parameters to filter out which and how many waybills will be returned in the list.

Query parameters

dateFrom

string

The lower limit of a date interval.

ISO-8601 date format, for example, 2020-01-01T01:00:00+00:00

Optional

Must be used together with dateTo.

dateTo

string

The upper limit of a date interval.

ISO-8601 date format, for example, 2020-02-01T01:00:00+00:00

Optional

Must be used together with dateFrom.

page

number

Page number you need to see.

"0" is the first page and each page contains 50 records.

Required

status

Waybill status.

Valid values: ALL | STD | PRINTED | CANCELLED

Default: STD

Optional

waybillName

string

Filter the records based on waybill name ( bulk ID ).

Can have multiple values separated by a comma (,).

Optional

waybillType

string

Filter the records based on waybill name ( bulk ID ).

Can have multiple values separated by a comma (,).

Optional

For description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /shipment-waybills GET.

GET/shipment-waybills/{waybillId}

Fetches a waybill that was previously created.

URI parameters

waybillId

string

Identification of the waybill.

Required

For description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /shipment-waybills/{waybillId} GET.

POST /shipment-waybills/{waybillId}/shipments

Prints a waybill according to the provided print configuration

Note

PDF or ZPL documents will be created according to the provided print configuration.

By default the documents are returned as a URL. As an option the documents can be inline in the print.data object in the result. The print.data object is encoded in base64.

The generated documents will only be available for one (1) hour.

URI parameters

waybillId

string

Identifies the waybill.

Required

Query parameters

returnFile

boolean

'true' if the PDF/ZPL file should be returned inline.

Optional

For description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /shipment-waybills/{waybillId}/shipments POST.