Versions Compared

Old Version 2

changes.mady.by.user Michał Machowski

Saved on

compared with

New Version Current

changes.mady.by.user Michał Machowski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Version published after converting to the new editor


Info
titleWarning!

Resource available only in the following countries: PL

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)




Panel
bgColor#f0f0f0
titleBGColor#f0f0f0
titleOn this page

Table of Contents
minLevel2
 


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 (seperate *.pdf file for each service)
  • 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

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

Code Block
GET /v1/dispatch_orders/:id/printout

Parameters 

Parameter

Type

Description

Validation

Default value

Availability

format

string

Label format

Available formats: Pdf 

Pdf

PL

Example request

Code Block
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

Code Block
File in a given format

Error Information

  • resource_not_found - Dispatch Order does not exist

  • token_invalid - Token does not allow for printing dispatch orders for the given organisation

  • printout_generation_failed - An error occured while communicating with the logistics system

  • invalid_status - Shipment is in an incorrect status



Printing multiple Dispatch Orders

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

Code Block
GET /v1/organizations/:organization_id/dispatch_orders/printouts

Parameters 

Parameter

Type

Description

Validation

Default value

Availability

format

string

Label format

Available formats: Pdf 

Pdf

PL

dispatch_order_id

Integer

Dispatch order IDs



PL

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

PL

Example request

Code Block
curl -X GET "https://api-shipx-pl.easypack24.net/v1/organizations/1/dispatch_orders/printouts?shipment_ids[]=123&shipment_ids[]=124&shipment_ids[]=125&format=Pdf" -H "Authorization: Bearer token" -H "Content-Type: application/json" -o test.zip

Response

Code Block
Zip file with labels in the given format

Error Information

  • resource_not_found - Organisation does not exist,

  • token_invalid - Token does not allow for printing dispatch orders for the given organisation

  • printout_generation_failed - An error occured while communicating with the logistics system

  • cannot_mix_shipments_with_and_without_dispatch_order - Cannot download shipments with and without a dispatch order in one request.

  • invalid_status - Shipment is in an incorrect status.