Use this format to send or receive events (milestones) related to a shipment.
Shipment Identifiers are inclusive. An event will only match when ALL identifiers match. For example, if you have a shipment like this:
- Master Bill: MBOL123456
- House Bill: HB111
- Container: CONT11111
- Container: CONT22222
- House Bill: HB999
- Container: CONT99999
master_bill: MBOL123456 the event will apply to all containers.master_bill: MBOL123456, house_bill: HB111 the event will apply to both containers under that house billmaster_bill: MBOL123456, container_number: CONT1111 the event will only apply to that container| Name | Description |
|---|---|
| Root | The top level document |
| Event | A single event or milestone related to a shipment. |
| Locode | A UN/LOCODE |
| Address | A physical location. |
| ReceivedByParty | The person on file having signed for receipt of goods. |
| Attachment | A file attachment |
| Name | Data Type | Description | Required |
|---|---|---|---|
doc_type | String | Always event_json | |
events | Array<Event> | Array of events | |
version | String | The version of the specification being used. |
| Name | Data Type | Description | Required |
|---|---|---|---|
actual_date | DateTime | The date the event actually occurred. (Must be in the past)' Always include | |
agent_reference | String | Reference number provided by the agent | |
booking_reference | String | The reference number assigned to the booking by the booking party | |
carrier_booking_number | String | The booking number provided by the carrier | |
carrier_scac | String | Carrier's Standard Carrier Alpha Code (SCAC) | |
container_number | String | Container number | |
container_type_code | String | ISO 6346 container type code (like 20GP) | |
estimated_date | DateTime | The date the event is estimated to occur. (May be in the past or future) Always include | |
event_code | String | Code representing the type of event | YES |
event_code_context | String | Additional context information about the event. | |
event_description | String | A description of the event. Some systems may have different descriptions for the same event across shipments. For example, a security filing event may include the filing number in the description. Therefore, you should always code against the | |
event_location | Address | Deprecated - Please use location instead. event_location will be removed in a future release.The location associated with the event. Only city, state, and country will be processed | |
event_message | String | Any notes for the event | |
event_reason_code | String | A code representing the reason for the event. Typically different than the event code | |
event_unlocode | Locode | The UN/Locode where the event took place (or will take place). | |
forwarder_controlling_branch_code | String | The forwarder's main branch responsible for the shipment | |
forwarder_reference | String | Shipment reference number assigned by the freight forwarder | |
gross_weight_kgs | Decimal | The gross weight in kilograms for the shipment | |
house_bill | String | House bill of lading number | |
imo_number | String | International Maritime Organization (IMO) number. | |
import_entry_number | String | Import entry number associated with the shipment | |
location | Address | The location associated with the event. | |
maritime_mobile_service_identity | String | A Maritime Mobile Service Identity (MMSI) is a nine-digit number that uniquely identifies ship stations, ship earth stations, coast stations, coast earth stations, and group calls. | |
master_bill | String | Master bill of lading number | |
parcel_reference | String | Reference number used for tracking the parcel associated with the shipment | |
pro_number | String | Pro number for a truck shipment | |
quantity | Integer | The number of packages in the shipment | |
received_by | ReceivedByParty | The party on file having signed for receipt of the shipment. | |
receiving_exception_code | String | An exception code for the products/lading | |
shipper_reference | String | Reference number provided by the shipper | |
source_account_id | String | A unique identifying code for the account that controls the shipment in a multi-tenant environment.This field is output only. | |
source_system_shipment_uid | String | A unique identifying code from the system of record for the related shipment. | YES |
stop_number | Decimal | The stop number for the shipment event | |
transmission_uid | String | A one-time unique identifying code for this transmission of the shipment in question. Used for tracing and logging purposes. | |
transport_mode | String | Mode of transportation (AIR, ROAD, SEA, RAIL) | |
vessel_name | String | The name of the vessel, typically for ocean shipments. | |
voyage_number | String | The voyage or flight number. |
| Name | Data Type | Description | Required |
|---|---|---|---|
description | String | A description of the port (like Long Beach) | |
unlocode | String | A valid UN/LOCODE (like USLGB) |
| Name | Data Type | Description | Required |
|---|---|---|---|
city | String | The city. | |
country | String | The 2-Digit ISO 3166 Alpha-2 Country Code. Like 'US' | |
country_name | String | The full name of the country like “United States” | |
state | String | The state, province, or administrative division code |
| Name | Data Type | Description | Required |
|---|---|---|---|
email | String | The primary email address associated with the person | |
name | String | The person's name | |
phone | String | The primary phone number associated with the person |
| Name | Data Type | Description | Required |
|---|---|---|---|
content | Base64 | A Base64 encoded string of the file content | |
created_at | Date | The timestamp this document was attached. | |
created_by | User | The user account / party responsible for adding the attachment. | |
file_name | String | The name of the file | |
file_type_code | String | A short code representing the logical type of file. (You might use 'INV' for an invoice.) | |
file_type_description | String | A descriptive file type like 'Invoice to customer X' | |
media_type | String | The Media Type of the file (also known as MIME Type or Content-Type) | |
memo | String | Information regarding the contents of the file. | |
private | Boolean | If true, attachment is considered a private attachment. | |
source_system_uid | String | A unique identifying code from the system of record for this attachment. |