Carrier Planning API (5.0)

The Carrier Planning API enables you to update a part of the transport planning for a trip and add optional eCMR delegation

Planning update

The planning endpoint enables you to update the transport planning for a trip and add optional eCMR delegation.

An important notice: all data in the message will be visible to all parties with access to the planning of the specific trip

SecurityBearerAuth
Request
path Parameters
shipper_code
required
string

Unique shipper code as provided by Simacan

carrier_code
required
string

Unique carrier code as provided by Simacan

Request Body schema: application/xml

For the ecmrDelegate field, the subaccount value should be equal to the formatting as known at the e-CMR-provider. Any updates to the field, will revoke the previous assigned subaccount delegations by Simacan.

When the ecmrDelegate value is left empty or is absent, we will try to delegate based on licensePlateTractor, however we prefer that you explicit fill the value for ecmrDelegate.

 

object
required
object
tripId
required
string

Unique reference for this trip

timestamp
required
string <date-time>

Timestamp when record was created

driver
string

Driver name.
Important: Visible to all parties with access to the planning of the specific trip

fuelType
required
string

A choice of fuelType

Enum: "EURO_5_DIESEL" "EURO_5_DIESEL_EEV" "EURO_6_DIESEL" "HYBRIDE_DIESEL_EURO_5" "HYBRIDE_DIESEL_EURO_6" "CNG" "LNG" "LBM" "CBG" "EV" "DUAL_FUEL_LNG_DIESEL" "DUAL_FUEL_CNG_DIESEL" "DUAL_FUEL_LBM_DIESEL" "DUAL_FUEL_CBG_DIESEL"
licensePlateTractor
required
string

License plate for the tractor

tractorType
required
string

The specific type of tractor

Enum: "BAKWAGEN" "BAKWAGEN_KOEL" "BAKWAGEN_KOEL_COMBI" "BAKWAGEN_KLEIN" "BAKWAGEN_KLEIN_KOEL" "BAKWAGEN_KLEIN_KOEL_COMBI" "TREKKER"
customer
required
string

Specify for which customer is being driven

subcontractor
string

Name of the subcontractor. By using this optional field, the trip is subcontracted/chartered to another carrier. The subcontractor is then enabled to send in data for this trip and see it in control tower

Array of objects (trailer)
Array
trailerId
required
string

Unique id for the trailer

licensePlate
required
string

License plate for the trailer

trailerType
required
string

The specific type of trailer

Enum: "BAKWAGEN" "BAKWAGEN_KOEL" "BAKWAGEN_KOEL_COMBI" "BAKWAGEN_KLEIN" "BAKWAGEN_KLEIN_KOEL" "BAKWAGEN_KLEIN_KOEL_COMBI" "CITY_8_00" "CITY_8_00_KOEL" "CITY_8_00_KOEL_COMBI" "CITY_9_80" "CITY_9_80_KOEL" "CITY_9_80_KOEL_COMBI" "CITY_10_50" "CITY_10_50_KOEL" "CITY_10_50_KOEL_COMBI" "CITY_11_20" "CITY_11_20_KOEL" "CITY_11_20_KOEL_COMBI" "CITY_11_60" "CITY_11_60_KOEL" "CITY_11_60_KOEL_COMBI" "EURO_13_60" "EURO_13_60_KOEL" "EURO_13_60_KOEL_COMBI" "KORTE_CITY_8_85" "KORTE_CITY_8_85_KOEL" "KORTE_CITY_8_85_KOEL_COMBI" "TREKKER"
phoneNumber
string

The phone number of the driver

ecmrDelegate
string

Exact subaccountname as used in TransFollow portal

Array of objects (customerDataItem)
Array
name
required
string

The name or key for the custom field For example: Plan Group

value
required
string

The value for the custom field For example: Fast moving

Responses
200

The post message was successfully processed.

400

The request was invalid or cannot be otherwise served. Possible causes are invalid XML or missing required parameters. An accompanying error message will explain further.

401

Authentication credentials were missing or incorrect.

403

The request is understood, but it has been refused or access is not allowed. An accompanying error message will explain why.

404

The URI requested is invalid or the resource requested does not exists. Also returned when the requested format is not supported by the requested method.

post/{shipper_code}/transporter/v2/{carrier_code}/planning
Request samples
application/xml
<?xml version="1.0" encoding="UTF-8" ?><ns2:planning xmlns:ns2="http://www.simacan.com/schemas/rct/transporter/v2/planning">
    <tripPlanning>
        <tripId>800099</tripId>
        <timestamp>2020-12-09T04:43:00.000+02:00</timestamp>
        <driver>William de Vries</driver>
        <fuelType>EURO_6_DIESEL</fuelType>
        <licensePlateTractor>TE-ST-02</licensePlateTractor>
        <tractorType>TREKKER</tractorType>
        <customer>peterson</customer>
        <subcontractor>jansson</subcontractor>
        <trailers>
            <trailer>
                <trailerId>KDZ-Opl1</trailerId>
                <licensePlate>KDZ-Opl1</licensePlate>
                <trailerType>EURO_13_60_KOEL</trailerType>
            </trailer>
            <trailer>
                <trailerId>KDZ-Opl2</trailerId>
                <licensePlate>KDZ-Opl2</licensePlate>
                <trailerType>EURO_13_60_KOEL</trailerType>
            </trailer>
        </trailers>
        <ecmrDelegate>subaccountName</ecmrDelegate>
    </tripPlanning>
</ns2:planning>
Response samples
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<Messages>
	<Message>INFO: Found existing rit with id {id} and planned start date {date}</Message>
</Messages>