Color Line
e2B
Carrier components
Version: 0.1
Bjørn Sundberg
Color Line
Changes
Date / Ver / By / Commentsxx.11.2005 / 0.1 / Bjørn Sundberg / Fist draft for review
1Preface
2CarrierDetails
3CarrierType
4DestinationsType
5FreightType
5.1TravelPartyType
5.1.1PrivateType
5.1.2CompanyType
5.2AddressTypes
5.2.1FlexAddressType
5.2.2NoPostalAddressType
5.2.3NoStreetAddressType
5.2.4ContactType
5.3TermsOfDeliveryTYPE
5.4CustomsInformationTYPE
5.4.1CustomsLineTYPE
5.4.2CommercialInvoiceTYPE
6standardFreightType
6.1cargoCarrierType
6.2cargoType
6.3dangerousGoodsType
7carFreightType
8chargeItemsType
9Universal types
9.1LocationType
9.1.1LocationCodeType
9.2DateTimeType
9.3typeCodedType
9.4CodedType
9.5LengthType
9.6WeightType
10ccTypes
10.1ccQuantity
10.2ccMeasure
10.3ccAmount
10.4ccIndicator
10.5ccCode
1Preface
This document is a guide for elements designed for common carrier transports. This version is primary for transport by sea, but can be used for by air and train.
Notation for multiplicity:
- (1) must occur 1 time.
- (0..1)may occur 1 time.
- (0..*)must not occur, no limit of occurrences.
- (0..n)must not occur, maximum occurrences n times.
- (1..*)must occur 1 time. May have many occurrences.
- (1..n)must occur 1 time. maximum occurrences n times.
In the tables an attribute is recognised by the prefix @, as standard in W3 XPath for attribute.
The use of each element is described under “Description” in the tables.
No text under “Element” in the tables, indicates that the type is of a text node type.
Bjørn Sundberg
2CarrierDetails
This is the root node for all information describing freights on a common carrier. This element is child of BaseItemDetails. In this construction BaseItemDetails is a summary element, and not an element containing details.
CarrierDetailsTypeXML element / Type / Occ / Description
@issueDate / xsd:date / (0..1) / Issue date
@issuedBy / xsd:string / (0..1) / Name issuer.
@language / xsd:string / (0..1) / Language code ISO 639.2
@MessageVersion / xsd:string / (1) / Version = 1.0
CommonCarrier / CarrierType / (1) / Information of common carrier unit.
Destinations / DestinationType / (1) / Endpoints for common carrier
Freight / FreightType / (1..*) / Information of cargo units
3CarrierType
This element contains information of the common carrier unit. This version of is supporting sea freight, airfreight and freight by train.
CarrierTypeXML element / Type / Occ / Description
@typeCarrier / xsd:string / (1) / air – airfreight
sea – sea freight
trn – train freight
@callsign / xsd:string / (0..1) / IMO call sign for ship
@vesselType / xsd:string / (0..1) / Type of vessel.
@nameCoded / xsd:string / (0..1) / Code for common carrier.
xsd:string / (1) / Sea freight - ship name.
Airfreight - flight number.
For train - id for route.
4DestinationsType
This element contains information of endpoints for the common carrier.
DestinationsTypeXML element / Type / Occ / Description
DepartureArrival / xsd:string / (0..1) / Text describing endpoints.
Example: Oslo – Kiel
Departure / LocationType / (0..1) / Information of departure location
Arrival / LocationType / (0..1) / Information of arrival location
5FreightType
This element contains all information of a cargo unit defined by a position number on the cargo manifest.
FreightTypeXML element / Type / Occ / Description
PositionNumber / xsd:string / (1) / This is a unique identification on a manifest. Usually generated by issuing "Waybill" or "Bill of Lading"
BookingIdentifier / xsd:string / (0..1) / Unique identifier issued by the the seller of the freight.
SellerReference / xsd:string / (1) / Reference issued by the Seller. Usually the provider of the freight.
CustomerReference / xsd:string / (1) / Reference issued by the Customer. Usually the buyer of the freight.
FreightInformation / xsd:string / (0..1) / Information of issues concernig the freight.
LoadingSite / LocationType / (0..1) / The site for loading the goods if different from carrier departure.
UnloadingSite / LocationType / (0..1) / The site for unloading the goods if different from carrier arrival
Notify / TravelPartyType / (0..1) / The party to be notified of arrival of goods.
Shipper / TravelPartyType / (0..1) / The merchant (person) by whom, in whose name or on whose behalf a contract of carriage of goods has been concluded with a carrier or any party by whom, in whose name or on whose behalf the goods are actually delivered to the carrier in relation to the contract of carriage.
Synonym: Consignor, Sender.
Consignee / TravelPartyType / (0..1) / The party such as mentioned in the transport document by whom the goods, cargo or containers are to be received.
TermsOfDelivery / TermsOfDeliveryTYPE / (0..1) / All the conditions agreed upon between trading partners regarding the delivery of goods and the related services.
Under normal circumstances the INCO terms are used to prevent any misunderstandings.
CustomsInformation / CustomsInformationTYPE / (0..1) / Reference issued by Customs in the importing country
FreeText / xsd:string / (0..1) / Free textual description of whatever.
Comments / xsd:string / (0..1) / Any comments
StandardFreight | CarFreight / standardFreightType | carFreightType / (1) / Specification of the freight
ChargeItems / chargeItemsType / (0..1) / Specified prices
Summary / InvoiceSummaryType / (0..1) / Summary for freight
5.1TravelPartyType
This element defines if it’s a private customer or a company. This type is identical with TravelParyType used in TravelDetails, hence the name.
TravelPartyTypeXML element / Type / Occ / Description
Private |
Company / PrivateType | CompanyType / (1) / Private customer of a company as customer
5.1.1PrivateType
Information of a private customer
PrivateTypeXML element / Type / Occ / Description
Name / xsd:string / (1) / Peron name
PostalAddress | NoPostalAddress / FlexAddressType | NoPostalAddressType / (0..1) / Address information
EmailAddress / xsd:string / (0..1) / Email address
5.1.2CompanyType
Information of a company.
CompanyTypeXML element / Type / Occ / Description
Name / xsd:string / (1) / Company name
PostalAddress | NoPostalAddress / FlexAddressType | NoPostalAddressType / (0..1) / Postal address
StreetAddress | NoStreetAddress / FlexAddressType | NoStreetAddressType / (0..1) / Street address
InvoiceAddress | NoInvoiceAddress / FlexAddressType | NoPostalAddressType / (0..1) / Invoice address
AccountNumber / xsd:string / (0..1) / Company bank account
OrganizationNumber / xsd:string / (0..1) / Company organization id
Contact / ContactType / (0..1) / Contact information
EmailAddress / xsd:string / (0..1) / Email address
WebAddress / xsd:string / (0..1) / Web address URI
5.2AddressTypes
This is an overview of the different types of addresses.
5.2.1FlexAddressType
.
FlexAddressTypeXML element / Type / Occ / Description
Address / xsd:string / (1..4) / Address line
PostalDistrict / xsd:string / (0..1) / Postal district
CountryCode / xsd:string / (0..1) / UN code country
5.2.2NoPostalAddressType
Alternative 1:
NoPostalAddressTypeXML element / Type / Occ / Description
StreetName / xsd:string / (1) / Street name
StreetNumber / xsd:string / (0..1) / Street number
PostalDistrictCode / xsd:string / (1) / Postal district coded.
PostalDistrictName / xsd:string / (1) / Postal district name
CountryCode / xsd:string / (0..1) / UN country code
Alternative 2:
NoStreetAddressTypeXML element / Type / Occ / Description
Postoffice / xsd:string / (0..1) / Name post office
Postboxnumber / xsd:string / (1) / Number post-box
PostalDistrictCode / xsd:string / (1) / Postal district coded.
PostalDistrictName / xsd:string / (1) / Postal district name
CountryCode / xsd:string / (0..1) / UN country code
5.2.3NoStreetAddressType
Specifies a Norwegian street address .
NoStreetAddressTypeXML element / Type / Occ / Description
StreetName / xsd:string / (1) / Street name
StreetNumber / xsd:string / (0..1) / Street number
PostalDistrictCode / xsd:string / (1) / Postal district coded.
PostalDistrictName / xsd:string / (1) / Postal district name
CountryCode / xsd:string / (0..1) / UN country code
5.2.4ContactType
Contact information.
ContactTypeXML element / Type / Occ / Description
Name / xsd:string / (1) / Name
FirstName / xsd:string / (0..1) / First names
LastName / xsd:string / (0..1) / Surname
TelephoneNumber / xsd:string / (0..1) / Telephone number
EmailAddress / xsd:string / (0..1) / Email address
Function / xsd:string / (0..1) / Role of contact
5.3TermsOfDeliveryTYPE
Information related to the delivery.
TermsOfDeliveryTYPEXML element / Type / Occ / Description
TODConditionCode / ccCode / (0..1) / Coded terms of delivery
TODConditionCodeList / ccCode / (0..1) / Code list for terms of delivery
TODLocation / ccText / (0..1) / Location
5.4CustomsInformationTYPE
Information related to customs.
CustomsInformationTYPEXML element / Type / Occ / Description
CustomsClearanceNo / xsd:string / (0..1) / Identifier from customs
BondedWarehouseNo / xsd:string / (0..1) / Identifier for storage site.
SequenceNo / xsd:decimal / (0..1)
SubLevelSequenceNo / xsd:decimal / (0..1)
CustomsValue / ccAmount / (0..1) / Value of goods for declaration
InsuranceAmount / ccAmount / (0..1) / Insurance value for goods
CustomsLine / CustomsLineTYPE / (0..*) / Goods item specification
CommercialInvoice / CommercialInvoiceTYPE / (0..*) / Invoiceinformation
5.4.1CustomsLineTYPE
Information related to customs.
CustomsLineTYPEXML element / Type / Occ / Description
CountryOfOrigin / ccCode / (0..1) / Code for country of origin for the goods
StatisticalNo / ccCode / (0..1) / Id for statistics
NumberOfPackages / ccQuantity / (0..1) / Number of packages
NetWeight / ccMeasure / (0..1) / Net weight of goods
GrossWeight / ccMeasure / (0..1) / Gross weight of goods
QuantityOtherUnit / ccQuantity / (0..1) / ?
StatisticalValue / ccAmount / (0..1) / Value of goods for statistical purpose
GoodsDescription / xsd:string / (0..1) / Verbally description og goods
5.4.2CommercialInvoiceTYPE
Information related to customs.
CustomsLineTYPEXML element / Type / Occ / Description
InvoiceNo / xsd:string / (0..1) / Invoice number
InvoiceDate / xsd:string / (0..1) / Date of invoice
InvoiceAmount / ccAmount / (0..1) / Total invoice amount
6standardFreightType
standardFreightTypeXML element / Type / Occ / Description
CargoCarrier / cargoCarrierType / (1) / Information of the cargo carrier, not the common carrier.
Cargo / cargoType / (1..*) / Information of cargo items on cargo carrier
DangerousGoods / dangerousGoodsType / (0..*) / Information of IMDG goods
DriverName / xsd:string / (0..*) / Name of drivers
6.1cargoCarrierType
cargoCarrierTypeXML element / Type / Occ / Description
TypeText / xsd:string / (1) / Typical types for seafreight are:Road train, Semi trailer, Trailer, Container, Swap body, Groupage, Pallet etc.
TypeCoded / typeCodedType / (0..1) / The cargo carrier coded.
RegistrationNumber / xsd:string / (0..1) / The id of the cargo carrier. Usually registration number.
Length / LengthType / (0..1) / The total length of the cargo carrier.
Height / LengthType / (0..1) / Height of the cargo carrier
Volume / VolumeType / (0..1) / Volume of the cargo carrier
Weight / WeightType / (1) / Weight of the cargo carrier
SealReference / xsd:string / (0..1) / Id of the seal if cargo carrier sealed. Usually by customs.
6.2cargoType
cargoTypeXML element / Type / Occ / Description
TypeText / xsd:string / (1) / Typical cargo types are: Pallet box etc.
TypeCoded / xsd:string / (0..1) / Cargo type coded
Identifier / xsd:string / (0..1) / Identifier of the cargo.
Information / xsd:string / (0..1) / Textual description
Length / LengthType / (0..1) / The total length of the cargo
Height / LengthType / (0..1) / Height of the cargo
Volume / VolumeType / (0..1) / Volume of the cargo
Weight / WeightType / (1) / Weight of the cargo
6.3dangerousGoodsType
This element is based on IMDG codes defined by IMO. (International Maritime Organization)
dangerousGoodsTypeXML element / Type / Occ / Description
UnNo / xsd:positiveInteger / (1) / The UN number of the goods defined by IMO
ImoClass / xsd:string / (1) / The class for the UN number
PackageGroup / xsd:string / (0..1) / The package group for the goods.
Stowage / xsd:string / (1) / Code for stowage regulations onboard a ship.
ProperShippingName / xsd:string / (0..1) / Name of the cargo
ImdgWeight / WeightType / (1) / Weight of the cargo
MarinePollutant / xsd:string / (0..1) / P – Pollutant
PP – Very pollutant
Ems / xsd:string / (0..1) / Code for emergency measures
LimitedQuantity / xsd:string / (0..1) / L – if transported under limited quantity regulations
7carFreightType
carFreightTypeXML element / Type / Occ / Description
TypeText / xsd:string / (1) / Typical types are: Car, Chassis, Caravan, Camping car etc.
TypeCoded / typeCodedType / (0..1) / Type in coded form
MarkName / xsd:string / (0..1) / Mark is typically Ford, Opel, Skoda etc
NumberOfMark / xsd:positiveInteger / (1) / Total number of cars on this position
CarModel / carModelType / (0..*) / Specific description of each type of car.
TotalWeight / WeightType / (0..1) / The total weight of cars.
8chargeItemsType
Identifikator som er unik hos utsteder.
chargeItemsTypeXML element / Type / Occ / Description
Details / e2b:DetailsType / (1..*) / Price lines for cargo
See description on BaseItemDertails in “e2b Fakturaformat Teknisk Dokumentasjon” .
9Universal types
9.1LocationType
This element contains information of one endpoint.
LocationTypeXML element / Type / Occ / Description
Name / xsd:string / (0..1) / Name of location
Coded / LoctionCodeType / (0..1) / Location coded
Date / xsd:date / (1) / Date for incident. format yyyy-mm-dd
Time / xsd:time / (0..1) / Time for incident hh:mm:ss
9.1.1LocationCodeType
This element contains information of a location in coded form.
LocationCodeTypeXML element / Type / Occ / Description
@codeType / xsd:string / (0..1) / Type code or organisation responsible for the code
xsd:string / (1) / Code
9.2DateTimeType
DateTimeTypeXML element / Type / Occ / Description
Date / xsd:date / (1) / Date format yyyy-mm-dd
Time / xsd:time / (0..1) / Time format hh:mm:ss
9.3typeCodedType
typeCodedTypeXML element / Type / Occ / Description
@codeList / xsd:string / (0..1) / Reference to a code list
xsd:string / (1) / The code
9.4CodedType
LocationCodeTypeXML element / Type / Occ / Description
@codeList / xsd:string / (0..1) / Organization for code
xsd:string / (1) / Code
9.5LengthType
LengthTypeXML element / Type / Occ / Description
@measureUnit / xsd:string / (0..1) / Measure unit KGM | TON
xsd:string / (1) / Measure value
9.6WeightType
WeightTypeXML element / Type / Occe / Description
@measureUnit / xsd:string / (0..1) / Measure unit KGM | TON
xsd:string / (1) / Measure value
10ccTypes
This chapter contains different types which are subsets of Core Components from CFACT.
10.1ccQuantity
ccQuantityXML element / Type / Occ / Description
@unitCode / xsd:string / (0..1) / Unit code
xsd:decimal / (1) / Value
10.2ccMeasure
ccMeasureXML element / Type / Occ / Description
@unitCode / xsd:string / (0..1) / Unit code
xsd:decimal / (1) / Value
10.3ccAmount
ccAmountXML element / Type / Occ / Description
@currencyIdentificationCode / xsd:string / (0..1) / Currency
xsd:decimal / (1) / Value
10.4ccIndicator
ccIndicatorXML element / Type / Occ / Description
xsd:string / (1) / YES | NO
10.5ccCode
ccCodeXML element / Type / Occ / Description
@codeListIdentifier / xsd:string / (0..1) / Id of code list
@codeListAgencyIdentifier / xsd:string / (0..1) / Responsible agency for the code list
@name / xsd:string / (0..1) / Name of code list
xsd:string / (1) / Code
1
Carrier components 1.0