Printing dispatch orders

The functionality allows for generating manifests for shipments whether or not they have dispatch orders.

2 methods are available:

Method for generating a manifest for the dispatch order (printout)
Method for generating a manifest for the indicated shipment IDs (printouts)

On this page

1 Structure
2 Authentication
3 Printing a Dispatch Order
4 Printing multiple Dispatch Orders

Structure

In case of one shipment a single *.pdf file is returned
In case of multiple shipments
- In case shipments are of the same service, a single *.pdf file with all the shipments is included
- In case shipments are from multiple services, a single *.zip file containing *.pdf files is returned (separate *.pdf file for each service)
A maximum of 100 manifests for shipments can be downloaded at once

Authentication

Access to the resource requires a valid access token.

Printing a Dispatch Order

To print a dispatch order the user has to be the sender of the shipment.

GET /v1/dispatch_orders/:id/printout

Parameters

Parameter	Type	Description	Validation	Default value

Parameter	Type	Description	Validation	Default value
`format`	string	Label format	Available formats: `Pdf`	`Pdf`

Example request

curl -X GET "https://api-shipx-pl.easypack24.net/v1/dispatch_orders/1/printout?format=Pdf" -H "Content-Type: application/json" -H "Authorization: Bearer token"

Response

File in a given format

Error Information

resource_not_found - Organization does not exist,
token_invalid - Token does not allow for printing dispatch orders for the given organization
printout_generation_failed - An error occurred while communicating with the logistics system
invalid_status - Shipment is in an incorrect status
does_not_exist - The shipment provided in the request is not available for the given organization
invalid_range - Invalid shipment identifier range has been provided

Printing multiple Dispatch Orders

To print a dispatch order the user has to be the sender of the shipment.

Parameters

Parameter	Type	Description	Validation	Default value

Parameter

Type

Description

Validation

Default value

format

string

Label format

Available formats: Pdf

Pdf

dispatch_order_id

Integer

Dispatch order IDs

shipment_ids

Array[Integer]

Shipment IDs

Required if no dispatch_order_id are provided

Printing dispatch orders for shipments with and without dispatch orders is not possible.
Shipments need to have the confirmed status
At least one shipment ID has to be provided

Example request

Response