Skip to content

Cargo Public

ASSET Type DataModel Json
AssetId string json:"AssetId" validate:"string" id:"true"
SourceAssetId string json:"SourceAssetId" validate:"string" id:"true"
SourceChannelName string json:"SourceChannelName" validate:"string" id:"true"
CargoId string json:"CargoId,omitempty" validate:"string"
CapacityAssetId string json:"CapacityAssetId,omitempty" validate:"string"
UniversalId string json:"UniversalId,omitempty" validate:"string"
ShipmentId string json:"ShipmentId,omitempty" validate:"string"
StructVersion string json:"StructVersion,omitempty" validate:"string,regexp=^(\d{1}|\d{2})\.(\d{1}|\d{2})(\.(\d{1}|\d{2}|\d{3}))?$" default:"1.0.9"
CreationDateTime string json:"CreationDateTime,omitempty" validate:"string,regexp=^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(([+-]\d\d:\d\d)|Z)$"
CreationTimeZone string json:"CreationTimeZone,omitempty" validate:"string"
CreatorInfo CreatorInfo json:"CreatorInfo,omitempty"
RecipientInfo RecipientInfo json:"RecipientInfo" mandatory:"true"
PaymentTxId string json:"PaymentTxId" validate:"string"
SystemOfRecordCargoId string json:"SystemOfRecordCargoId,omitempty" validate:"string"
PlannedTotalWeight string json:"PlannedTotalWeight,omitempty" validate:"string,min=1,max=20,regexp=^\d+(\.(\d{1}|\d{2}|\d{3}|\d{4}|\d{5}|\d{6}))?$"
PlannedWeightUoM string json:"PlannedWeightUoM,omitempty" validate:"string,regexp=^(FOT|FTQ|FTK|INH|INK|INQ|MTR|MTK|MTQ|KGM|LBS|KMT|SMI|CEL|FAH)$"
ActualTotalWeight string json:"ActualTotalWeight,omitempty" validate:"string,min=1,max=20,regexp=^\d+(\.(\d{1}|\d{2}|\d{3}|\d{4}|\d{5}|\d{6}))?$"
ActualWeightUoM string json:"ActualWeightUoM,omitempty" validate:"string,regexp=^(FOT|FTQ|FTK|INH|INK|INQ|MTR|MTK|MTQ|KGM|LBS|KMT|SMI|CEL|FAH)$"
PlannedTotalVolume string json:"PlannedTotalVolume,omitempty" validate:"string,min=1,max=20,regexp=^\d+(\.(\d{1}|\d{2}|\d{3}|\d{4}|\d{5}|\d{6}))?$"
PlannedVolumeUoM string json:"PlannedVolumeUoM,omitempty" validate:"string,regexp=^(FOT|FTQ|FTK|INH|INK|INQ|MTR|MTK|MTQ|KGM|LBS|KMT|SMI|CEL|FAH)$"
ActualTotalVolume string json:"ActualTotalVolume,omitempty" validate:"string,min=1,max=20,regexp=^\d+(\.(\d{1}|\d{2}|\d{3}|\d{4}|\d{5}|\d{6}))?$"
ActualVolumeUoM string json:"ActualVolumeUoM,omitempty" validate:"string,regexp=^(FOT|FTQ|FTK|INH|INK|INQ|MTR|MTK|MTQ|KGM|LBS|KMT|SMI|CEL|FAH)$"
PlannedLoadingMeter string json:"PlannedLoadingMeter,omitempty" validate:"string,min=1,max=20,regexp=^(\d+)?(\.(\d{1}|\d{2}|\d{3}|\d{4}|\d{5}|\d{6}))?$"
ActualLoadingMeter string json:"ActualLoadingMeter,omitempty" validate:"string,min=1,max=20,regexp=^(\d+)?(\.(\d{1}|\d{2}|\d{3}|\d{4}|\d{5}|\d{6}))?$"
PlannedNumberOfTUs int json:"PlannedNumberOfTUs,omitempty" validate:"int"
ActualNumberOfTUs *int json:"ActualNumberOfTUs,omitempty" validate:"int"
CO2Emission string json:"CO2Emission,omitempty" validate:"string,min=1,max=20,regexp=^\d+(\.(\d{1}|\d{2}|\d{3}|\d{4}|\d{5}|\d{6}))?$"
ShipmentType string json:"ShipmentType,omitempty" validate:"string"
LegType string json:"LegType,omitempty" validate:"string"
BookingState string json:"BookingState" validate:"string,regexp=^(CREATED|ASSIGNED|ACCEPTED|PARTIALLY ACCEPTED|ACCEPTED BID|AWARDED|DECLINED|CANCELED|ANNULLED|VALIDATED|REJECTED)$" mandatory:"true"
EquipmentNumber string json:"EquipmentNumber,omitempty" validate:"string"
BookingSubState string json:"BookingSubState,omitempty" validate:"string"
VesselName string json:"VesselName,omitempty" validate:"string"
TransportExecutionState string json:"TransportExecutionState" validate:"string,regexp=^(NOT STARTED|STARTED|COMPLETED)$" mandatory:"true"
EventDateTime string json:"EventDateTime,omitempty" validate:"string,regexp=^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(([+-]\d\d:\d\d)|Z)$"
EventTimeZone string json:"EventTimeZone,omitempty" validate:"string"
ContactInfo [ContactInfo] json:"ContactInfo,omitempty"
Attachment [Attachment] json:"Attachment,omitempty"
ExternalReferences [ExternalReferences] json:"ExternalReferences,omitempty"
TransportOrder [TransportOrder] json:"TransportOrder,omitempty"
OrganizationSelection [OrganizationSelection] json:"OrganizationSelection,omitempty"
AwardCriteria []string json:"AwardCriteria,omitempty" validate:"array=string"
BuyNowPrice string json:"BuyNowPrice,omitempty" validate:"string,min=1,max=20,regexp=^\d+(\.(\d{1}|\d{2}|\d{3}|\d{4}|\d{5}|\d{6}))?$"
BidCurrency string json:"BidCurrency,omitempty" validate:"string,regexp=^[A-Z]{3}$"
MinimumNumberOfBids int json:"MinimumNumberOfBids,omitempty" validate:"int"
MaxAcceptablePrice string json:"MaxAcceptablePrice,omitempty" validate:"string,min=1,max=20,regexp=^\d+(\.(\d{1}|\d{2}|\d{3}|\d{4}|\d{5}|\d{6}))?$"
AwardedCarrierId string json:"AwardedCarrierId,omitempty" validate:"string"
CopyShipmentFromLBToCC string json:"CopyShipmentFromLBToCC,omitempty" validate:"string,regexp=^(YES|NO)$"
PlannedVehicleDetails VehicleDetails json:"PlannedVehicleDetails,omitempty"
PlannedCost Price json:"PlannedCost,omitempty"
PlannedEquipmentCapacity string json:"PlannedEquipmentCapacity,omitempty"
Incoterms string json:"Incoterms,omitempty"
PlaceOfIncoterms string json:"PlaceOfIncoterms,omitempty"
GoodsValue string json:"GoodsValue,omitempty"
GoodsValueCurrencyCode string json:"GoodsValueCurrencyCode,omitempty" validate:"string,regexp=^[A-Z]{3}$"
AdditionalAttributes [AdditionalAttributes] json:"AdditionalAttributes,omitempty"