CO2 - Calculate Freight Emissions

Send shipment information to emissions calculation provider.

Objects

Name	Description
Root	Chain.io schema for calculating a shipment's emissions.
Container	Describes one or more intermodal shipping containers.
ShipmentLeg	A single transportation segment in a shipment's larger journey from origin to destination.
Location	A unique location.
SeaPort	A location representing a sea port.
Airport	A location representing an airport.
Address	A location representing a street address.
Coordinates	A location representing a latitude and longitude.
SpecialFreightHandling	Allowed values: refrigerated.
Vessel	A type of conveyance.
Truck	A vessel used for road transports.
Train	A vessel used for rail transports.
Plane	A vessel used for air transports.
ContainerShip	A vessel used for sea transports.
InlandVessel	A vessel used for inland waterway transports.
Party	Represents a named party on a job.
PartyIdentifier	A code and context that can be used to uniquely identify a party.
Contact	A point of contact at a particular party.
PhoneNumber	A phone number and type object.
EmailAddress	An email address and type object.
Root_gross_weight	The gross weight of the cargo utilized in the emissions calculations.

Root top

Name	Data Type	Description	Required
`tms_system_identifier`	String	The 'primary key' uniquely identifying the shipment in the source TMS system. This value is what will be utilized to identify what unique shipment to associated the the emissions calculation data with.	YES
`gross_weight`	Root_gross_weight	The gross weight of the cargo utilized in the emissions calculations.	YES
`departure_date`	DateTime	The date of the shipment.
`arrival_date`	DateTime	The arrival date of the shipment.
`teus`	Integer	The total number of twenty-foot equivalent units on the shipment. This may sometimes be used as an alternative input for calculating emissions - though gross weight is the preferred method.
`specialized_freight_handling`	Array<SpecialFreightHandling>	Additional freight handling options that may affect the emissions calculation.
`shipment_legs`	Array<ShipmentLeg>	A collection of all the individual transportation segments that should be considered when calculating the emissions.
`containers`	Array<Container>	All the FCL containers that should be accounted for when calculating emissions.
`customer`	Party	The customer associated with the shipment as defined in the source TMS. This is typically the entity on whose behalf the shipment is being transported.

Container top

Name	Data Type	Description	Required
`quantity`	Integer	The number of containers of the same code.	YES
`container_code`	String	A code identifying the type of container. For the greatest compatibility across emissions platforms, this code SHOULD be a valid ISO 6346 code. This code can then be utilized by the platform to identify special container types like reefers which may affect the emissions calculations.	YES

ShipmentLeg top

Name	Data Type	Required
`origin`	Location	YES
`destination`	Location	YES
`vessel`	Vessel	YES

Location top

Name	Data Type	Description	Required

SeaPort top

Name	Data Type	Description	Required
`type`	String	A location type identifier Allowed values: seaport.	YES
`unlocode`	String	The UN/Locode identifier for the sea port.	YES
`unlocode_description`	String	A free text description of the UN/Locode.

Airport top

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.
`unlocode`	String	The UN/Locode identifier correlated with the IATA code.

Address top

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 top

Name	Data Type	Description	Required
`type`	String	A location type identifier. Allowed values: coordinates.	YES
`name`	String	A name for the location the coordinates identify.
`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

SpecialFreightHandling top

Name	Data Type	Description	Required

Vessel top

Name	Data Type	Description	Required

Truck top

Name	Data Type	Description	Required
`type`	String	Allowed values: truck.	YES
`actual_time_of_departure`	DateTime	The date this vessel departed.

Train top

Name	Data Type	Description	Required
`type`	String	Allowed values: train.	YES
`actual_time_of_departure`	DateTime	The date this vessel departed.

Plane top

Name	Data Type	Description	Required
`type`	String	Allowed values: plane.	YES
`flight_number`	String	The carrier's identifier for the flight.
`actual_time_of_departure`	DateTime	The date this vessel departed.

ContainerShip top

Name	Data Type	Description	Required
`type`	String	Allowed values: container_ship.	YES
`imo_number`	String	The vessel's International Maritime Organization unique seven digit number.
`vessel_name`	String	The carrier's name for the container ship.
`voyage_number`	String	The carrier's voyage identifier for the vessel.
`containerization_type`	String	The containerization shipping option utilized by the shipper. Allowed values: fcl, lcl.
`carrier`	Party	The carrier undertaking the transport for this shipment leg.
`actual_time_of_departure`	DateTime	The date this vessel departed.

InlandVessel top

Name	Data Type	Description	Required
`type`	String	Allowed values: inland_vessel.	YES
`imo_number`	String	The vessel's International Maritime Organization unique seven digit number.
`vessel_name`	String	The carrier's name for the inland vessel.
`actual_time_of_departure`	DateTime	The date this vessel departed.

Party top

Name	Data Type	Description
`identifiers`	Array<PartyIdentifier>	An array of all applicable identifiers that can be used to identify the party.
`name`	String	The entity's name.
`address_1`	String	The address' street number and name.
`address_2`	String	The address' secondary address information.
`city`	String	The address' 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 address' 2 character ISO-3166-2 country Code.
`postal_code`	String	The unique postal code identifier for the address.
`unlocode`	String	The UN/Locode most closely related to this party.
`unlocode_description`	String	A free text description of the UN/Locode.
`contact`	Contact	A point of contact at the party.

PartyIdentifier top

Name	Data Type	Description	Required
`code`	String	The identifier code	YES
`code_type`	String	The type of data that the identifier code represents. Allowed values: tms_external_identifier, iata, scac, legal_entity_id, duns.	YES
`code_country`	String	The 2 character ISO-3166-2 country code that the id code was issued in / by.

Contact top

Name	Data Type	Description
`name`	String	The contact's full name.
`phone_numbers`	Array<PhoneNumber>
`email_addresses`	Array<EmailAddress>

PhoneNumber top

Name	Data Type	Description	Required
`phone_type`	String	The type of phone number. Allowed values: main, mobile, work, home, fax, other.	YES
`phone_number`	String	The actual phone number. When at all possible, to increase interoperability, phone numbers should be formatted according to RFC3966. Also see libphonenumber when parsing phone numbers.	YES

EmailAddress top

Name	Data Type	Description	Required
`email_type`	String	The type of email address. Allowed values: main, work, personal, other.	YES
`email_address`	String	The email address	YES

Root_gross_weight top

Name	Data Type	Description	Required
`amount`	Decimal		YES
`unit`	String	Allowed values: kilogram, tonne, pound, ton.	YES

Introduction to Open Connect

API Information

Integration Types & Schemas

CO2 - Calculate Freight Emissions

Objects