Search Help Contents:

 


 

Topics

Home

Getting Started

Data Types

Event Codes & References

Error Codes

Best Practices

Notifications

Version Policy

API Calls

  POST /oauth2/token

  GET /health

  Shipments

  Containers

  OM Containers

  Consignments and Cross-Dock

    GET consignments

    GET consignments/{id}

    GET consignments/{id}/events

    GET consignments/{id}/references

   GET consignments/exactmatch

   GET consignments/{id}/documents

   GET consignments/{id}/documents/{documentId}/download

   GET consignments/{id}/documents/download

 

GET consignments/{id}/documents/download

 

Download all documents for a consignment or cross-dock shipment as a combined PDF. Supports optional filtering by document type.

 

Only Proof of Delivery (POD) documents are available by default. Please reach out to your Expeditors representative for access to additional documents.

 

Example Request

GET /consignments/CONS123/documents/download?docType=POD,PCL HTTP/1.1

Authorization: Ejr2YotnFZFEjr1zCsicMWpAAotnFZFEjr1zCsic

X-Consumer-ID: TEST_CONSUMER_ID

X-Consumer-Custom-ID: TEST_CUSTOM_CONSUMER_ID

Host: localhost:8080

 

Example Curl Request

$ curl 'https://localhost:8080/consignments/CONS123/documents/download?docType=POD,PCL' -i -X GET \

    -H 'Authorization: Ejr2YotnFZFEjr1zCsicMWpAAotnFZFEjr1zCsic' \

    -H 'X-Consumer-ID: TEST_CONSUMER_ID' \

    -H 'X-Consumer-Custom-ID: TEST_CUSTOM_CONSUMER_ID'

  

Headers

Header Purpose Values

Required?

Authorization Provide bearer token Bearer "{token}"

Y

 

Parameters

Parameter Purpose Values

Required?

id Identifier for a consignment or cross-dock shipment URL-encoded string, 1 to 12 characters

Y

docType Optional comma-separated list of document type codes to filter by (e.g., 'POD', 'PCL'). When specified, only documents matching these types will be included in the download. Comma-separated document type codes (e.g., POD, PCL)

N (default returns all documents)

 

Response

Format Data Type
application/octet-stream pdf

 

© 2024 Expeditors International of Washington, Inc.  

All information contained herein is business confidential and proprietary and may not be reproduced in any form without advanced

written consent of an authorized officer of the copyright holder.

 

EULA - End User License Agreement