Versions Compared

Old Version 8

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.

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

Table of Contents

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

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

format

string

Label format

Available formats: Pdf 

Pdf

Example request

Code Block
languagejson
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
languagejson
File in a given format
Warning

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

Info

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

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

Parameters 

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

Code Block
languagejson
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
languagejson
Zip file in the given format

Warning

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