consignment-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

Sample files for this format can be downloaded here:

root

metadata [M] Object
consignments [M] Array of Object

metadata

source [O] String Our internal source system.
messageId [O] String Unique id for the message.
messageType [O] String Possible values:
  • "consignment-main"
    		•
    messageRootId [O] String Unique id for the message.
    timeStamp [O] String Format: date-time Date and time the message was generated. If time zone information is omitted, is UTC.

    consignments

    header [M] Object
    planDepartment [O] Object Jan de Rijk Plan Department of the consignment.
    businessUnit [M] Object Information regarding the Jan de Rijk business unit in charge of the consingment.
    createdBy [O] Object Information regarding the Jan de Rijk employee that created the consignment.
    charter [M] Object Information regarding the charter that will handle the consignment. This means you.
    costsAndCharges [M] Array of Object Agreed costs and charges for the consignment.
    activities [M] Array of Object The transportation activities required for the consignment.
    shipments [O] Array of Object
    vehicle [M] Object
    pulledUnit [M] Object The first trailer used in the consignment.
    tasks [M] Array of Object Administrative tasks that need to be performed by the charter. Note all required tasks need to be done before the consignment can be invoiced.
    documentResult [O] Object Result of our internal document validation process. This is only and always present if for events 'documentRejected' and 'documentApproved'.

    consignments.header

    events [M] Array of String Possible values:
  • "bookingCreated"
  • "bookingUpdated"
  • "bookingFinalized"
  • "bookingCancelled"
  • "documentRejected"
    • Expand     		Event(s) that triggered this message. If multiple events happened at (alomst) the same time, they are all listed here. bookingCreated: Booking is created. This event will always accompany the first file you receive for a specific consignment. bookingUpdated: We made a change to the booking. This can occur throughout the process. bookingFinalized: The booking is done and will not be changed anymore. bookingCancelled: We cancelled the booking. it will not be executed. documentRejected: You sent a document which we haver rejected. See the 'documentResult' property for details. documentApproved: You sent a document which we have approved. moreDocumentsRequired: This event accompanies 'documentApproved' if there are still more documents pending. bookingConfirmedChargeable: You have performed all required tasks and can now invoice the booking. Note this is the first file in which the PO number (costsAndCharges.invoiceReference) is made available.
    id [M] String Unique id for the consignment. This value is required in all messages you send back to us regarding this consingment.
    businessUnitCode [M] String Code of the Jan de Rijk subcompany that sent the message.
    cancelled [M] Boolean true if the consignment is cancelled (event 'bookingCancelled' will have been sent); otherwise false.
    allTasksDone [M] Boolean true if all tasks are done; otherwise false.
    portalUrl [O] String URL to the Jan de Rijk portal where you can manage the consignment manually.

    consignments.planDepartment

    Jan de Rijk Plan Department of the consignment.

    name [M] String

    consignments.businessUnit

    Information regarding the Jan de Rijk business unit in charge of the consingment.

    code [M] String Jan de Rijk business unit code.
    name [M] String
    invoiceAddress [M] Object Address to use when invoicing Jan de Rijk regarding this consignment. TBD: Is this correct?
    contact [O] Object
    vatNumber [O] String

    consignments.businessUnit.invoiceAddress

    Address to use when invoicing Jan de Rijk regarding this consignment. TBD: Is this correct?

    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 [M] String
    line1 [M] String Street name and number.
    city [M] String
    postalCode [M] String
    countryName [O] String
    countryCode [M] 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

    consignments.businessUnit.contact

    name [O] String Name of the contact person.
    emailDetails [O] Array of Object List of e-mail addresses.
    telephoneDetails [O] Array of Object List of phone numbers.
    faxNumber [O] String

    consignments.businessUnit.contact.emailDetails

    type [M] String Possible values:
  • "normal"
    		•
    value [M] String E-mail address.

    consignments.businessUnit.contact.telephoneDetails

    type [M] String Possible values:
  • "normal"
    		•
    value [M] String Phone number.

    consignments.createdBy

    Information regarding the Jan de Rijk employee that created the consignment.

    name [O] String
    email [O] String

    consignments.charter

    Information regarding the charter that will handle the consignment. This means you.

    number [M] String Jan de Rijk relation number.
    name [M] String Name of the charter as known within Jan de Rijk.
    contact [O] Object Contact details as known at Jan de Rijk.
    code [O] String Jan de Rijk charter code.

    consignments.charter.contact

    Contact details as known at Jan de Rijk.

    name [O] String Name of the contact person.
    emailDetails [O] Array of Object List of e-mail addresses.
    telephoneDetails [O] Array of Object List of phone numbers.
    faxNumber [O] String

    consignments.charter.contact.emailDetails

    type [M] String Possible values:
  • "normal"
    		•
    value [M] String E-mail address.

    consignments.charter.contact.telephoneDetails

    type [M] String Possible values:
  • "normal"
    		•
    value [M] String Phone number.

    consignments.costsAndCharges

    amount [M] Number Amount in the 'currencyCode' currency.
    currencyCode [M] String Min 3 char
    Max 3 char     		ISO currency code.
    invoiceReference [O] String PO number. This reference is mandatory on any invoices regarding the consignment. Is be omitted from all files untill all task regarding the consignment are done.

    consignments.activities

    id [M] String Unique id for the activity. This value is required in all messages you send back to us regarding specifically this activity.
    sequenceNumber [M] Integer Sequence id of the activity within the consignment.
    type [M] String Possible values:
  • "loading"
  • "unloading"
  • "startConnection"
  • "endConnection"
  • "mounting"
    • Expand     		Short description of the activity. Info TBD. Also to check if it makes sense for all of these they are on consignments.
    connection [O] Object Details of the connection.
    party [M] Object
    dateTimes [M] Object
    pulledUnit [O] Object The relevant trailer.
    shipmentNumbers [M] Array of String

    consignments.activities.connection

    Details of the connection.

    name [O] String
    voucherNumber [O] String

    consignments.activities.party

    name [O] String
    number [O] String Jan de Rijk relation number.
    code [O] String Jan de Rijk address code.
    address [M] Object
    contact [O] Object
    remarks [O] String

    consignments.activities.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 [M] String
    line1 [M] String Street name and number.
    city [M] String
    postalCode [M] String
    countryName [O] String
    countryCode [M] 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

    consignments.activities.party.contact

    name [O] String Name of the contact person.
    emailDetails [O] Array of Object List of e-mail addresses.
    telephoneDetails [O] Array of Object List of phone numbers.
    faxNumber [O] String

    consignments.activities.party.contact.emailDetails

    type [M] String Possible values:
  • "normal"
    		•
    value [M] String E-mail address.

    consignments.activities.party.contact.telephoneDetails

    type [M] String Possible values:
  • "normal"
    		•
    value [M] String Phone number.

    consignments.activities.dateTimes

    start [M] String Format: date-time The (expected) start date/time of the activity. If time zone information is omitted, UTC is implicit.
    end [M] String Format: date-time The (expected) end date/time of the activity. If time zone information is omitted, UTC is implicit.
    opening [M] String Format: date-time The opening date/time of the location of the activity. If time zone information is omitted, UTC is implicit.
    closing [M] String Format: date-time The closing date/time of the location of the activity. If time zone information is omitted, UTC is implicit.

    consignments.activities.pulledUnit

    The relevant trailer.

    number [O] String Jan de Rijk number of the pulled unit. This is only filled in if the pulled unit is a Jan de Rijk unit.
    preDefined [M] Boolean true if the pulled unit is a Jan de Rijk unit, false if it is not.
    licensePlate [O] String

    consignments.shipments

    number [M] String Jan de Rijk number of the shipment.
    order [M] Object
    creationDateTime [M] String Format: date-time If time zone information is omitted, UTC is implicit.
    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 original customer and Jan de Rijk.
    unmountingActivityId [O] String
    requirements [M] Object Special requirements relating to the shipment.
    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.
    transportInstructions [O] String
    generalInstructions [O] String
    measurement [M] Object
    goodsLines [M] Array of Object
    remarks [O] String
    originalLoading [?] Object Details of the first loading activity for this shipment.
    finalUnloading [?] Object Details of the last unloading activity for this shipment.
    containerPickUp [?] Object Details of the container pickup activity for this shipment.
    containerDropOff [?] Object Details of the container drop off activity for this shipment.

    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:

    consignments.shipments.order

    departmentCode [?] String Jan de Rijk department code of the shipment.
    product [?] String Jan de Rijk product of the shipment.

    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:

    consignments.shipments.requirements

    Special requirements relating to the shipment.

    freightUnitType [M] String Possible values:
  • "unspecified"
  • "mega"
  • "flatBox"
  • "box"
  • "isolation"
    • Expand     		Trailer type.
    roadTrain [M] Boolean This means LZV (longer truck).
    dangerousCargo [M] Boolean
    urgent [M] Boolean
    heater [M] Boolean
    cooler [M] Boolean
    exclusive [M] Boolean
    maximumTemperature [O] Number
    minimumTemperature [O] Number
    pharmaceuticals [M] Boolean It concerns pharmaceutical cargo, and all requirements for that apply.

    consignments.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"
    		•

    consignments.shipments.measurement

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

    consignments.shipments.goodsLines

    packageType [O] String Possible values:
  • null
  • "pallet"
  • "colli"
  • "euroPallet"
  • "trailer"
    • Expand
    packageDescription [O] String
    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
    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.

    consignments.shipments.goodsLines.measurement

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

    consignments.shipments.goodsLines.detailLines

    packageType [O] String Possible values:
  • null
  • "pallet"
  • "colli"
  • "euroPallet"
  • "trailer"
    • Expand
    packageDescription [O] String
    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 35 char

    consignments.shipments.goodsLines.detailLines.measurement

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

    consignments.shipments.originalLoading

    Details of the first loading activity for this shipment.

    party [M] Object
    dateTimes [M] Object
    reference [O] String

    consignments.shipments.originalLoading.party

    name [O] String
    number [O] String Jan de Rijk relation number.
    code [O] String Jan de Rijk address code.
    address [M] Object
    contact [O] Object
    remarks [O] String

    consignments.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 [M] String
    line1 [M] String Street name and number.
    city [M] String
    postalCode [M] String
    countryName [O] String
    countryCode [M] 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

    consignments.shipments.originalLoading.party.contact

    name [O] String Name of the contact person.
    emailDetails [O] Array of Object List of e-mail addresses.
    telephoneDetails [O] Array of Object List of phone numbers.
    faxNumber [O] String

    consignments.shipments.originalLoading.party.contact.emailDetails

    type [M] String Possible values:
  • "normal"
    		•
    value [M] String E-mail address.

    consignments.shipments.originalLoading.party.contact.telephoneDetails

    type [M] String Possible values:
  • "normal"
    		•
    value [M] String Phone number.

    consignments.shipments.originalLoading.dateTimes

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

    consignments.shipments.finalUnloading

    Details of the last unloading activity for this shipment.

    party [M] Object
    dateTimes [M] Object
    reference [O] String

    consignments.shipments.finalUnloading.party

    name [O] String
    number [O] String Jan de Rijk relation number.
    code [O] String Jan de Rijk address code.
    address [M] Object
    contact [O] Object
    remarks [O] String

    consignments.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 [M] String
    line1 [M] String Street name and number.
    city [M] String
    postalCode [M] String
    countryName [O] String
    countryCode [M] 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

    consignments.shipments.finalUnloading.party.contact

    name [O] String Name of the contact person.
    emailDetails [O] Array of Object List of e-mail addresses.
    telephoneDetails [O] Array of Object List of phone numbers.
    faxNumber [O] String

    consignments.shipments.finalUnloading.party.contact.emailDetails

    type [M] String Possible values:
  • "normal"
    		•
    value [M] String E-mail address.

    consignments.shipments.finalUnloading.party.contact.telephoneDetails

    type [M] String Possible values:
  • "normal"
    		•
    value [M] String Phone number.

    consignments.shipments.finalUnloading.dateTimes

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

    consignments.shipments.containerPickUp

    Details of the container pickup activity for this shipment.

    party [M] Object
    dateTimes [M] Object
    reference [O] String

    consignments.shipments.containerPickUp.party

    name [O] String
    number [O] String Jan de Rijk relation number.
    code [O] String Jan de Rijk address code.
    address [M] Object
    contact [O] Object
    remarks [O] String

    consignments.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 [M] String
    line1 [M] String Street name and number.
    city [M] String
    postalCode [M] String
    countryName [O] String
    countryCode [M] 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

    consignments.shipments.containerPickUp.party.contact

    name [O] String Name of the contact person.
    emailDetails [O] Array of Object List of e-mail addresses.
    telephoneDetails [O] Array of Object List of phone numbers.
    faxNumber [O] String

    consignments.shipments.containerPickUp.party.contact.emailDetails

    type [M] String Possible values:
  • "normal"
    		•
    value [M] String E-mail address.

    consignments.shipments.containerPickUp.party.contact.telephoneDetails

    type [M] String Possible values:
  • "normal"
    		•
    value [M] String Phone number.

    consignments.shipments.containerPickUp.dateTimes

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

    consignments.shipments.containerDropOff

    Details of the container drop off activity for this shipment.

    party [M] Object
    dateTimes [M] Object
    reference [O] String

    consignments.shipments.containerDropOff.party

    name [O] String
    number [O] String Jan de Rijk relation number.
    code [O] String Jan de Rijk address code.
    address [M] Object
    contact [O] Object
    remarks [O] String

    consignments.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 [M] String
    line1 [M] String Street name and number.
    city [M] String
    postalCode [M] String
    countryName [O] String
    countryCode [M] 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

    consignments.shipments.containerDropOff.party.contact

    name [O] String Name of the contact person.
    emailDetails [O] Array of Object List of e-mail addresses.
    telephoneDetails [O] Array of Object List of phone numbers.
    faxNumber [O] String

    consignments.shipments.containerDropOff.party.contact.emailDetails

    type [M] String Possible values:
  • "normal"
    		•
    value [M] String E-mail address.

    consignments.shipments.containerDropOff.party.contact.telephoneDetails

    type [M] String Possible values:
  • "normal"
    		•
    value [M] String Phone number.

    consignments.shipments.containerDropOff.dateTimes

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

    consignments.vehicle

    licensePlate [O] String

    consignments.pulledUnit

    The first trailer used in the consignment.

    number [O] String Jan de Rijk number of the pulled unit. This is only filled in if the pulled unit is a Jan de Rijk unit.
    preDefined [M] Boolean true if the pulled unit is a Jan de Rijk unit, false if it is not.
    licensePlate [O] String

    consignments.tasks

    type [M] String Possible values:
  • "acceptConsignment"
  • "rejectConsignment"
  • "vehicleLicensePlate"
  • "driverName"
  • "pulledUnitLicensePlate"
    • Expand     		acceptConsignment: Accept the execution of the consignment via the 'accepted' property of the event message. rejectConsignment: Indicates the consignment was rejected. Usually not used. vehicleLicensePlate: Send the license plate of the truck that will be used for the consignment, via the 'vehicle' property of the event message. driverName: Send the driver name of the driver that will execute the consignment, via the 'drivers' property of the event message. pulledUnitLicensePlate: Send the license plate of the trailer that will be used for the consignment, via the 'pulledUnit' property of the event message. This is only required for consignments without a predefined Jan de Rijk trailer. arrivalMilestone: Provide the date you arrived at an activity location, via the 'arrived' property of the event message. This is usually not required. startMilestone: Provide the date an activity started, via the 'start' property of the event message. This is required for each activity in the consignment. endMilestone: Provide the date an activity ended, via the 'end' property of the event message. This is required for each activity in the consignment. approvedDocument: Provide a specific document. Usually some form of proof of delivery is required for each unloading activity in the consignment, and each shipment unloaded there must be mentioned. finalPriceConfirmation: This task is completed by Jan de Rijk once the price is agreed.
    sequenceNumber [O] Integer Sequence number if the task can be done multiple times. For instance, this can be '2' when referring to the second driver for a 'driverName' task.
    value [O] String Relevant value for the task. For instance, the delivered license plate of the truck for a 'vehicleLicensePlate' task.
    completedDateTime [O] String Format: date-time Date and time the task was completed. If time zone information is omitted, UTC is implicit. null if the task is open.
    required [M] Boolean true if the task is required, false if it is optional.

    consignments.documentResult

    Result of our internal document validation process. This is only and always present if for events 'documentRejected' and 'documentApproved'.

    activityId [M] String Id of the activity for which the document was sent.
    sentForShipmentNumbers [M] Array of String Shipment numbers for which the document was sent.
    sufficientForShipmentNumbers [M] Array of String Shipment numbers for which the document meets the requirements. If for instance a shipment requires a CMR but a manifest is sent instead, that shipment number will not show up in this array. This array will be empty for documents not deemed 'ok'.
    id [O] String Your identifier for the document. This is the value you provided as document id in your original event message to us.
    hash [M] String SHA-256 hash of the original document, in base 64 format.
    isOk [M] Boolean true if the document was found to be ok, false if it is not.
    documentType [O] String Possible values:
  • "cmr"
  • "manifest"
  • null
    		•  Type of the document. Note this is determined by us after review of the document, it does not have to match the type you used when sending the document. This will be null for any document we deemed not to be OK.
    result [M] String Possible values:
  • "autoOk"
  • "aiOk"
  • "ok"
  • "aiRejected"
  • "emptyFile"
    • Expand     		Result code of the document validation process. Note autoOk, aiOk, ok and imageIsRotated are considered 'correct' results. Others are considered incorrect and will require a better version of the document to be delivered.
    resultText [M] String Text indicating the result of the document.