Skip to content

Carrier Planning API (5.1)

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

Download OpenAPI description
carrier-planning.json
carrier-planning.yaml
Languages
Servers
Mock server
https://developer.simacan.com/_mock/openapi/carrier/carrier-planning/
Production Environment
https://sct-web-api-prod.simacan.com/api/public/
Staging Environment
https://sct-web-api-stg.simacan.com/api/public/

Planning update

Request

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

Security
BearerAuth
Path
shipper_codestringrequired

Unique shipper code as provided by Simacan

carrier_codestringrequired

Unique carrier code as provided by Simacan

Bodyapplication/xmlrequired

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.

 

planningobject
curl -i -X POST \
  'https://developer.simacan.com/_mock/openapi/carrier/carrier-planning/{shipper_code}/transporter/v3/{carrier_code}/planning' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/xml' \
  -d '<planning xmlns="http://www.simacan.com/schemas/rct/transporter/v3/planning">
    <tripId>800099</tripId>
    <timestamp>2014-08-13T12:20:00+02:00</timestamp>
    <driver>William de Vries</driver>
    <fuelType>EURO_6_DIESEL</fuelType>
    <licensePlateTractor>TE-ST-02</licensePlateTractor>
    <tractorType>BAKWAGEN</tractorType>
    <customer>peterson</customer>
    <subcontractor>jansson</subcontractor>
    <root>
      <name>Business Unit</name>
      <value>Any</value>
    </root>
    <phoneNumber>+31612345678</phoneNumber>
    <ecmrDelegate>subaccount</ecmrDelegate>
  </planning>
  '

Responses

The post message was successfully processed.

Response
No content