|
|
GET containers/om
Get a list of summarized information for
containers. Data can be requested for all containers or only
for containers with trace values matching the given reference,
or only for containers 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 HTTP Request
GET
tracking/v2/containers/om?ref=5555&sizeLimit=1000&offset=0&start=1970-01-01&end=1970-01-02
Authorization:
Ejr2YotnFZFEjr1zCsicMWpAAotnFZFEjr1zCsic
X-Consumer-ID:
TEST_CONSUMER_ID
X-Consumer-Custom-ID:
TEST_CUSTOM_CONSUMER_ID
Host: api.expeditors.com |
Example Curl Request
$
curl 'https://api.expeditors.com/tracking/v2/containers
/om?ref=5555&sizeLimit=1000&offset=0&start=1970-01-01&end=1970-01-02'
-i -X GET \
-H
'Authorization: Ejr2YotnFZFEjr1zCsicMWpAAotnFZFEjr1zCsic'
\
-H
'X-Consumer-ID: TEST_CONSUMER_ID' \
-H
'X-Consumer-Custom-ID: TEST_CUSTOM_CONSUMER_ID' |
Parameters
Name |
Purpose |
Values |
Required? |
| ref |
Identifier for shipment |
URL-encoded string, 10 characters |
N (default matches all shipments) |
| start |
Match any last modified time on shipment start
with. If the input value is '2020-01-01', the actual
match value is '2020-01-01 00:00:00', if a full timestamp
is supplied it is used. |
Any value that matches YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss |
N (Conditional, only required if 'end' parameter
is used) |
| end |
Match any last modified time on shipment end with.
If the input value is '2020-12-31', the actual match
value is '2020-12-31 23:59:59', if a full timestamp
is supplied it is used. |
Any value that matches YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss |
N (default is current time) |
| 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 - Container Summary for data types.
Example Response
200
OK
Content-Type:
application/json
Content-Length:
147
[
{
"instanceNo"
: "1234567890",
"containerNumber"
: "12345",
"shipmentNumber"
: "5555",
"lastUpdateTime"
: "2018-01-03T21:47:00Z"
}
] |
 |
