consignment-event

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

Sample files for this format can be downloaded here:

root

metadata	[O] Object
events	[M] Array of Object		One or more consignments for which events are being sent.

metadata

source	[O] String	Min 1 char Max 100 char
messageType	[O] String	Possible values: "consignment-event"
timeStamp	[O] String	Format: date-time	Date and time the message was generated. If time zone information is omitted, is UTC.

events

header	[M] Object
vehicle	[O] Object	Details of the vehicle (truck) that will be used to handle the consignment. This data needs to be provided at least once for each consignment.
drivers	[O] Array of Object	Details of the driver(s) that will handle the consignment. Details of at least one driver need to be provided at least once for each consignment. If a second driver is used, their details need to be delivered once as well.
pulledUnit	[O] Object	Details of the trailer which will be used to handle the consignment. This is required if it is not a Jan de Rijk trailer.
activities	[O] Array of Object	Activities for which the milestones have changed. N.B. genereally this will not be used or an empty list if the 'header.event' is used.

consignmentId	[M] String		The header.id from the original consignment-main message.
accepted	[O] Boolean		true if the consignment is accepted; otherwise false. Jan de Rijk requires 'true' to be sent at least once for each consignment.

events.vehicle

Details of the vehicle (truck) that will be used to handle the consignment. This data needs to be provided at least once for each consignment.

licensePlate	[M] String	Min 5 char Max 25 char Pattern: ^[0-9A-Za-z][0-9A-Za-z\-\/\ ]{3,10}$

events.drivers

name	[M] String	Min 5 char Max 25 char
hasAdrLicense	[O] Boolean

events.pulledUnit

Details of the trailer which will be used to handle the consignment. This is required if it is not a Jan de Rijk trailer.

licensePlate	[M] String	Min 5 char Max 25 char Pattern: ^[0-9A-Za-z][0-9A-Za-z\-\/\ ]{3,10}$

events.activities

id	[M] String	The activity id from the original consignment-main message.
milestones	[O] Object
documents	[O] Array of Object	Documents related to the activity. At some point in the process, a document needs be delivered for each shipment of each unloading activity in the consignment. Under certain circumstances, this document is required to be a CMR. In other circumstances, a Cargo manifest is sufficient but a CMR is also allowed. We will validate the document at our end.

events.activities.milestones

arrival	[O] String	Format: date-time	Not required to be sent by charters. If time zone information is omitted, UTC is implicit.
start	[O] String	Format: date-time	This value should be delivered at least once for each activity in the consignment. If time zone information is omitted, UTC is implicit.
end	[O] String	Format: date-time	This value should be delivered at least once for each activity in the consignment. If time zone information is omitted, UTC is implicit.

events.activities.documents

shipmentNumbers	[M] Array of String	Pattern: ^(([0-9]{12})\|([0-9]{15}))$	Our shipment numbers relevant for this document. These must be shipment numbers related to this activity.
id	[O] String	Min 1 char Max 100 char	Your identifier for the document. This will be echoed back in the response message so you can be useful to keep track of which document was approved or rejected.
documentType	[M] String	Possible values: "cmr" "manifest"	Type of document. We will validate this at our end. Therefore, you are allowed to hardcode 'cmr'.
contents	[M] String		Base64 representation of the CMR PDF.
fileType	[M] String	Possible values: "application/pdf"	Data type of 'contents'. Currently only 'application/pdf' is allowed.