consignment-status

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.

root

metadata	[M] Object
statuses	[M] Array of Object		The sections vehicle, drivers, pulledUnit and freightUnits are used to send Jan de Rijk information (license plates and driver names) about the assets executing the consignment. These can be send multiple times for updates. The section position is used to send Jan de Rijk the position of the asset executing the consignment. Each position update will be a new record. The section activities is used to send Jan de Rijk the milestone timestamps of each activity

metadata

source	[M] String
messageType	[M] String	Possible values: "consignment-status"
timeStamp	[M] String	Format: date-time	Date and time the message was generated. If time zone information is omitted, is UTC.

statuses

header	[M] Object
shipmentNumbers	[O] Array of String	Pattern: ^[0-9]{12}$	Our (12 digit) shipment numbers relevant for the consignment. N.B. this is required if the 'header.event' is used.
planDepartment	[O] Object		Our plan department relevant for the consignment. N.B. this is required if the 'header.event' is used.
vehicle	[O] Object
drivers	[O] Array of Object
pulledUnit	[O] Object
freightUnits	[O] Array of Object
position	[O] Object
cmrs	[O] Array of Object		CMRs related to the consignment. N.B. the same CMR should never be sent multiple times.
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.

statuses.header

id	[M] String		The header.id from the original message
event	[O] String	Possible values: "accepted" "rejected" null	The event on consignment level. Generally only used as the initial response of the consigment and blank in subsequent files.

statuses.planDepartment

Our plan department relevant for the consignment. N.B. this is required if the 'header.event' is used.

name

[M] String

statuses.vehicle

licensePlate

[M] String

license plate of the truck

statuses.drivers

name	[M] String
hasAdrLicense	[O] Boolean

statuses.pulledUnit

licensePlate

[M] String

license plate of the trailer or chassis

statuses.freightUnits

licensePlate

[M] String

license plate of the container on the chassis

statuses.position

line1	[O] String
line2	[O] String
postalCode	[O] String
city	[O] String
subCity	[O] String
countryCode	[O] String
longitude	[M] Number
latitude	[M] Number

statuses.cmrs

data	[M] String		Base64 representation of the CMR PDF.
shipmentNumbers	[M] Array of String	Pattern: ^[0-9]{12}$	Our (12 digit) shipment numbers relevant for the CMR.

statuses.activities

id	[M] String		The activity id from the original message
type	[M] String		The activity type (short description) from the original message
milestones	[M] Object		at least one milestone is mandatory and for each activity id we need the startDateTime and endDateTime at least once

statuses.activities.milestones

at least one milestone is mandatory and for each activity id we need the startDateTime and endDateTime at least once

arrivalDateTime	[O] String	Format: date-time	If time zone information is omitted, UTC is implicit.
startDateTime	[O] String	Format: date-time	If time zone information is omitted, UTC is implicit.
endDateTime	[O] String	Format: date-time	If time zone information is omitted, UTC is implicit.