Skip to content

DataModel Structure of the shipemnt

Position

ASSET Type DataModel Json
Latitude string json:"Latitude,omitempty" validate:"string,regexp=^[-+]?([1-8]?\d(\.\d+)?
Longitude string json:"Longitude,omitempty" validate:"string,regexp=^[-+]?(180(\.0+)?

CreatorInfo

ASSET Type DataModel Json
ClientTMAID string json:"ClientTMAID,omitempty" validate:"string"
ServiceProviderMSPID string json:"ServiceProviderMSPID,omitempty" validate:"string"

RecipientInfo

ASSET Type DataModel Json
ClientTMAID string json:"ClientTMAID" validate:"string" mandatory:"true"
ServiceProviderMSPID string json:"ServiceProviderMSPID,omitempty" validate:"string"

ContactInfo

ASSET Type DataModel Json
Actor string json:"Actor,omitempty" validate:"string"
Name string json:"Name,omitempty" validate:"string"
Email string json:"Email,omitempty" validate:"string"
Phone string json:"Phone,omitempty" validate:"string"

ExternalReferences

ASSET Type DataModel Json
AttributeDescription string json:"AttributeDescription,omitempty" validate:"string"
AttributeValue string json:"AttributeValue,omitempty" validate:"string"

Attachment

ASSET Type DataModel Json
Description string json:"Description,omitempty" validate:"string"
type string json:"type,omitempty" validate:"string"
Link string json:"Link,omitempty" validate:"string"
Hash string json:"Hash,omitempty" validate:"string"
State string json:"State,omitempty" validate:"string"

TransportReferences

ASSET Type DataModel Json
Referencetype string json:"Referencetype,omitempty" validate:"string,regexp=^(Pickup
ReferenceValue string json:"ReferenceValue,omitempty" validate:"string"

Location

ASSET Type DataModel Json
Position Position json:"Position,omitempty"
SequenceNumber int json:"SequenceNumber,omitempty" validate:"int"
StopNumber int json:"StopNumber,omitempty" validate:"int"
LocationName string json:"LocationName,omitempty" validate:"string"
AddressLine1 string json:"AddressLine1,omitempty" validate:"string"
AddressLine2 string json:"AddressLine2,omitempty" validate:"string"
City string json:"City,omitempty" validate:"string"
PostalCode string json:"PostalCode,omitempty" validate:"string"
CountryCode string json:"CountryCode,omitempty" validate:"string,regexp=^[A-Z]{3}$"
County_State_Region string json:"County_State_Region,omitempty" validate:"string"

Time

ASSET Type DataModel Json
DateTimetype string json:"DateTimetype,omitempty" validate:"string"
DateTime string json:"DateTime,omitempty" validate:"string,regexp=^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(([+-]\d\d:\d\d)
TimeZone string json:"TimeZone,omitempty" validate:"string"

Price

ASSET Type DataModel Json
Pricetype string json:"Pricetype,omitempty" validate:"string"
TotalPerLoadPriceFlag string json:"TotalPerLoadPriceFlag,omitempty" validate:"string"
UoM string json:"UoM,omitempty" validate:"string"
Amount string json:"Amount,omitempty" validate:"string,min=1,max=20,regexp=^\d+(\.(\d{1}
CurrencyCode string json:"CurrencyCode,omitempty" validate:"string,regexp=^[A-Z]{3}$"

Shipment

ASSET Type DataModel Json
Cargo Cargo json:"Cargo" mandatory:"true"
Capacity Capacity json:"Capacity" mandatory:"true"
Metadata interface{} json:"Metadata,omitempty"

AttachmentUpdate

ASSET Type DataModel Json
Id string json:"Id" validate:"string" mandatory:"true"
Attachment []Attachment json:"Attachment" validate:"range=1-" mandatory:"true"

TMAIDMapping

ASSET Type DataModel Json
TMAID string json:"TMAID" validate:"string,regexp=^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" id:"true"
MSPID string json:"MSPID" validate:"string" mandatory:"true"

Metadata

ASSET Type DataModel Json
Operation string json:"Operation" validate:"string" id:"true"
Flowtype string json:"Flowtype" validate:"string"
ServiceVattype string json:"ServiceVattype" validate:"string"
SubOperation []string json:"SubOperation" validate:"array=string"
ReferenceInformation []string json:"ReferenceInformation" validate:"array=string"
ExternalReferences []string json:"ExternalReferences" validate:"array=string"

TimeWindow

ASSET Type DataModel Json
DateTimetype string json:"DateTimetype,omitempty" validate:"string"
StartTime string json:"StartTime,omitempty" validate:"string"
EndTime string json:"EndTime,omitempty" validate:"string"
TimeZone string json:"TimeZone,omitempty" validate:"string"

VehicleDetails

ASSET Type DataModel Json
LicencePlateNumber string json:"LicencePlateNumber,omitempty" validate:"string"
LicencePlateCountryCode string json:"LicencePlateCountryCode,omitempty" validate:"string"
Vehicletype string json:"Vehicletype,omitempty" validate:"string"
EmissionStandard string json:"EmissionStandard,omitempty" validate:"string"
Fueltype string json:"Fueltype,omitempty" validate:"string"

AdditionalAttributes

ASSET Type DataModel Json
AttributeDescription string json:"AttributeDescription,omitempty" validate:"string"
AttributeValue string json:"AttributeValue,omitempty" validate:"string"