The Receive Shipment Updates document is responsible for relaying shipment milestone data originating from your visibility provider's platform to your TMS.
| Name | Description |
|---|---|
| Root | Chain.io schema for Visibility - Send Shipment Registration |
| Container | A container that has milestone data to relay. |
| Milestone | |
| LocationCode | The location the event occurred at. |
| Location | A unique location. |
| UnLocode | A location representing a UN location code. |
| AirPort | A location representing an airport. |
| Address | A location representing a street address. |
| Coordinate | A location representing a latitude and longitude. |
| Coordinates |
| Name | Data Type | Description | Required |
|---|---|---|---|
tms_system_identifier | String | The 'primary key' uniquely identifying the shipment, consolidation, or container in the source TMS system. This value is registered with the visibility provider and should be included in all event updates. | YES |
milestones | Array<Milestone> | All milestones that are applicable to the entire entity identified by the tms_system_identifier. | |
containers | Array<Container> | If supported by the visibility provider, a listing of all containers that are associated with the shipment milestones. | |
visibility_platform_url | String | A URL that can be used to access this shipment's visibility data on the provider's platform. |
| Name | Data Type | Description | Required |
|---|---|---|---|
container_number | String | The container number | |
milestones | Array<Milestone> | All milestones that are applicable to this specific container. |
| Name | Data Type | Description | Required |
|---|---|---|---|
event_code | String | A code identifying the type of milestone/event that is being reported. | YES |
event_description | String | A brief text description of the event_code. | |
timestamp | DateTime | The timestamp the milestone/event occurred on. | |
estimated_timestamp | DateTime | The timestamp the milestone/event occurred on. | |
location | Location | ||
location_code | LocationCode |
| Name | Data Type | Description | Required |
|---|---|---|---|
code | String | A code uniquely identifying the location. | YES |
description | String | A text description of the location code. | |
code_type | String | A code identifying the codeset used in the location_code. Allowed values: un_locode. | YES |
| Name | Data Type | Description | Required |
|---|---|---|---|
type | String | A location type identifier Allowed values: unlocode. | YES |
unlocode | String | The UN/Locode identifier for the sea port. | YES |
unlocode_description | String | A free text description of the UN/Locode. |
| Name | Data Type | Description | Required |
|---|---|---|---|
type | String | A location type identifier Allowed values: airport. | YES |
iata_code | String | The IATA airport location identifier. | YES |
iata_code_description | String | A free text description of the IATA Code. |
| Name | Data Type | Description | Required |
|---|---|---|---|
type | String | A location type identifier. Allowed values: address. | YES |
name | String | A name for the address. Typically the name of the business located at the address. | |
address_1 | String | The address' street number and name. | YES |
address_2 | String | The address' secondary address information. | |
city | String | The address' city component. | YES |
country_subdivision | String | The country specific subdivision code. This could represent a county, province, state, etc. In order to maximize interoperability, you should utilize the ISO 3166-2 country subdivision identifiers when providing this data. | |
country | String | The address' 2 character ISO-3166-2 country Code. | YES |
postal_code | String | The unique postal code identifier for the address. | |
unlocode | String | A UN/Locode identifier correlated with the address. | |
coordinates | Coordinates |
| Name | Data Type | Description | Required |
|---|---|---|---|
type | String | A location type identifier. Allowed values: coordinates. | YES |
name | String | A name for the location. Typically the name of the business at that location. | |
latitude | String | The numeric coordinate specifying the north-south position of a point on the surface of the earth. | YES |
longitude | String | The numeric coordinate specifying the east-west position of a point on the surface of the earth. | YES |
city | String | The location's city component. | |
country_subdivision | String | The country specific subdivision code. This could represent a county, province, state, etc. In order to maximize interoperability, you should utilize the ISO 3166-2 country subdivision identifiers when providing this data. | |
country | String | The location's 2 character ISO-3166-2 country Code. | |
postal_code | String | The unique postal code identifier for the location. | |
unlocode | String | A UN/Locode identifier correlated with the location. |
| Name | Data Type | Description | Required |
|---|---|---|---|
latitude | String | The numeric coordinate specifying the north-south position of a point on the surface of the earth. | YES |
longitude | String | The numeric coordinate specifying the east-west position of a point on the surface of the earth. | YES |