transportorder-main

Schema downloads

The JSON schema for this format can be downloaded here.

Use this link to download the strict schema, which will disallow unknown properties for as much as that is possible witin the schema language. Our internal processes simply ignore unknown properties but the strict schema can be usefull to notice typo's.

We will on occasion add new fields without notifying all recipients of the file. Therefore please do not use the strict schema for validation of files we send to you. If you want to validate our files at your end, the standard schema can be used. We will notify all recipients before doing a change in a file that would cause it to no longer match the standard schema.

Sample files

The sample file for this format can be downloaded here:

root

metadata [O] Object
orders [M] Array of Object

metadata

source [O] String Source system or customer code.
messageId [O] String Unique id for the message.
messageReference [O] String Customer reference for the message.
messageType [O] String Type name of the message.
messageRootId [O] String Message id of the first message in a chain of messages.
timeStamp [O] String Format: date-time Date and time the message was generated. If time zone information is omitted, is UTC.

orders

reference [M] String Max 30 char Customer's reference for the order. This is the reference that would be used to refer to the order in any communication between the customer and Jan de Rijk.
ediReference [O] String Max 27 char Customer unique id for the order. If a message is received with a previously used ediReference, it will be seen as an update of that order. It can be omitted but then it will not be possible to update the order via EDI.
invoiceReference [O] String Max 30 char Used as purchase order reference for invoicing and accounting.
departmentCode [?] String Max 3 char
Pattern: ^[0-9]{3}$ Possible values:
  • "100"
  • "102"
  • "104"
  • "105"
  • "130"
Expand 		The code of the Jan de Rijk department that should handle the order. Usually a fixed value that can be provided at the start of the integration project. Either this property or 'product' must be present.
product [?] String Possible values:
  • "generalCargo"
  • "importContainers"
  • "exportContainers"
  • null
 The relevant Jan de Rijk product. Usually a fixed value that can be provided at the start of the integration project. Either this property or 'departmentCode' must be present.
customer [M] Object
tariffType [O] String Possible values:
  • null
  • "normal"
  • "bpRate"
  • "combi"
  • "kilometer"
Expand 		Used when there are price agreements. Should be omitted (or null) unless a value was specifically agreed upon with the Jan de Rijk sales department.
breakCode [O] String An additional invoice code in case the customer wants to split the invoices by those codes. To be discussed with Jan de Rijk finance department before use.
customsDocumentType [O] String Possible values:
  • null
  • "-EU"
  • "AAD"
  • "ADM"
  • "AGD"
Expand 		The relevant customs document type.
extraStops [O] Integer The relevant number of extra stops. To be discussed with Jan de Rijk finance department before use.
costsAndCharges [O] Array of Object
customerData [O] Object Additional customer specific data. Can be any valid JSON object.
shipments [M] Array of Object

Conditinally required properties

Some properties mentioned above are sometimes mandatory and sometimes optional or not available, note the [?]. These are the possible combinations of properties that can be used:

orders.customer

Number

number [M] String Max 6 char
Pattern: ^[0-9]{6}$ 		Jan de Rijk number for the customer. The customer will be informed of their own number on request or as part of an integration project.

or: Code

code [M] String Max 20 char Jan de Rijk code for the customer. The customer will be informed of their own code on request or as part of an integration project.

orders.costsAndCharges

To be provided if there are no price agreements.

code [M] String Max 4 char "100" should be used unless otherwise discussed.
currencyCode [M] String Min 3 char
Max 3 char 		ISO currency code.
amount [M] Number Amount in the 'currencyCode' currency.
description [O] String This field is currently not imported but can be sent to provide more details on the cost.

orders.customerData

Additional customer specific data. Can be any valid JSON object.

orders.shipments

Most orders will only have a single shipment. But it can also be that multiple shipments are combined in one order, two examples: First, multiple shipments on one address that require a separate invoice, or are a consolidation of multiple items at customer end. Second, shipments that require load/unload in multiple locations.

reference [M] String Max 30 char Customer's reference for the shipment. This is the reference that would be used to refer to the order in any communication between the customer and Jan de Rijk. This reference also appears on invoices and status messages, and is searchable in JConnect.
ediReference [O] String Max 27 char Your unique id for the shipment. If a message is received with a previously used ediReference, it will be seen as an update of that shipment.
bondedGoodsNumber [O] String
tariffType [O] String Possible values:
  • null
  • "normal"
  • "bpRate"
  • "combi"
  • "kilometer"
