Asset Descriptions
Cargo attributes Connect
Shipment Details
| Cargo attributes | Required | Comment | Description |
|---|---|---|---|
| AssetId | N | Generated by Platform | |
| CargoId | N | Generated by Platform | |
| CapacityAssetId | N | Generated by Platform. Reference to the Capacity Asset linked to the Cargo | |
| UniversalId | N | For Future Use | |
| ShipmentId | N | Generated by Platform | |
| StructVersion | Y | Minor Version Changes 1.0.X doesn’t need to be updated | Platform Data Model version to be used for creating the Asset. Current version is 1.0.2 |
| SystemOfRecordCargoId | Y | Shipment reference Id. | Shipper's Shipment Reference |
| PlannedTotalWeight | Y | Planned Weight of the shipment | |
| PlannedWeightUoM | Y | UoM For PlannedWeight | |
| ActualTotalWeight | N | Set by Transport Status Report on Pickup | Actual Weight for Transport |
| ActualWeightUoM | N | UoM for Actual Weight. Required when Actual weight is specified | |
| PlannedTotalVolume | Y | Planned Total Volume of the Shipment | |
| PlannedVolumeUoM | Y | UoM for planned volume | |
| ActualTotalVolume | N | Set by Transport Status Report on Pickup | Actual Volume for Transport |
| ActualVolumeUoM | N | UoM for actual volume | |
| PlannedLoadingMeter | N | Planned Loading Meter space utilized by the shipment. To be used when booking is based on Loading Meters | |
| ActualLoadingMeter | N | Set by Transport Status Report on Pickup | |
| PlannedNumberOfTUs | Y | Total Number for Transport Units planned in the Shipment | |
| ActualNumberOfTUs | N | Set by Transport Status | Actual Number of Transport Units in the Shipment |
| CO2Emission | N | CO2 Emission associated with the transport | |
| ShipmentType | Y | Shipment Type: Planned - Normal Shipment which has Transport Orders associated with it PreBooking - Special Shipment without association to Transport Orders. Used to book capacity in advance with carriers when the details of orders to be loaded are not known at the time of capacity reservation. Express - For shipments coming from LoadBoard after bidding process. Similar to Planned shipments these have TransportOrder associated with it |
|
| LegType | Y | Shipment Leg Type. PCT(Pre Carriage Transport) DDT(Direct Door Transport) MCT(Main Carriage Transport) OCT(Onward Carriage Transport) MLK1(Milkrun on Pre Carriage Transport) MLK2(Milkrun on Onward Carriage Transport) |
|
| BookingState | Y | Shipment Status ASSIGNED - Shipper has sent the shipment to Carrier but but not accepted by Carrier. If Cargo.AutoAccept = YES then this is equivalent to ACCEPTED state ACCEPTED - Shipment has been accepted by Carrier CANCELED - Shipment has been canceled by Shipper DECLINED - Shipment Declined by the Carrier |
|
| EquipmentNumber | N | Trailer/Licence plate number | |
| VesselName | N | For Future Use | |
| TransportExecutionState | N | Set by Transport Status Message | |
| EventDateTime | N | Set by Transport Status Message | |
| EventTimeZone | N | Set by Transport Status Message | |
| Attachment | N | For Future Use | Array of Contacts in ContactInfo data object format linked to the Cargo |
| External references | N | For Future Use | Array of Attachments in Attachment data object format linked to the Cargo |
| Contact info | N | For Future Use | Array of Attachments in Attachment data object format linked to the Cargo |
| TransportOrder | Y | Mandatory for Planned Shipments and Express Shipments. Optional for PreBooking Shipment during Creation | Array of Transport Orders Linked to Cargo |
| Incoterms | Y | a set of 11 internationally recognized rules which define the responsibilities of sellers and buyers - EXW (Ex-Works) FCA (Free Carrier) CPT (Carriage Paid To) DAP (Delivered At Place) DPU (Delivered At Place and Unloaded) CIP (Carriage and Insurance Paid To) DDP ( Delivered Duty Paid) FAS (Free Alongside Ship) FOB (Free On Board) CFR (Cost and Freight) CIF (Cost Insurance and Freight) |
|
| PlaceOfIncoterms | N | Location from where the Incoterms are applicable | |
| GoodsValue | N | Approximate value of goods to be entered in USD or EUR | |
| GoodsValueCurrencyCode | N | currency code -EUR or USD | |
| AdditionalAttributes | N | Request Cargo Insurance ,Shipment requires a license or a permit , Shipment is under a letter of credit , Shipment contains wooden packaging | |
| VesselNumber | N | Ships Registration Number used incase of Sea transport bookings |
Cargo attributes Loadbord
Shipment Details (all connect attributes from above with additional below attributes)
| Cargo attributes | Required | Comment | Description |
|---|---|---|---|
| AwardedCarrierId | N | For LoadBoard | TMA Id of the carrier who has been assigned the shipment once the Bidding process is complete. During Bidding process this is blank and once the Award is populated it is updated with the TMA ID of winning carrier. Only winning shipper or carrier can see this field |
| Cargo.OrganizationSelection[].OrganizationName | N | Used for LoadBoard | Organizations to whom shipment offer to be sent for Bidding. Carrier's see only element corresponding to their organization |
| Cargo.OrganizationSelection[].OrganizationReferenceNumber | N | Used for LoadBoard | Carrier Organization Id as defined in shipper's system. Carrier's see only element corresponding to their organization |
| Cargo.OrganizationSelection[].OrganizationTMAID | N | Used for LoadBoard | TMAId of Organization to whom shipment offer to be sent for Bidding. Carrier's see only element corresponding to their organization |
| BuyNowPrice | N | For Loadboard. For future release | Price at which bidding will be closed immediately and bidding carrier will be assigned the shipment |
| BidCurrency | N | For Loadboard. For future release | Currency in which carrier should submit their bid |
Capacity attributes Connect
linked to Shipment
| Capacity attributes | Required | Comment | Description |
|---|---|---|---|
| AssetId | N | Generated by Platform | |
| CapacityId | N | Generated by Platform | |
| StructVersion | Y | Minor Version Chnages 1.0.X doesn’t need to be updated | Platform Data Model version to be used for creating the Asset. Current verison is 1.0.2 |
| ShipmentId | N | Generated by Platform | |
| SystemOfRecordCapacityId | Y | Atlas Tender Transaction Id | Shipper's Business Identifier for Capacity asset. Atlas Tender Transaction Id is populated in this field. If this field is not to be refered in the sender system then any value can be used here |
| CarrierReferenceNumber | Y | Business/Operational identifier of a carrier, e.g. the identifier of a carrier in a shipper's internal system(s). | |
| CustomerReferenceNumber | N | Business/Operational identifier of a customer, e.g. the identifier of a shipper in a carrier's internal system(s). | |
| CarrierContractNumber | N | 700XXXXYYYY | |
| State | Y | Capacity Status : ASSIGNED - Shipper has sent the shipment to Carrier but but not accepted by Carrier. If Cargo.AutoAccept = YES then this is equivalent to ACCEPTED state ACCEPTED - Shipment has been accepted by Carrier CANCELED - Shipment has been cancelled by Shipper DECLINED - Shipment has been declined by Carrier |
|
| RequiredConfirmDateTime | Y | The latest date and time at which the carrier is required to give an answer to the shipment booking. Time Format YYYY-MM-DDTHH24:MI:SS+00:00 e.g. "2022-02-11T13:30:00+00:00" | |
| ConfirmDateTimeZone | Y | TimeZone Name. In TZ Database name format e.g. Europe/Stockholm | |
| PartialAcceptanceAllowed | N | For Future Use | |
| AutoAccept | N | For Future Use | |
| TransportMode | N | Blank means no mode was specified by shipper. For express transports it is left as blank when shipper doesn't ask for specific mode | Mode of Transport. FTL - Full Truck Load PTL - Partial truck Load (Less-than a Truck Load) LCL - less container load used for (sea transportts) |
| EquipmentType | Y (if FTL) | Type of Equipment to be used for the Shipment. Mandatory for FTL shipments where equipment is mentioned in the contract or as per agreed between shipper and Carrier. For e.g "SWEDEN SPECIAL", "24MT MEGA TRAILER","24MT STANDARD TRAILER" etc. "AS REQUIRED" when there is no equipment agreed | |
| AvailableLength | N | For Future Use | |
| AvailableWidth | N | For Future Use | |
| AvailableHeight | N | For Future Use | |
| DimensionUoM | N | For Future Use | |
| AvailableWeight | N | For Future Use | |
| WeightUoM | N | For Future Use | |
| CargoTerms | N | Cargo Terms | |
| PickupZone | N | For Future Use | |
| DeliveryZone | N | For Future Use | |
| ServiceDistance | N | Agreed upon distance between the two points (first and last stop if multistop transport) that is contracted for a transport service. Needed for FTL transport where contract is in Per Unit distance traveled | |
| DistanceUoM | N | Unit of Measure for Service Distance. Needed for FTL Transport where contract is on Per Unit of Distance Traveled | |
| MaximumNumberOfStops | N | For Future Use | |
| ServiceTime | N | For Future Use | |
| EarliestPickupDateTime | (Y in TO asset) | Earliest the shipment should be picked up. Time Format YYYY-MM-DDTHH24:MI:SS+00:00 e.g. "2022-02-11T13:30:00+00:00" | |
| LatestPickupDateTime | (Y in TO asset) | Latest the shipment should be picked-up. Time Format YYYY-MM-DDTHH24:MI:SS+00:00 e.g. "2022-02-11T13:30:00+00:00" | |
| PickupDateTimeZone | (Y in TO asset) | TimeZone Name. In TZ Database name format e.g. Europe/Stockholm | |
| EarliestDeliveryDateTime | (Y in TO asset) | Earlier the shipment should be delievered. Time Format YYYY-MM-DDTHH24:MI:SS+00:00 e.g. "2022-02-11T13:30:00+00:00" | |
| LatestDeliveryDateTime | (Y in TO asset) | Latest the shipment should be delievered. Time Format YYYY-MM-DDTHH24:MI:SS+00:00 e.g. "2022-02-11T13:30:00+00:00" | |
| DeliveryDateTimeZone | (Y in TO asset) | TimeZone Name. In TZ Database name format e.g. Europe/Stockholm | |
| MinimumPricePerLoad | N | For Future Use | |
| MinimumPricePerDistanceUoM | N | For Future Use | |
| MinimumPricePerHour | N | For Future Use | |
| PriceCurrencyCode | N | For Future Use | |
| ShipFrom | Y (Pre-booking) | Needed when Cargo.ShipmentType = PreBooking | |
| ShipTo | Y (Pre-booking) | Needed when Cargo.ShipmentType = PreBooking | |
| Mode | Y | To be used to choose between Road and Sea transports | |
| ServiceLevel | N | To be used to choose between Regular and Express bookings |
Capacity attributes Loadbord
linked to Loadboard Shipment (all connect attributes from above with additional below attributes)
| Capacity attributes | Required | Comment | Description |
|---|---|---|---|
| BidValidTo | Y | For LoadBoad Shipment | Time upto which the carrier needs to be committed to the bid they are submitting for LoadBoard |
| ValidToTimeZone | Y | For LoadBoad Shipment | Time upto which the carrier needs to be committed to the bid they are submitting for LoadBoard |
Vehicle Details
linked to Conect Shipment , Loadboard.Buisnessmessage and TransportStaus Events
| Vehicle attributes | Required | Comment | Description |
|---|---|---|---|
| LicencePlateNumber | Y(visibility) | this is the CO3 enabled vehicle/equipment number which needs to be tracked. This number should be without any space or special characters | |
| LicencePlateCountryCode | Y(visibility) | this is 2 digit ISO Country code (For e.g. SE) | |
| Fueltype | For Future Use | ||
| Vehicletype | For Future Use | ||
| EmissionStandard | For Future Use |
ShipFrom
To Store Pickup Location. Linked to Transport Order
| ShipFrom attributes | Required | Comment | Description |
|---|---|---|---|
| YourLocationReference | Y | Parma Id for the Location | Shipper Reference Number for the Location. |
| Position.Latitude | N | Latitude of the Location | |
| Position.Longitude | N | Longitude of the location | |
| LocationName | Y | Location Name | |
| AddressLine1 | Y | Address of the Location | |
| AddressLine2 | N | Additional Address Information | |
| PostalCode | Y | Postal Code | |
| City | Y | City | |
| County_State_Region | N | State/Province | |
| CountryCode | Y | 3 digit ISO Country Code | |
| EarliestPickupDateTime | Y | Earliest time when the Order is ready for pick-up. Time Format YYYY-MM-DDTHH24:MI:SS+00:00 e.g. "2022-02-11T13:30:00+00:00". If window is not available then same time can be used for both early and Late | |
| LatestPickupDateTime | Y | Latest time by which Order should be picked up. Time Format YYYY-MM-DDTHH24:MI:SS+00:00 e.g. "2022-02-11T13:30:00+00:00". If window is not available then same time can be used for both early and Late | |
| TimeZone | Y | Time zone for EarliestPickupDatetime and LatestPickupDateTime field. In TZ Database name format e.g. Europe/Stockholm | |
| EstimatedTimeOfArrival | N | Estimated time for Arrival. Time Format YYYY-MM-DDTHH24:MI:SS+00:00 e.g. "2022-02-11T13:30:00+00:00" | |
| SequenceNumber | N | For Future Use | |
| StopNumber | Y | A stop represents a place where goods are either picked-up or dropped off, or both. The stop number indicates in which order these places are visited. A stop number can be shared by more than one Ship from and/or Ship to Location information set within a Shipment, as long as these Locations represent the same place. | |
| ShipFromContactInfo | N | Contact person details for Pick-up Location |
ShipTo
To store the Delivery Location. Linked to Transport Orders
| ShipTo attributes | Required | Comment | Description |
|---|---|---|---|
| YourLocationReference | Y | Parma Id for the Location | Shipper Reference Number for the Location. |
| Position.Latitude | N | Latitude of the Location | |
| Position.Longitude | N | Longitude of the location | |
| LocationName | Y | Location Name | |
| AddressLine1 | Y | Address of the Location | |
| AddressLine2 | N | Unload Point. Required for ShipTo Location representing final consignees | |
| PostalCode | Y | Postal Code | |
| City | Y | City | |
| County_State_Region | N | State/Province | |
| CountryCode | Y | 3 digit ISO Country Code | |
| EarliestPickupDateTime | Y | Earliest time when the Order is ready for pick-up. Time Format YYYY-MM-DDTHH24:MI:SS+00:00 e.g. "2022-02-11T13:30:00+00:00". If window is not available then same time can be used for both early and Late | |
| LatestPickupDateTime | Y | Latest time by which Order should be picked up. Time Format YYYY-MM-DDTHH24:MI:SS+00:00 e.g. "2022-02-11T13:30:00+00:00". If window is not available then same time can be used for both early and Late | |
| TimeZone | Y | Time zone for EarliestPickupDatetime and LatestPickupDateTime field. In TZ Database name format e.g. Europe/Stockholm | |
| EstimatedTimeOfArrival | N | Estimated time for Arrival. Time Format YYYY-MM-DDTHH24:MI:SS+00:00 e.g. "2022-02-11T13:30:00+00:00" | |
| SequenceNumber | N | For Future Use | |
| StopNumber | Y | A stop represents a place where goods are either picked-up or dropped off, or both. The stop number indicates in which order these places are visited. A stop number can be shared by more than one Ship from and/or Ship to Location information set within a Shipment, as long as these Locations represent the same place. | |
| ShipFromContactInfo | N | Contact person details of delivery Location |
Contact
To store the Contact information
| ContactInfo attributes | Required | Comment | Description |
|---|---|---|---|
| Actor | Y | Role of the Contact person. "SHIPPER" for ShipFrom Location contact. and "CONSIGNEE" for ShipTo Location contact | |
| N | Contact person's email address | ||
| Name | N | Contact Person's Name | |
| Phone | N | Contact Person's Phone |
Creator / Recipient
To store the LogivityID(TMAID) information
| ContactInfo attributes | Required | Comment | Description |
|---|---|---|---|
| CreatorInfo.ClientTMAID | N | Set by Platform based on Credentials | Shipper Information |
| CreatorInfo.ServiceProviderMSPID | N | Set by Platform based on Credentials | Shipper Information |
| RecipientInfo.ClientTMAID | Y(connect) | Carrier TMA id | |
| RecipientInfo.ServiceProviderMSPID | N | Set internally by Platform |
TO attributes
(Transport Order) - Linked to Cargo
| ContactInfo attributes | Required | Comment | Description |
|---|---|---|---|
| AssetId | N | Generated by Platform | |
| TOId | N | Generated by Platform | |
| StructVersion | Y | Minor Version Chnages 1.0.X doesn’t need to be updated | Platform Data Model version to be used for creating the Asset. Current verison is 1.0.1 |
| SystemOfRecordTOId | Y | Shipper Reference for the Order's Leg. | |
| UniversalId | N | For Future Use | |
| TotalWeight | Y | Total Weight of the Order | |
| WeightUoM | Y | Unit of Measure for Weight | |
| TotalVolume | Y | Total Volume of the Order | |
| VolumeUoM | Y | Unit of Measure for Volume | |
| LoadingMeter | N | For Future Use | |
| NumberOfTransportUnits | Y | Total Number of Transport Handling Units in the Order | |
| PricePerLoad | Y | For Future Use | |
| TransportExecutionState | Y | For Future Use | |
| EvenDatetime | Y | For Future Use | |
| EventTimezone | Y | For Future Use | |
| PreviousTOId | N | Asset | |
| SubsequentTOId | N | Asset | |
| ParentTOId | Y | Shipper's reference for Order Id | |
| TransportReferences | N | Additional Information linked to Orders is sent in this as a free text | Array of TransportReference asset. Used to pass additional reference to Shipment |
| ExternalReferences | N | Array of ExternalReference asset. Used to pass additional reference to Shipment | |
| TransportUnit | Y | Array of TransportUnit Asset linked to TransportOrder |
TransportReferences
From Current Order release.
| attributes | Required | ReferenceType | ReferenceValue |
|---|---|---|---|
| TransportReferences | N | "MessageToCarrier" | Special Instuctions to Carriers as a free text |
| TransportReferences | N | "PickupReference" | Special Pickup Instuctions to Carriers as a free text |
ExternalReferences
TO - From current order release
| attributes | Required | AttributeDescription | AttributeValue |
|---|---|---|---|
| ExternalReferences | N | OS | Original Source Id |
| ExternalReferences | N | OS_NAME | Original Source Name |
| ExternalReferences | N | OS_PARMA | Original Source Parma |
| ExternalReferences | N | PO_REFERENCE | Purchase Order Reference |
| ExternalReferences | N | Final Unload Point | Final Unloading Point/Suffix/Gate for delivery |
TU TransportUnit
THUs Linked to TO
| TU attributes | Required | Comment | Description |
|---|---|---|---|
| AssetId | N | Generated by Platform | |
| TUId | N | Generated by Platform | |
| SystemOfRecordTUId | N | Shippers Reference number for the THU | |
| UniversalId | N | For Future Use | |
| StructVersion | Y | Minor Version Chnages 1.0.X doesn’t need to be updated | Platform Data Model Version. Current Version 1.0.1 |
| OuterPackagingNumber | Y | Shippers reference number for the Package | |
| TUType | N | Transport Handling Unit type (Pallet Type/THU Type). (EURO PALLET) etc | |
| Stackable | N | Indicates if THU is Stackable t not. Possible Values YES | |
| TemperatureControlled | Y | Indicates if special Temperature settings needed. Possible Values YES | |
| Temperature | Y | For Future Use | Temperature settings if special handling needed |
| TemperatureUoM | Y | Unit Of Measure for Temperature | |
| GoodsClass | N | For Future Use | |
| GoodsDescription | N | Fixed Value "AUTOMOTIVE PARTS" | Type of Goods |
| SystemOfRecordTUGroupId | N | Shippers Reference number for the Group havinng same type of Transport Handling Unit | |
| TUGroupLoadingMeter | Y | Loading Meters used by TU Group | |
| TUGroupWeight | Y | Total Weight of Transport Unit Group | |
| TUGroupWeightUoM | N | Unit of Measure for Weight | |
| TUGroupVolume | Y | Total Volume of Transport Unit Group | |
| TUGroupVolumeUoM | Y | Unit of Measure for Volume | |
| TUGrossWeight | Y | Transport Unit Gross Weight | |
| TUNetWeight | Y | Transport Unit Net Weight | |
| TUWeightUoM | Y | Unit of Measure for Transport Unit Gross/Net Weight | |
| TUGrossVolume | N | Transport Unit Gross Volume | |
| TUNetVolume | Y | Transport Unit Net Volume | |
| TUVolumeUoM | Y | Unit of Measure for Transport Unit Gross/Net Volume | |
| TUHeight | N | Transport Handling Unt Height | |
| TULength | Y | Transport Handling Unt Length | |
| TUWidth | Y | Transport Handling Unt Weight | |
| DimensionUoM | Y | Unit of Measure for Dimenssions | |
| HazmatUNCode | Y(if Hazmat) | Mandatory for Hazmat Transport Handling Units | Hazmat UN Code |
| HazmatClass | Y(if Hazmat) | Mandatory for Hazmat Transport Handling Units | Hazmat UN Class |
| HazmatPackingGroup | Y(if Hazmat) | Mandatory for Hazmat Transport Handling Units | Hazmat Packaging Group |
| HazmatProperShippingName | Y(if Hazmat) | Mandatory for Hazmat Transport Handling Units | Hazmat Shipping Name |
| TransportExecutionState | N | For Future Use | |
| EventDateTime | N | For Future Use | |
| EventTimeZone | N | For Future Use |
TS TransportStatus
For reporting Booking response and Transport execution status. To get Shipment Cancellation Message.
| TS attributes | Required | Comment | Description |
|---|---|---|---|
| AssetId | N | Generated by Platform | |
| TSId | N | Generated by Platform | |
| CargoAssetId | N | If the event is at Cargo Level then either CargoId or CargoAssetId is mandatory | CargoAssetId of the shipment for which event is applicable |
| CargoId | N | If the event is at Cargo Level then either CargoId or CargoAssetId is mandatory | Cargo Id of the Shipment |
| TUAssetId | N | For Future Release | Array of TransportUnit Asset Ids on which event is applicable |
| CapacityAssetId | N | For Future Release | CapacityAssetId of the shipment for which event is applicable |
| StructVersion | Y | Minor Version Chnages 1.0.X does not need to be updated | Platform Data Model Version. Current Version 1.0.3 |
| TransportStatusType | Y | Transport Status Type. Possible Values: STANDARD | |
| StatusCode | Y | Refer the TransportStatus Event Mapping Table | |
| ReasonCode | N | Refer the TransportStatus Event Mapping Table | |
| StandardMessageSupplementaryInformation | N | Free text with additional information associated with the Event. To be used for STANDARD events | |
| SystemOfRecordMessageId | N | Optional field that sender can use to indetify this event based on the identifier on their system | |
| MessageInformation | N | Required for Transport Status (Alert) Message | Free text with additional information associated with the Event. To be used for NON STANDARD events |
| CreationDateTime | Y | Default Value set by Platform based on System timestamp | Event Creation Date and Time. Time Format YYYY-MM-DDTHH24:MI:SS+00:00 e.g. "2022-02-11T13:30:00+00:00" |
| CreationTimeZone | Y | Default Vlaue set by Platform | TimeZone for Event Creation Date Time. IN Tz name format. For e.g. Europe/Stockholm |
| EquipmentNumber | N | "Optional for POP, POA ,Required for Equipment Update Event" | Equipment Number |
| ActualTotalWeight | N | Used in Quantity Deviation Event (Optional) | Actual Reported Weight. Reported in Quantity Deviation Event |
| WeightUoM | N | Used in Quantity Deviation Event (Optional) | Unit of Measure for Weight |
| ActualTotalVolume | N | Used in Quantity Deviation Event (Optional) | Actual Reported Volume. Reported in Quantity Deviation Event |
| VolumeUoM | N | Used in Quantity Deviation Event (Optional) | Unit of Measure for Volume |
| ActualLoadingMeter | N | Used in Quantity Deviation Event (Optional) | Actual Reported Loading Meters. Reported in Quantity Deviation Event |
| ActualNumberOfTUs | N | Used in Quantity Deviation Event (Optional) | Actual Reported Number of Transport Handling Unit. Reported in Quantity Deviation Event |
| PaymentTxId | N | Set by Platform | Payment Transaction Id |
| Time | N | Used for Reporting ETA Update or Event Date time for POP/POA/IOD etc (Refer Transport Status event mapping for details) | Time Information for the event |
| Price | N | For Future Use | |
| Location.StopNumber | N | For Reporting Event Location. Used for POP, POA, IOD, ETA Update and Missed Pickup event (Refer Transport Status Event mapping for details) | Stop Number of the Location in the Shipment. Refer the TransportStatus Event Mapping Table |
| Attachment | N | For Future Use | |
| ExternalReferences | N | For Future Use |
BM BusinessMessage
Used to communicate AWARD event to the carrier. LoadBoard Shipment Cancellation Message.
| BM attributes | Required | Comment | Description |
|---|---|---|---|
| AssetId | N | Generated by Platform | |
| AssetType | N | Generated by Platform | loadboard.BusinessMEssage |
| BMId | N | Generated by Platform | |
| BusinessMessage.AssetId | N | Used for AWARD event | Used for AWARD event. It refers to the Bid which has been AWARDED by the shipper. If MessageCode is AWARD and this filed is not returned then it means that the Shipment has been assigned to other carrier |
| Cargo.AssetId | Y | CargoAssetId for the shipment to which message belong | Cargo Id of the Shipment |
| StructVersion | Y | Minor Version Chnages 1.0.X doesn’t need to be updated | Platform Data Model Version. Current Version 1.0.1 |
| BusinessMessageType | Y | Type of Business Message | "TRANSPORT EVENT" |
| MessageCode | Y | Type of Event | "ROAD TRANSPORT BID" for Bid message, "AWARD" for award message and "BOOKING CANCELLED" for shipment cancellation message. Refer LoadBoard BM mapping table |
| MessageCode1 | N | Sub type of Message | "Standarized" for regular Bids |
| SystemOfRecordMessageId | N | Optional field that sender can use to indetify this event based on the identifier on their system | |
| CreationDateTime | N | Default Value set by Platform based on System timestamp | Event Creation Date and Time. Time Format YYYY-MM-DDTHH24:MI:SS+00:00 e.g. "2022-02-11T13:30:00+00:00" |
| CreationTimeZone | N | Default Vlaue set by Platform | TimeZone for Event Creation Date Time. In Tz name format. For e.g. Europe/Stockholm |
| RecipientInfo.ClientTMAId | N | Shipper TMA Id | Shipper TMA Id to be taken from Cargo.CreatorInfo.ClientTMAID |
| RecipientInfo.ClientTMAId | N | LoadBoard TMA Id | Loadboard TMA Id to be taken from Cargo.RecipientInfo.ClientTMAID |
| StandardMessage | Y | Type of Message | "YES" |
| Price.Amount | N | Used for Bid | Bidding Amount |
| Price.CurrencyCode | N | Used for Bid | Bidding Currency. Should be same as specified in Cargo.BidCurrency |
| Price.PriceType | N | Used for Bid | "Bid" |
| Price.TotalPerLoadPriceFlag | N | Used for Bid | "YES" |
Time
| Time attributes | Required | Comment | Description |
|---|---|---|---|
| DateTimeType | Y | Used to Report ETA time as Extimated or event occurance time | "Event Time Type. Possible Values Event |
| DateTime | Y | Event Date and Time Format YYYY-MM-DDTHH24:MI:SS+00:00 e.g. "2022-02-11T13:30:00+00:00" | |
| TimeZone | Y | TimeZone Name in Tz Name for mat. For example Europe/Stockholm |
IDs
There are a number of IDs in the data model. The main ones currently used are explained below.
| ID | Description |
|---|---|
| Asset ID | The Logivity generated, technical ID of an asset. It consists of asset name, channel name and a blockchain transaction ID of 64 characters. This is the primary ID to use in the Transport status to refer to the relevant main asset (e.g. Cargo Asset ID, representing a Shipment). If there are technical limitations to using this ID, the Cargo ID could be used instead |
| Cargo ID, Capacity ID, TO ID, TU ID, TS ID | The Logivity generated business ID of an asset. It is a numerical 21 character long ID.If there are technical limitations to using the Cargo Asset ID, he Cargo ID can be used in the Transport status to refer to the Cargo asset (representing the Shipment) |
| System of Record ID | The identifier of a business object originating from the System of Record (usually an off-chain TMS application) |
| System of Record Cargo ID | One of the types of System of Record IDs and the primary Shipment identifier from the System of Record (usually an off-chain TMS). Could e.g. be the invoicing reference |