Search Help Contents:

Topics

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

Get a list of summarized information for shipments. Data can be requested for all shipments or only for shipments with trace values matching the given reference, or only for shipments that have been updated between a specific start and end date. If no page size is given, the system returns the first page of a limited number of results (see parameters for defaults).

Example Request

GET tracking/v2/shipments?ref=5555&sizeLimit=10&offset=20&start=2021-11-30T12:00:00&end=2021-11-30T13:00:00

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

Name	Purpose	Values	Required?
ref	Prefix to match against shipment reference strings	URL-encoded string, 3 to 12 characters	N (default matches all shipments)
start	Date marking the earliest lastUpdateTime for the search, in GMT	Timestamp, Format yyyy-mm-dd'T'hh:mm:ss OR Date, Format yyyy-MM-dd	N (Conditional, only required if 'end' parameter is used)
end	Date marking the latest lastUpdateTime for the search, in GMT	Timestamp, Format yyyy-mm-dd'T'hh:mm:ss OR Date, Format yyyy-MM-dd	N (default is current date)
sizeLimit	Maximum number of items to return from matching results	Integer, 1 to 100000	N (default is 1000)
offset	Start index into matching results for returned items. Increment by sizeLimit to return the next page of results.	Integer, 0 to 100000	N (default is 0)

Response

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

Example Response

200 OK

Content-Type: application/json

Cache-Control: no-store

Pragma: no-cache

[

{

"id": "1234567890",

"status": "Services Completed: Delivered",

"origin": "Amsterdam, Netherlands",

"destination": "Seattle, WA",

"lastUpdateTime": "2018-01-03T13:47:00Z"

{

"id": "0987654321",

"status": "In Transit, Docs Received at Destination",

"origin": "Lugano, Switzerland",

"destination": "Hong Kong",

"lastUpdateTime": "2018-01-03T13:47:00Z",

}

]

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