Overview
This article covers the file format used by Pledge to import data pertaining to shipment-level freight, where there is data about the mode of transport and weight or containers being shipped.
General CSV/Excel file specification
Before diving into the freight specific fields, you are encouraged to first to familiarise yourself with Pledge's general CSV/Excel file specification for importing data.
Understanding how to map freight data
Pledge supports the import of data that describes end-to-end multi-modal movements of freight including pre-carriage, main carriage or port-to-port and on-carriage movements.
Each movement or leg in the shipment of cargo is represented as one line in the file where that one line describes things such as the origin, destination, type of vehicle used and other related information for that movement. Therefore, if a shipment has multiple legs, multiple lines in the file should be provided.
SHIPMENT_ID and SEQUENCE_NO
For each shipment of cargo, the shipment must have a unique identifier (provided by you) in the SHIPMENT_ID field. If there are multiple legs as part of the same shipment then the same unique identifier must be used for all of those legs in addition to specifying a SEQUENCE_NO that defines in what order the legs occurred e.g. pre-carriage movements will have lower sequence numbers than the main carriage movements and on-carriage movements.
Template and sample files
Fields
Column | Data Type | Mandatory |
|
|
|
|
|
|
|
|
SHIPMENT_ID | TEXT
Notes: A unique identifier for the shipment. If there are multiple legs in a shipment then the same identifier should be used for all of those legs. | Yes
|
|
|
|
|
|
|
|
|
SEQUENCE_NO | INTEGER e.g. 1
Notes: The sequence number specifies the sequence of legs in a shipment which may cover: pre-carriage, main carriage and on-carriage or multiple flights within the carriage, if applicable. 1-based indexing. 0 is not an allowed value. | No
If not specified then it will default to 1. |
|
|
|
|
|
|
|
|
CARRIAGE | TEXT eg. MAIN
One of:
Where PRE is sometimes referred to as "first mile" and ON is sometimes referred to as "last mile" | No
If not specified, will default to MAIN |
|
|
|
|
|
|
|
|
DATE | RFC 3339-like format e.g. 2021-09-15 12:31
Ideally, the pick-up date, date of departure or otherwise start date of the shipment. | Yes
Notes: Only the date provided for SEQUENCE_NO=1 in a shipment will be considered, others will be ignored at this time. However, dates for each sequence may be taken into consideration in future (as date of departure) so please provide, if available. |
|
|
|
|
|
|
|
|
FROM_ADDRESS | TEXT e.g. 66 Faubourg Saint Honoré, Paris | Yes (one of FROM_ADDRESS, FROM_COORDINATES, FROM_CODE or DISTANCE)
Notes: Optional for Logistics Sites |
|
|
|
|
|
|
|
|
FROM_COUNTRY_CODE | TEXT e.g. GB
Notes: ISO 3166-1 alpha-2 country code. | No
Notes: Can be optionally provided in addition to FROM_ADDRESS, to improve geocoding, or in addition to DISTANCE to improve the accuracy of emissions calculation based on geography. |
|
|
|
|
|
|
|
|
FROM_COORDINATES | DECIMAL,DECIMAL e.g. 48.8700388,2.3185802
Notes: Convention dictates format is: latitude, longitude | Yes (one of FROM_ADDRESS, FROM_COORDINATES, FROM_CODE or DISTANCE)
Notes: Optional for Logistics Sites |
|
|
|
|
|
|
|
|
FROM_CODE | TEXT e.g. GBBYS
Notes: 3 letter IATA code for flights or 5 letter UN/LOCODE for sea ports or rail stations. White-spaces will be stripped | Yes (one of FROM_ADDRESS, FROM_COORDINATES, FROM_CODE or DISTANCE)
Notes: Optional for Logistics Sites |
|
|
|
|
|
|
|
|
TO_ADDRESS | TEXT e.g. 4 rue Sophie Germain, Paris, France | Yes (one of TO_ADDRESS, TO_COORDINATES, TO_CODE or DISTANCE
Notes: Optional for Logistics Sites |
|
|
|
|
|
|
|
|
TO_COUNTRY_CODE | TEXT e.g. GB
Notes: ISO 3166-1 alpha-2 country code. | No
Notes: Can be optionally provided in addition to TO_ADDRESS, to improve geocoding, or in addition to DISTANCE to improve the accuracy of emissions calculation based on geography. |
|
|
|
|
|
|
|
|
TO_COORDINATES | DECIMAL,DECIMAL e.g. 48.8307843, 2.3312721
Notes: Convention dictates format is: latitude, longitude | Yes (one of TO_ADDRESS, TO_COORDINATES, TO_CODE or DISTANCE)
Notes: Optional for Logistics Sites (VEHICLE=LS**) |
|
|
|
|
|
|
|
|
TO_CODE | TEXT e.g. CN AHK
Notes: 3 letter IATA code for flights or 5 letter UN/LOCODE for sea ports or rail stations. Whitespaces will be stripped | Yes (one of TO_ADDRESS, TO_COORDINATES, TO_CODE or DISTANCE)
Notes: Optional for Logistics Sites (VEHICLE=LS**) |
|
|
|
|
|
|
|
|
STOPS | TEXT e.g. THLCH;VNHPH;CNYTN
Notes: semi-colon separated 3 letter IATA code for flight stopovers or 5 letter UN/LOCODE for port-calls. | No
Notes: Only applies to sea (VEHICLE=S**) and air freight (VEHICLE=A). |
|
|
|
|
|
|
|
|
VIA | TEXT e.g. GBSOU;50.85486,0.58273;GBEBO
Notes: semi-colon separated 5-letter UN/LOCODEs and geo-coordinates (formatted as latitude,longitude). | No
Notes:
|
|
|
|
|
|
|
|
|
DISTANCE | DECIMAL e.g. 12.54 | Yes (either this or FROM_X and TO_X)
Notes: If DISTANCE is provided in addition to FROM_X and TO_X then DISTANCE will be used for emissions computations
Will be ignored for Logistics Sites (VEHICLE=LS**) |
|
|
|
|
|
|
|
|
DISTANCE_UNIT | TEXT eg. KM
One of :
| No
Notes: If not specified will default to KM
Will be ignored for Logistics Sites (VEHICLE=LS**) |
|
|
|
|
|
|
|
|
WEIGHT | DECIMAL e.g. 12.54 | Yes |
|
|
|
|
|
|
|
|
WEIGHT_UNIT | TEXT e.g. KG
One of:
Or
| No
Notes: If not specified will default to KG |
|
|
|
|
|
|
|
|
CONTAINER_20G_QTY | INTEGER eg. 1 | No
Notes: The quantity of 20 foot equivalent dry containers. |
|
|
|
|
|
|
|
|
CONTAINER_20R_QTY | INTEGER eg. 1 | No
Notes: The quantity of 20 foot equivalent reefer containers. |
|
|
|
|
|
|
|
|
CONTAINER_40G_QTY | INTEGER eg. 1 | No
Notes: The quantity of 40 foot equivalent dry containers. |
|
|
|
|
|
|
|
|
CONTAINER_40R_QTY | INTEGER eg. 1 | No
Notes: The quantity of 40 foot equivalent reefer containers. |
|
|
|
|
|
|
|
|
CONTAINER_40HC_QTY | INTEGER eg. 1 | No
Notes: The quantity of 40 foot high cube equivalent dry containers. |
|
|
|
|
|
|
|
|
CONTAINER_45HC_QTY | INTEGER eg. 1 | No
Notes: The quantity of 45 foot high cube equivalent dry containers. |
|
|
|
|
|
|
|
|
CONTAINER_OTHER_QTY | INTEGER eg. 1 | No
Notes: The quantity of containers with an ISO type code provided in the CONTAINER_OTHER_CODE column.
If specified then CONTAINER_OTHER_CODE must also be specified. |
|
|
|
|
|
|
|
|
CONTAINER_OTHER_CODE | TEXT eg. 42H1
Notes: Must be a valid ISO 6346 container type code. See type codes for more information. | No
Notes: Used to specify a container with an alternative ISO type code that is not represented in the other container columns.
Both ISO type group code and ISO size type codes are supported.
If specified then CONTAINER_OTHER_QTY must also be specified. |
|
|
|
|
|
|
|
|
CARGO_TYPE | TEXT e.g. LIGHT
One of:
| No
Notes: If not specified will default to AVERAGE |
|
|
|
|
|
|
|
|
VEHICLE | TEXT eg. HR1
For Aircraft, one of:
For Trains:
For Bulk Carrier Ships, one of:
For General Cargo Ships, one of:
For Container Ships:
For RoRo Ships:
For RoPax Ships:
For Vehicle Ships:
For Refrigerated Bulk Ships:
For Logistics Hubs:
For Motor Vessel Barges:
For Coupled Convoys Barges:
For Tanker Vessel Barges:
For Container Vessel Barges:
For Pushed Convoy Barges:
For Vans:
For Trucks, outside of North America:
For Trucks, in North America:
Notes:
| Yes
Notes:
|
|
|
|
|
|
|
|
|
IS_REFRIGERATED | BOOLEAN eg. TRUE | No
Notes: If not specified will default to FALSE
Only applicable for Vans, Trucks, Container Ships, Transhipment and Storage Logistics Sites. Will be ignored otherwise |
|
|
|
|
|
|
|
|
FUEL_TYPE | TEXT eg. DIESEL
For trains, one of:
For vans, one of:
For trucks (outside of North America), one of:
For non-container ships, one of:
| No
The following default values are used: - For aircrafts (VEHICLE=A), AVIATION_FUEL. - For barges (VEHICLE=B**), DIESEL.
For trains (VEHICLE=T) there is no default value. If you don’t provide a value, we will attempt to determine it based on the computed route.
For vans (VEHICLE=V) and trucks outside of North America (VEHICLE=H**), DIESEL is the default value.
For non-container ships (VEHICLE=S**, except SCS), HFO is the default value. |
|
|
|
|
|
|
|
|
FUEL_CONSUMPTION | DECIMAL e.g. 10 | No
Only applicable for Trucks and Vans outside of North America.
If specified then FUEL_TYPE must also be specified.
We assume that the fuel consumption is representative of both loaded and empty journeys. |
|
|
|
|
|
|
|
|
FUEL_CONSUMPTION_UNIT | TEXT e.g. L_PER_100_KM
For DIESEL, PETROL and LPG:
For ELECTRICITY:
For LNG and CNG:
| No
|
|
|
|
|
|
|
|
|
CARRIER_CODE | TEXT e.g. 4Y
Notes:
| No |
|
|
|
|
|
|
|
|
LOAD_FACTOR | DECIMAL e.g. 0.7 | No
Notes: Decimal between 0 and 1.
Only applicable for Trucks and Vans.
If not provided will default to a value based on the relevant methodology being applied |
|
|
|
|
|
|
|
|
EMPTY_RUNNING | DECIMAL e.g. 0.3 | No
Notes: Decimal between 0 and 1.
Only applicable for Trucks and Vans.
If not provided will default to a value based on the relevant methodology being applied. |
|
|
|
|
|
|
|
|
EMISSION_STANDARD | TEXT e.g. EURO_6
One of:
| No
Notes: Only applicable for Trucks and Vans.
If not provided will default to a value based on the relevant methodology being applied. |
|
|
|
|
|
|
|
|
VESSEL_ID | TEXT e.g. 9321483
Notes: 7 digit IMO ship identifier of the cargo ship | No
Notes: Will be ignored unless mode is sea (VEHICLE=S**). If provided will override VEHICLE if value is incorrect.
If VESSEL_ID can't be mapped to vessel, will use vehicle code as default.
If size can't be mapped, will use general ship type for IMO provided. |
|
|
|
|
|
|
|
|
VESSEL_NAME | TEXT e.g. EVER GIVEN | No
Notes: Will be ignored unless mode is sea (VEHICLE=S**).
If VESSEL_NAME can't be mapped to a specific vessel then whatever has been provided for VEHICLE will be used as default.
In case several matches are found for the VESSEL_NAME, VESSEL_NAME will then be ignored and whatever is provided for VEHICLE will be used as default. |
|
|
|
|
|
|
|
|
VOYAGE_NO | TEXT e.g. 987AB1 | No
Notes: Will be ignored unless mode is sea (VEHICLE=S**).
If VOYAGE_NO can’t be mapped to a voyage, will use defaults for inferred values. |
|
|
|
|
|
|
|
|
AIRCRAFT_CODE | TEXT e.g. B37M
Notes: IATA aircraft code | No
Notes: Will be ignored unless air freight (VEHICLE=A) |
|
|
|
|
|
|
|
|
FLIGHT_NO | TEXT e.g. BA113 | No
Notes: Will be ignored unless air freight (VEHICLE=A)
If provided will override AIRLINE_CODE and AIRCRAFT_CODE if those are provided. |
|
|
|
|
|
|
|
|