Expand 		Used when there are price agreements. Should be omitted (or null) unless a value was specifically agreed upon with the Jan de Rijk sales department.
breakCode [O] String An additional invoice code in case the customer wants to split the invoices by those codes. To be discussed with Jan de Rijk finance department before use.
customsDocumentType [O] String Possible values:
  • null
  • "-EU"
  • "AAD"
  • "ADM"
  • "AGD"
Expand 		The relevant customs document type.
invoiceReference [O] String Max 30 char Used as purchase order reference for invoicing and accounting.
financeRemarks [O] String
extraStops [O] Integer The relevant number of extra stops. To be discussed with Jan de Rijk finance department before use.
forecast [O] Boolean True if the booking is a forecast, false if it is a final booking. Updates with forecast = true will not replace any shipment data for which a forecast = false message was already received.
ecmr [O] Object
requirements [O] Object Special requirements relating to the shipment. The requested requirements should match the SOP agreements and tariffs, and might have an impact on pricing. Omitting a requirement indicates it is not applicable.
security [O] Object Can be used to specify security above the standard security level of TSR 01. The actual security level is explained in the SOP and arranged by the Jan de Rijk planning team.
airFreightExport [O] Boolean Specifies if the cargo will be transferred to a plane (to be flown to a further destination) on unloading.
transportInstructions [O] String
ediRemarks [O] String
planningInstructions [O] String
goodsLines [M] Array of Object
customerData [O] Object Additional customer specific data. Can be any valid JSON object.
clearingIn [O] Object
consignee [O] Object
originalLoading [?] Object
finalUnloading [?] Object
containerPickUp [?] Object
containerDropOff [?] Object

Conditinally required properties

Some properties mentioned above are sometimes mandatory and sometimes optional or not available, note the [?]. These are the possible combinations of properties that can be used:

orders.shipments.ecmr

required [O] Boolean
id [O] String
provider [O] String

orders.shipments.requirements

Special requirements relating to the shipment. The requested requirements should match the SOP agreements and tariffs, and might have an impact on pricing. Omitting a requirement indicates it is not applicable.

secondDriver [O] Boolean
freightUnitType [O] String Possible values:
  • null
  • "mega"
  • "flatBox"
  • "box"
  • "isolation"
Expand 		Can be omitted as long as cargo arrives in good condition.
roadTrain [O] Boolean This means LZV (longer truck). It can only be selected when it is agreed in the SOP for a certain line.
dangerousCargo [O] Boolean
urgent [O] Boolean
heater [O] Boolean
cooler [O] Boolean
exclusive [O] Boolean If true, Jan de Rijk won't have the possibility to co-load the cargo with other customers' cargo. Co-loading regulations are taken into account regardless.
maximumTemperature [O] Number
minimumTemperature [O] Number
palletSwap [O] Boolean
pharmaceuticals [O] Boolean It concerns pharmaceutical cargo, and all requirements for that apply.

orders.shipments.security

Can be used to specify security above the standard security level of TSR 01. The actual security level is explained in the SOP and arranged by the Jan de Rijk planning team.

secured [M] Boolean
level [O] String Possible values:
  • null
  • "TAPA1"
  • "TAPA2"

orders.shipments.goodsLines

packageType [O] String Possible values:
  • null
  • "pallet"
  • "colli"
  • "euroPallet"
  • "trailer"
Expand
measurement [M] Object
goodsType [O] String Possible values:
  • null
  • "airCargo"
  • "airCargoPalletized"
  • "carParts"
  • "general"
Expand
goodsDescription [O] String Max 20 char
mark [O] String Max 16 char
dimensions [O] Object
detailLines [O] Array of Object Optional further breakdown of the goods. If used, the measurements on goods line can be omitted as in that case the sum of the detailLines will be used.
dangerousGoods [O] Array of Object

orders.shipments.goodsLines.measurement

grossWeight [O] Number 3 decimals Kilograms.
chargeableWeight [O] Number 3 decimals Kilograms.
quantity [M] Integer
volume [O] Number 3 decimals Cubic metres.
volumeWeight [O] Number 3 decimals Kilograms. Usually only used for air freight.
loadIndex [O] Number 3 decimals

