Field

Purpose

Values

Can be null?

access_token

Authorization token value to provide in subsequent API requests

String

N

token_type

Identifies this as a bearer token

String, "bearer"

N

expires_in

Number of seconds the token is valid

Integer

N

scope

Indicates this token is valid only for this service

String, "application"

N

Field

Purpose

Values

Can be null?

count

Total number of resources matching query

Integer, 0 to 2,147,483,647

N

Field

Purpose

Values

Can be null?

id

Unique identifier for this Expeditors shipment

String, 3 to 12 characters

N

status

Current description of shipment status

String, 3 to 50 characters

N

lastUpdateTime

GMT Time of last status change

String, timestamp in YYYY-MM-DDThh:mm:ssTZD

N

origin

First branch handling shipment

Type Expeditors Branch Reference

Y

destination

Final branch handing carrier unlading

Type Expeditors Branch Reference

Y

delivery

Branch handling delivery

Type Expeditors Branch Reference

Y

loading

Branch handling carrier loading

Type Expeditors Branch Reference

Y

unlading

Branch handling carrier unlading

Type Expeditors Branch Reference

Y

clearance

Branch handling customs clearance

Type Expeditors Branch Reference

Y

mode

Primary transport type

String, "Ocean" or "SEA/AIR" or "Truck"

Y

vessel

Name of carrier vessel

String, 1 to 80 characters

Y

voyageFlight

Unique identifier of carrier route

String, 1 to 40 characters

Y

freightTerms

A code representing the terms of delivery

String, 1 to 8 characters

Y

serviceType

A code for the type of service contract with Expeditors

String, 1 to 8 characters

Y

quantity

The count of goods in shipment

Type Measure

Y

weight

The weight of the shipment

Type Measure

Y

volume

The volume of the shipment

Type Measure

Y

carrier

Name of party transporting the shipment

String, 1 to 50 characters

Y

consignee

Name of party receiving shipment delivery

Type Address Information

Y

shipper

Name of party handling shipment

Type Address Information

Y

actualReceiptTimes

List of Type Event Time

Array

Y

requestedDeliveryTime

When shipment is to be delivered

String, timestamp in YYYY-MM-DDThh:mm:ssTZD

Y

goodsDesc

A description of the freight

String, 0 to 140 characters

Y

hazardous

True if shipment requires hazardous materials handling

true of false

Y

securityFilingParty

The party submitting the Import Security Filing

String, 1 to 50 characters

Y

Field

Purpose

Values

Can be null?

events

This is the same list returned from "GET shipments/{id}/events"

Array

references

This is the same list returned from "GET shipments/{id}/references"

Array

Field

Purpose

Values

Can be null?

shipper

Name of party handling shipment

Object

Y

shipper name

Shipper’s address name

String

Y

shipper address 1

First address line of shipper

String

Y

shipper address 2

Second address line of shipper

String

Y

shipper city

City where shipper is located

String

Y

shipper country code

Country where shipper is located

String

Y

shipper state

State where shipper is located

String

Y

shipper zip

Zip code where shipper is located

String

Y

consignee

Name of party receiving shipment delivery

Object

Y

consignee name

Consignee’s address name

String

Y

consignee address 1

First address line of consignee

String

Y

consignee address 2

Second address line of consignee

String

Y

consignee city

City where consignee is located

String

Y

consignee country code

Country where consignee is located

String

Y

consignee state

State where consignee is located

String

Y

consignee zip

Zip code where consignee is located

String

Y

Field

Purpose

Values

Can be null?

name

City, State where Expeditors' branch business office is located.

String, 1 to 50 characters.

Y

code

Unique identifier for Expeditors branch

String, 1 to 4 characters.

Y

Field

Purpose

Values

Can be null?

value

The measured value

Number with 1 to 10 digits, Decimals with 0 to 3 digits after the decimal point.

N

unit

Code for the unit of measure

String, "M3" (cubic meter) or "CF" (cubic feet) or "PCS" (pieces)

N

Field

Purpose

Values

Can be null?

description

A short description of the event type

String, 0 to 50 characters

N

time

The time the event occurred

String, timestamp in YYYY-MM-DDThh:mm:ssTZD

N

origin

Shipment origin

Type Expeditors Branch Reference

Y

destination

Shipment destination

Type Expeditors Branch Reference

Y

remarks

Additional description of the event

String, 0 to 116 characters

Y

invoice

The primary Expeditors shipment reference

String, 0 to 10 characters

Y

code

A unique code for the event type

String, 1 to 3 characters

N

Field

Purpose

Values

Can be null?

refType

Unique Expeditors name for the reference type

String, 1 to 28 characters

N

refNumber

Reference value associated with the shipment

String, 1 to 12 characters

N

Field

Purpose

Values

Can be null?

documentType

Description of the document

String

N

group

Internal group code of document

String

N

label

Additional identifying information for document

String

N

fileSize

Size of the document in kilobytes

String

N

numberOfPages

Number of pages of the document

String

N

downloadCallbackURL

A url that can be used to download the document pdf

This will be set to null if the encode query parameter is set to true

String

Y

Base64EncodedDocument

The document pdf encoded as a base64 string

Only included if the encode parameter is set to true

String

Y

Field

Purpose

Values

Can be null?

instanceNo

Container instance number

String

Field

Purpose

Values

Can be null?

events

This is the same list returned from "GET containers/{id}/events"

Array

lines

This is the same list returned from "GET containers/{id}/lines"

Array

Field

Purpose

Values

Can be null?

events

This is the same list returned from "GET containers/om/{id}/events"

Array

items

This is the same list returned from "GET containers/om/{id}/items"

Array

Field

Purpose

Values

Can be null?

Field

Purpose

Values

Can be null?

Field

Purpose

Values

Can be null?

Field

Purpose

Values

Can be null?

events

This is the same list returned from "GET consignments/{id}/events"

Array

references

This is the same list returned from "GET consignments/{id}/references"

Array

Field

Purpose

Values

Can be null?

Field

Purpose

Values

Can be null?

Field

Purpose

Values

Can be null?

id

Unique identifier for this Expeditors consignment or cross-dock shipment

String

documentType

Description of the document

String

N

group

Internal group code of document

String

N

label

Additional identifying information for document

String

N

fileSize

Size of the document in kilobytes

String

N

numberOfPages

Number of pages of the document

String

N

downloadCallbackUrl

A URL that can be used to download the document pdf

This will be set to null if the encode query parameter is set to true

String

Y