What inputs are required to track with Evergreen?

Evergreen requires modified input for container tracking. This article contains information about required input.

Attention:

Tracking containers with Evergreen no longer requires both the container ID and the master bill of lading number as of mid-April of 2023.

Users can now track with Evergreen using either the Create Reference via Carrier Code endpoint of the API or the Create Reference via Bill of Lading endpoint (and optionally pass a container ID) if preferred.

The information below will be preserved for historical purposes.

Note:

Any interaction with the API will always require your assigned API token. The information in this article is specific to creating a new reference.
More detailed information on creating a new reference can be found in our API documentation.

Tracking containers with Evergreen requires both the container ID and the master bill of lading number. Providing only the container ID number will return an input validation error.

Container ID and master bill of lading

Tracking by container ID and master bill of lading will generate a single reference. The API requires three inputs when tracking by container number and master bill of lading:

The container ID
The master bill of lading
Container Code

{
   "container_id": "EGHU3625353",                   //required
   "bill_of_lading": "EGLV56010315",                //required
   "carrier_code": "EGLV",                                  //required
   "callback_url": "https://yourdomain.com/webhook" //not required
}

Once the required input is passed a reference ID assigned to the container shipment will be included in the response. You may use the reference ID to get updates, reference status, unsubscribe, and more.

Master bill of lading number

Tracking by master bill of lading generates a reference for all containers related to the bill of lading, see more information on this here. The API requires two inputs when tracking by master bill of lading:

The master bill of lading number
Container Code

{
   "bill_of_lading": "EGLV56010315",                    //required
   "carrier_code": "EGLV",                                      //required
   "callback_url": "https://yourdomain.com/webhook"     //not required
}

Once the required input is passed a reference ID assigned to the bill of lading will be included in the response. You may use the reference ID to get updates, reference status, unsubscribe, and more.

The reference ID assigned to the bill of lading will now act as a parent reference ID for all containers associated with the bill of lading. See more information on the parent/child relationship between bill of lading and container references here.

Tip: The webhook callback_url is optional but is the preferred method of receiving reference updates from the API.