orders.shipments.goodsLines.dimensions

length [O] Number 3 decimals Metres.
width [O] Number 3 decimals Metres.
height [O] Number 3 decimals Metres.

orders.shipments.goodsLines.detailLines

packageType [O] String Possible values:
  • null
  • "pallet"
  • "colli"
  • "euroPallet"
  • "trailer"
Expand
measurement [M] Object
goodsType [O] String Possible values:
  • null
  • "airCargo"
  • "airCargoPalletized"
  • "carParts"
  • "general"
Expand
goodsDescription [O] String Max 20 char
mark [O] String Max 35 char
awb [O] String Max 12 char
Pattern: ^(([0-9]{11})|([0-9]{3}[-][0-9]{8}))$

orders.shipments.goodsLines.detailLines.measurement

grossWeight [O] Number 3 decimals Kilograms.
chargeableWeight [O] Number 3 decimals Kilograms.
quantity [M] Integer
volume [O] Number 3 decimals Cubic metres.
volumeWeight [O] Number 3 decimals Kilograms. Usually only used for air freight.
loadIndex [O] Number 3 decimals

orders.shipments.goodsLines.dangerousGoods

code [M] String Max 4 char
Pattern: ^[0-9]{1,4}$ 		UN code.
suffix [O] String Max 3 char
Pattern: ^[0-9]{1,3}$

orders.shipments.customerData

Additional customer specific data. Can be any valid JSON object.

orders.shipments.clearingIn

party [O] Object Party (location) information can be given in different ways, to be discussed with the customer prior to the implementation of the integration setup.

orders.shipments.clearingIn.party

Party (location) information can be given in different ways, to be discussed with the customer prior to the implementation of the integration setup.

Customer's code with translation by Jan de Rijk

When the party is in Jan de Rijk master data including the code that the customer uses for the address, the customer can provide their own code. When Jan de Rijk does not recognize new codes, the order ends up in a waiting table since it is rejected. The system will be updated manually with the customer's reference and master data by our customer service, ahead of accepting the order. Both parties need to make sure to have agreed a procedure around newly generated codes.

searchCode [M] String Max 50 char Customer's code of an existing address in Jan de Rijk system.

or: Full address

When the party is not necessarily in Jan de Rijk master data, the customer can provide the whole address. The party will be created/updated at Jan de Rijk automatically.

address [M] Object

orders.shipments.clearingIn.party.address

