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

    GET shipments

    GET shipments/count

    GET shipments/{id}

    GET shipments/{id}/address_information

   GET shipments/{id}/documents

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

    GET shipments/{id}/events

    GET shipments/{id}/references

    GET shipments/exactmatch

  Containers

  OM Containers

  Consignments and Cross-Dock

 

GET shipments/{id}/documents

 

Get a list of Proof of Delivery (POD) documents for the shipment with the given identifier. Only POD documents will be returned.

 

Note: the documentId returned in the response containing the callback url is related to the bearer token used when the callback url was requested.  If the bearer token has expired, you will need to request the callback URL again.

 

Example Request

GET tracking/v2/shipments/1234567890/documents?encode=true

Host: api.expeditors.com

User-Agent:  HTTPie/0.9.9

Authorization: Bearer Ejr2YotnFZFEjr1zCsicMWpAAotnFZFEjr1zCsic

 

Headers

Header Purpose Values

Required?

Authorization Provide bearer token Bearer "{token}"

Y

 

Parameters

Parameter Purpose Values

Required?

id Identifier for shipment URL-encoded string, 1 to 12 characters

Y

encode A boolean flag that indicates whether the document contents should be encoded as a base64 string in the response or a download callback URL should be provided Boolean

N

 

 

Response

The response format is JSON; see Data Types - Document for data types.

 

Example Response

  • When encode = false, or encode query parameter is not defined.

200 OK

Content-Type: application/json

Cache-Control: no-store

Pragma: no-cache

 

[

  {

    "documentType": "POD-Proof of Delivery",

    "group": "",

    "label": "",

    "fileSize": "0K",

    "numberOfPages": "1",

    "downloadCallbackUrl": "https://api.expeditors.com/tracking/v2/shipments/123/documents/ABC/download",

  }

]

 

  • When encode = true

200 OK

Content-Type: application/json

Cache-Control: no-store

Pragma: no-cache

 

[

  {

    "documentType": "POD-Proof of Delivery",

    "group": "",

    "label": "",

    "fileSize": "0K",

    "numberOfPages": "1",

    "base64EncodedDocument": "JVBERi0xLjQKJeLjz9MKM...",  

  }

]

© 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