locationCode [O] String Max 5 char Only to be used if the location is an airport, in whcih case it should be the IATA code.
name1 [O] String Max 35 char
name2 [O] String Max 35 char
name3 [O] String Max 35 char
line1 [M] String Max 35 char Street name and number.
line2 [O] String Max 35 char
line3 [O] String Max 35 char
city [O] String Max 35 char
postalCode [M] String Max 10 char
countryCode [O] String Max 2 char
Pattern: ^[A-Z]{2}$ 		ISO Alpha-2 (https://www.nationsonline.org/oneworld/country_code_list.htm) country code.
longitude [O] Number
latitude [O] Number

orders.shipments.consignee

party [O] Object Party (location) information can be given in different ways, to be discussed with the customer prior to the implementation of the integration setup.

orders.shipments.consignee.party

Party (location) information can be given in different ways, to be discussed with the customer prior to the implementation of the integration setup.

Customer's code with translation by Jan de Rijk

When the party is in Jan de Rijk master data including the code that the customer uses for the address, the customer can provide their own code. When Jan de Rijk does not recognize new codes, the order ends up in a waiting table since it is rejected. The system will be updated manually with the customer's reference and master data by our customer service, ahead of accepting the order. Both parties need to make sure to have agreed a procedure around newly generated codes.

searchCode [M] String Max 50 char Customer's code of an existing address in Jan de Rijk system.

or: Full address

When the party is not necessarily in Jan de Rijk master data, the customer can provide the whole address. The party will be created/updated at Jan de Rijk automatically.

address [M] Object

orders.shipments.consignee.party.address

locationCode [O] String Max 5 char Only to be used if the location is an airport, in whcih case it should be the IATA code.
name1 [O] String Max 35 char
name2 [O] String Max 35 char
name3 [O] String Max 35 char
line1 [M] String Max 35 char Street name and number.
line2 [O] String Max 35 char
line3 [O] String Max 35 char
city [O] String Max 35 char
postalCode [M] String Max 10 char
countryCode [O] String Max 2 char
Pattern: ^[A-Z]{2}$ 		ISO Alpha-2 (https://www.nationsonline.org/oneworld/country_code_list.htm) country code.
longitude [O] Number
latitude [O] Number

orders.shipments.originalLoading

party [M] Object Party (location) information can be given in different ways, to be discussed with the customer prior to the implementation of the integration setup.
dateTimes [M] Object
reference [O] String

orders.shipments.originalLoading.party

Party (location) information can be given in different ways, to be discussed with the customer prior to the implementation of the integration setup.

Customer's code with translation by Jan de Rijk

When the party is in Jan de Rijk master data including the code that the customer uses for the address, the customer can provide their own code. When Jan de Rijk does not recognize new codes, the order ends up in a waiting table since it is rejected. The system will be updated manually with the customer's reference and master data by our customer service, ahead of accepting the order. Both parties need to make sure to have agreed a procedure around newly generated codes.

searchCode [M] String Max 50 char Customer's code of an existing address in Jan de Rijk system.

or: Full address

When the party is not necessarily in Jan de Rijk master data, the customer can provide the whole address. The party will be created/updated at Jan de Rijk automatically.

address [M] Object

orders.shipments.originalLoading.party.address

locationCode [O] String Max 5 char Only to be used if the location is an airport, in whcih case it should be the IATA code.
name1 [O] String Max 35 char
name2 [O] String Max 35 char
name3 [O] String Max 35 char
line1 [M] String Max 35 char Street name and number.
line2 [O] String Max 35 char
line3 [O] String Max 35 char
city [O] String Max 35 char
postalCode [M] String Max 10 char
countryCode [O] String Max 2 char
Pattern: ^[A-Z]{2}$ 		ISO Alpha-2 (https://www.nationsonline.org/oneworld/country_code_list.htm) country code.
longitude [O] Number
latitude [O] Number

orders.shipments.originalLoading.dateTimes

opening [M] String Format: date-time If time zone information is omitted, UTC is implicit.
closing [O] String Format: date-time If time zone information is omitted, UTC is implicit.

or: Unknown window

date [M] String Format: date

orders.shipments.finalUnloading

party [M] Object Party (location) information can be given in different ways, to be discussed with the customer prior to the implementation of the integration setup.
dateTimes [M] Object
reference [O] String
slotBooking [O] Object

orders.shipments.finalUnloading.party

Party (location) information can be given in different ways, to be discussed with the customer prior to the implementation of the integration setup.

Customer's code with translation by Jan de Rijk

When the party is in Jan de Rijk master data including the code that the customer uses for the address, the customer can provide their own code. When Jan de Rijk does not recognize new codes, the order ends up in a waiting table since it is rejected. The system will be updated manually with the customer's reference and master data by our customer service, ahead of accepting the order. Both parties need to make sure to have agreed a procedure around newly generated codes.

searchCode [M] String Max 50 char Customer's code of an existing address in Jan de Rijk system.

or: Full address

When the party is not necessarily in Jan de Rijk master data, the customer can provide the whole address. The party will be created/updated at Jan de Rijk automatically.

address [M] Object

orders.shipments.finalUnloading.party.address

locationCode [O] String Max 5 char Only to be used if the location is an airport, in whcih case it should be the IATA code.
name1 [O] String Max 35 char
name2 [O] String Max 35 char
name3 [O] String Max 35 char
line1 [M] String Max 35 char Street name and number.
line2 [O] String Max 35 char
line3 [O] String Max 35 char
city [O] String Max 35 char
postalCode [M] String Max 10 char
countryCode [O] String Max 2 char
Pattern: ^[A-Z]{2}$ 		ISO Alpha-2 (https://www.nationsonline.org/oneworld/country_code_list.htm) country code.
longitude [O] Number
latitude [O] Number

orders.shipments.finalUnloading.dateTimes

opening [M] String Format: date-time If time zone information is omitted, UTC is implicit.
closing [O] String Format: date-time If time zone information is omitted, UTC is implicit.
earlyPossible [O] Boolean If true, Jan de Rijk can pick-up the cargo outside the time window.

or: Unknown window

date [M] String Format: date

orders.shipments.finalUnloading.slotBooking

contact [M] Object

orders.shipments.finalUnloading.slotBooking.contact

name [O] String Max 30 char
mail [O] String Max 60 char
phone [O] String Max 30 char

orders.shipments.containerPickUp

party [M] Object Party (location) information can be given in different ways, to be discussed with the customer prior to the implementation of the integration setup.
dateTimes [M] Object
reference [O] String

orders.shipments.containerPickUp.party

Party (location) information can be given in different ways, to be discussed with the customer prior to the implementation of the integration setup.

Customer's code with translation by Jan de Rijk

When the party is in Jan de Rijk master data including the code that the customer uses for the address, the customer can provide their own code. When Jan de Rijk does not recognize new codes, the order ends up in a waiting table since it is rejected. The system will be updated manually with the customer's reference and master data by our customer service, ahead of accepting the order. Both parties need to make sure to have agreed a procedure around newly generated codes.

searchCode [M] String Max 50 char Customer's code of an existing address in Jan de Rijk system.

or: Full address

When the party is not necessarily in Jan de Rijk master data, the customer can provide the whole address. The party will be created/updated at Jan de Rijk automatically.

address [M] Object

orders.shipments.containerPickUp.party.address

locationCode [O] String Max 5 char Only to be used if the location is an airport, in whcih case it should be the IATA code.
name1 [O] String Max 35 char
name2 [O] String Max 35 char
name3 [O] String Max 35 char
line1 [M] String Max 35 char Street name and number.
line2 [O] String Max 35 char
line3 [O] String Max 35 char
city [O] String Max 35 char
postalCode [M] String Max 10 char
countryCode [O] String Max 2 char
Pattern: ^[A-Z]{2}$ 		ISO Alpha-2 (https://www.nationsonline.org/oneworld/country_code_list.htm) country code.
longitude [O] Number
latitude [O] Number

orders.shipments.containerPickUp.dateTimes

opening [M] String Format: date-time If time zone information is omitted, UTC is implicit.
closing [O] String Format: date-time If time zone information is omitted, UTC is implicit.

or: Unknown window

date [M] String Format: date

orders.shipments.containerDropOff

party [M] Object Party (location) information can be given in different ways, to be discussed with the customer prior to the implementation of the integration setup.
dateTimes [M] Object
reference [O] String

orders.shipments.containerDropOff.party

Party (location) information can be given in different ways, to be discussed with the customer prior to the implementation of the integration setup.

Customer's code with translation by Jan de Rijk

When the party is in Jan de Rijk master data including the code that the customer uses for the address, the customer can provide their own code. When Jan de Rijk does not recognize new codes, the order ends up in a waiting table since it is rejected. The system will be updated manually with the customer's reference and master data by our customer service, ahead of accepting the order. Both parties need to make sure to have agreed a procedure around newly generated codes.

searchCode [M] String Max 50 char Customer's code of an existing address in Jan de Rijk system.

or: Full address

When the party is not necessarily in Jan de Rijk master data, the customer can provide the whole address. The party will be created/updated at Jan de Rijk automatically.

address [M] Object

orders.shipments.containerDropOff.party.address

locationCode [O] String Max 5 char Only to be used if the location is an airport, in whcih case it should be the IATA code.
name1 [O] String Max 35 char
name2 [O] String Max 35 char
name3 [O] String Max 35 char
line1 [M] String Max 35 char Street name and number.
line2 [O] String Max 35 char
line3 [O] String Max 35 char
city [O] String Max 35 char
postalCode [M] String Max 10 char
countryCode [O] String Max 2 char
Pattern: ^[A-Z]{2}$ 		ISO Alpha-2 (https://www.nationsonline.org/oneworld/country_code_list.htm) country code.
longitude [O] Number
latitude [O] Number

orders.shipments.containerDropOff.dateTimes

opening [M] String Format: date-time If time zone information is omitted, UTC is implicit.
closing [O] String Format: date-time If time zone information is omitted, UTC is implicit.
earlyPossible [O] Boolean If true, Jan de Rijk can pick-up the cargo outside the time window.

or: Unknown window

date [M] String Format: date