API Reference
/
Platform

Transportial OTMS API (0.9.2)

Download OpenAPI description
index.json
index.yaml
Overview
URL http://transportial.com
Transportial info@transportial.com
Languages
Servers
Mock server
https://docs.transportial.com/_mock/apis/
Test environment
https://test.api.otms.transportial.com/api/
Production
https://api.otms.transportial.com/api/

Transportial

Our full API documentation can be found here for OTMS. It describes our endpoints and the way we accept data.

Authentication

You can authenticate users by a login call and sending their token in the Authorization header.

OTM5

Our API is fully supportive of the OTM5 data structure. You can send and receive those objects in the exact definition. In our documentation you will find our other objects and you don't need to use Associations, we do return that structure however.

ServiceCard

Object describing a geographic ServiceCard. A ServiceCard can either be a point or an area.

Operations

Tire

Object describing a geographic Tire. A Tire can either be a point or an area.

Operations

Action

Actions are dynamic entities that are able to couple together various static entities at a certain moment in time. For instance a Load action couples together a Consignment and a Vehicle at the moment the Loading happens.

Operations

Actor

Actors can be stacked and constrain different activities in their context

Operations

Charge

Charges

Operations

Invoice

Invoices

Operations

LedgerEntry

LedgerEntry ...

Operations

Payout

Payouts

Operations

Plan

Plans

Operations

Quote

Quotes

Operations

Administration

Administrations can be stacked and constrain different activities in their context

Operations

Transaction

Transactions

Operations

Alert

Object describing a geographic alert. A alert can either be a point or an area.

Operations

Publisher

Object describing a geographic publisher. A publisher can either be a point or an area.

Operations

App

Object describing a geographic app. A app can either be a point or an area.

Operations

Attribute

A generic entity that can help in defining other entities properties

Operations

Ban

Object describing a geographic Ban. A Ban can either be a point or an area.

Operations

Board

Boards contain Lanes and might represent a module of a project or a project itself

Operations

Booking

Object describing a geographic booking. A booking can either be a point or an area.

Operations

Business

Business is a base entity that describes a companies information. Thiis entity is used for contracts, clients, invoices, quotes, etc. It can be any type of relation you do business with.

Operations

Camera

A Camera

Operations

CapacityContract

The CapacityContract is the entity to model a contract of a purchase of certain amount of scheduled capacity.

Operations

Capacity

A capacity models the amount of cargo, a schedule can deliver.

Operations

Certificate

Object describing a geographic Certificate. A Certificate can either be a point or an area.

Operations

Chat

Sending messages to users grouped by rooms

Operations

MessageTemplate

MessageTemplates can be stacked and constrain different activities in their context

Operations

Chauffeur

Chauffeurs are the people who are responsible for controlling a Vehicle. They have schedules, planning and legal responsibilities.

Operations

Complaint

Object describing a geographic Complaint. A Complaint can either be a point or an area.

Operations

Consignment

Consignments can be stacked and constrain different activities in their context

Operations

Constraint

Constraints can be stacked and constrain different activities in their context

Operations

Contract

Contracts

Operations

Damage

Object describing a geographic damage. A damage can either be a point or an area.

Operations

Document

Documents are the base entities to handle all types of external data files and the references to them

Operations

Event

Events - like actions - model dynamic entities that couple various static entities at a certain moment in time. Events are used for either real-time updates, or updates on earlier provided data. Notice that in both event types these are updates on earlier provided data, whereas actions are usually used together with the entities they dynamically couple.

Operations

Feedback

Feedbacks

Operations

File

File management. Upload, retrieve and download files. Categorized by it's purpose.

Operations

Fleet

Fleets can be stacked and constrain different activities in their context

Operations

General

General reference data sets like Languages, Currencies etc. and functions

Operations

Goods

Goods are the items to be transported as part of a consignment. Goods can be divided into two sub-types of goods, depending on the use case and the level of detail. Goods either consists of items, describing the actual goods to be transported. Or a transport equipment, which is equipment used to carry the actual goods to be transported. Transport equipment is (usually) a means to an end, not something that needs to be transported on itself, such as pallets.

Operations

TransportEquipment

TransportEquipment are the items to be transported as part of a consignment. TransportEquipment can be divided into two sub-types of transportEquipment, depending on the use case and the level of detail. TransportEquipment either consists of items, describing the actual transportEquipment to be transported. Or a transport equipment, which is equipment used to carry the actual transportEquipment to be transported. Transport equipment is (usually) a means to an end, not something that needs to be transported on itself, such as pallets.

Operations

Insights

All the insights you need can be gathered from these endpoints

Operations

Integration

An Integration is the connection for 2 systems. An integration can be configured and enabled through this object. It can also configure the entire connection or it can be pre-configured.

Operations

Lane

A lane contains a location and status of a todo task.

Operations

ToDo

A lane contains a location and status of a todo task.

Operations

Location

Object describing a geographic location. A location can either be a point or an area.

Operations

Mail

Mails can be stacked and constrain different activities in their context

Operations

Management

The management overviews

Operations

MessageAutomation

Message-Automations are communication automation connectors that can use events

Operations

Notification

Notification endpoint to notify people, groups or the entire user base of things they might want to know or need to know

Operations

Platform

Platforms can be stacked and constrain different activities in their context

Operations

Create platform payment intent

Request

Create a payment intent that will be used for the periodic billing

Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
idstring
companyNamestring
vatstring
emailstring
administrativeReferenceobject(AdministrativeReference)
curl -i -X PUT \
  https://docs.transportial.com/_mock/apis/platform/billing/setup \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "companyName": "string",
    "vat": "string",
    "email": "string",
    "administrativeReference": {
      "name": "string",
      "street": "string",
      "houseNumber": "string",
      "houseNumberAddition": "string",
      "postalCode": "string",
      "city": "string",
      "country": "string"
    }
  }'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
billingIdstring
paymentIntentIdstring
clientSecretstring
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "billingId": "string",
  "paymentIntentId": "string",
  "clientSecret": "string"
}

Get billing estimate

Request

Get an estimate for the next billing month

Path
idstringrequired
Headers
Authorizationstringrequired
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/platform/billing/{id}/estimate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
estimateobject(Money)
endOfBillingPeriodstring(date-time)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "estimate": {
    "id": "string",
    "nonce": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "amount": 0.1,
    "currency": { … },
    "taxRate": { … },
    "inclusiveOfTax": true
  },
  "endOfBillingPeriod": "2019-08-24T14:15:22Z"
}

Get platform billing invoices

Request

Get list of platform billing invoices

Path
idstringrequired
offsetinteger(int64)required
amountinteger(int64)required
Headers
Authorizationstringrequired
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/platforms/billing/{id}/{offset}/{amount}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
totalResultsinteger(int32)
invoicesArray of objects(InvoiceModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "totalResults": 0,
  "invoices": [
    { … }
  ]
}

Get platform billing

Request

Get a platform billing on id

Path
idstringrequired
Headers
Authorizationstringrequired
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/platform/billing/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
billingobject(Billing)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "billing": {
    "id": "string",
    "nonce": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "plan": { … },
    "companyName": "string",
    "vat": "string",
    "email": "string",
    "administrativeReference": { … },
    "customerId": "string",
    "intentId": "string",
    "lastBilled": "2019-08-24T14:15:22Z",
    "lastUsageEventsRun": "2019-08-24T14:15:22Z",
    "approvedBillingElementTypes": [ … ]
  }
}

Get platform billing usage events by date range

Request

Get list of platform usage events by date range

Path
idstringrequired
startstringrequired
endstringrequired
Headers
Authorizationstringrequired
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/platforms/billing/{id}/usageEvents:byDateRange/{start}/{end}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
totalResultsinteger(int32)
eventsArray of objects(BillingUsageEvent)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "totalResults": 0,
  "events": [
    { … }
  ]
}

Get platform billing usage events

Request

Get list of platform usage events

Path
idstringrequired
offsetinteger(int64)required
amountinteger(int64)required
Headers
Authorizationstringrequired
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/platforms/billing/{id}/usageEvents/{offset}/{amount}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
totalResultsinteger(int32)
eventsArray of objects(BillingUsageEvent)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "totalResults": 0,
  "events": [
    { … }
  ]
}

Get platform billing

Request

Get a platform billing by platform id

Path
idstringrequired
Headers
Authorizationstringrequired
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/platform/{id}/billing' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
billingobject(Billing)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "billing": {
    "id": "string",
    "nonce": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "plan": { … },
    "companyName": "string",
    "vat": "string",
    "email": "string",
    "administrativeReference": { … },
    "customerId": "string",
    "intentId": "string",
    "lastBilled": "2019-08-24T14:15:22Z",
    "lastUsageEventsRun": "2019-08-24T14:15:22Z",
    "approvedBillingElementTypes": [ … ]
  }
}

Get platform

Request

Get a platform on id

Path
idstringrequired
Headers
Authorizationstringrequired
curl -i -X GET \
  https://docs.transportial.com/_mock/apis/platform \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
platformobject(PlatformModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "platform": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "nameSpace": "string",
    "logo": { … },
    "favicon": { … },
    "notificationLogo": { … },
    "fullLogo": { … },
    "backgroundImage": { … },
    "darkLogo": { … },
    "darkFavicon": { … },
    "darkNotificationLogo": { … },
    "darkFullLogo": { … },
    "darkBackgroundImage": { … },
    "primaryColor": "string",
    "secondaryColor": "string",
    "darkPrimaryColor": "string",
    "darkSecondaryColor": "string",
    "hostNames": [ … ],
    "features": [ … ],
    "planningSettings": { … },
    "pricingSettings": { … },
    "credentialSettings": { … },
    "routingSettings": { … },
    "translationSettings": { … },
    "uiSettings": { … },
    "canRegister": true,
    "canRequestAccess": true,
    "description": "string",
    "contactEmail": "string",
    "apps": [ … ],
    "disablingAt": "2019-08-24T14:15:22Z",
    "disabled": true,
    "inWaitList": true
  }
}

Update platform

Request

Update a new platform

Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
idstring
noncestring
uuidstring
primaryPlatformIdstring
createdAtstring(date-time)
updatedAtstring(date-time)
namestring
nameSpacestring
logoobject(FileModel)
faviconobject(FileModel)
notificationLogoobject(FileModel)
fullLogoobject(FileModel)
backgroundImageobject(FileModel)
darkLogoobject(FileModel)
darkFaviconobject(FileModel)
darkNotificationLogoobject(FileModel)
darkFullLogoobject(FileModel)
darkBackgroundImageobject(FileModel)
primaryColorstring
secondaryColorstring
darkPrimaryColorstring
darkSecondaryColorstring
hostNamesArray of objects(PlatformHostNameModel)
featuresArray of objects(PlatformFeature)
planningSettingsobject(PlatformPlanningSettings)
pricingSettingsobject(PlatformPricingSettings)
credentialSettingsobject(PlatformCredentialSettings)
routingSettingsobject(PlatformRoutingSettings)
translationSettingsobject(PlatformTranslationSettings)
uiSettingsobject(PlatformUISettings)
canRegisterboolean
canRequestAccessboolean
descriptionstring
contactEmailstring
appsArray of objects(AppModel)
disablingAtstring(date-time)
disabledboolean
inWaitListboolean
curl -i -X PUT \
  https://docs.transportial.com/_mock/apis/platform \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "nameSpace": "string",
    "logo": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "favicon": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "notificationLogo": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "fullLogo": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "backgroundImage": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "darkLogo": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "darkFavicon": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "darkNotificationLogo": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "darkFullLogo": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "darkBackgroundImage": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "primaryColor": "string",
    "secondaryColor": "string",
    "darkPrimaryColor": "string",
    "darkSecondaryColor": "string",
    "hostNames": [
      {
        "id": "string",
        "nonce": "string",
        "uuid": "string",
        "primaryPlatformId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "hostName": "string"
      }
    ],
    "features": [
      {
        "name": "string"
      }
    ],
    "planningSettings": {
      "defaultDeliveryTerms": "EXW",
      "alwaysCombinedTransport": true,
      "finishTripOnActionsComplete": true,
      "loadActionDefaultDuration": 0,
      "unloadActionDefaultDuration": 0,
      "stopActionDefaultDuration": 0,
      "attachTransportEquipmentActionDefaultDuration": 0,
      "detachTransportEquipmentActionDefaultDuration": 0,
      "defaultTransportOrderTemplate": "string",
      "defaultTripStartDuration": 0
    },
    "pricingSettings": {
      "defaultChauffeurCostPricing": [
        {
          "nonce": "string",
          "type": "fixed",
          "name": "string",
          "sequenceNr": 0,
          "description": "string",
          "category": {
            "nonce": "string",
            "name": "string",
            "creditCode": "string",
            "debitCode": "string",
            "defaultValue": 0.1,
            "enabled": true
          },
          "taxRates": [
            {
              "nonce": "string",
              "sequenceNr": 0,
              "name": "string",
              "description": "string",
              "taxRate": {
                "nonce": "string",
                "creditCode": "string",
                "debitCode": "string",
                "identifiers": [
                  null
                ],
                "name": "string",
                "description": "string",
                "jurisdiction": "string",
                "percentage": 0.1,
                "inclusive": true,
                "active": true
              },
              "filters": [
                {
                  "filters": []
                }
              ]
            }
          ],
          "filters": [
            {
              "selector": "string",
              "comparisonType": "equal",
              "value": "string",
              "linkType": "and",
              "filters": [
                {
                  "filters": []
                }
              ],
              "sequenceNr": 0
            }
          ],
          "oncePerInvoice": true
        }
      ],
      "defaultVehicleCostPricing": [
        {
          "nonce": "string",
          "type": "fixed",
          "name": "string",
          "sequenceNr": 0,
          "description": "string",
          "category": {
            "nonce": "string",
            "name": "string",
            "creditCode": "string",
            "debitCode": "string",
            "defaultValue": 0.1,
            "enabled": true
          },
          "taxRates": [
            {
              "nonce": "string",
              "sequenceNr": 0,
              "name": "string",
              "description": "string",
              "taxRate": {
                "nonce": "string",
                "creditCode": "string",
                "debitCode": "string",
                "identifiers": [
                  null
                ],
                "name": "string",
                "description": "string",
                "jurisdiction": "string",
                "percentage": 0.1,
                "inclusive": true,
                "active": true
              },
              "filters": [
                {
                  "filters": []
                }
              ]
            }
          ],
          "filters": [
            {
              "selector": "string",
              "comparisonType": "equal",
              "value": "string",
              "linkType": "and",
              "filters": [
                {
                  "filters": []
                }
              ],
              "sequenceNr": 0
            }
          ],
          "oncePerInvoice": true
        }
      ]
    },
    "credentialSettings": {
      "force2FA": true,
      "stripeKey": "string",
      "stripePublicKey": "string",
      "ptvKey": "string",
      "ptvSecret": "string",
      "awsKey": "string",
      "awsSecret": "string",
      "googleApiKey": "string",
      "googleApiSecret": "string",
      "googleCaptchaKey": "string",
      "googleCaptchaSecret": "string"
    },
    "routingSettings": {
      "routingEngine": "transportial",
      "seaPassages": {
        "allowSuez": true,
        "allowPanama": true,
        "allowMalacca": true,
        "allowGibraltar": true,
        "allowDover": true,
        "allowBering": true,
        "allowMagellan": true,
        "allowBabelmandeb": true,
        "allowKiel": true,
        "allowCorinth": true,
        "allowNorthwest": true,
        "allowNortheast": true
      }
    },
    "translationSettings": {
      "languagesLabels": [
        {
          "language": "string",
          "labels": "string"
        }
      ]
    },
    "uiSettings": {
      "disabledFields": [
        "string"
      ],
      "requiredFields": [
        "string"
      ],
      "requireVerifiedBusinesses": true
    },
    "canRegister": true,
    "canRequestAccess": true,
    "description": "string",
    "contactEmail": "string",
    "apps": [
      {
        "id": "string",
        "nonce": "string",
        "uuid": "string",
        "primaryPlatformId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "logo": {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "url": "string",
          "path": "string",
          "name": "string",
          "originalName": "string",
          "size": 0,
          "purpose": "string",
          "type": "IMAGE",
          "mimeType": "string",
          "extension": "string",
          "uploadedAt": "2019-08-24T14:15:22Z"
        },
        "name": "string",
        "description": "string",
        "publisher": {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "logo": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "url": "string",
            "path": "string",
            "name": "string",
            "originalName": "string",
            "size": 0,
            "purpose": "string",
            "type": "IMAGE",
            "mimeType": "string",
            "extension": "string",
            "uploadedAt": "2019-08-24T14:15:22Z"
          },
          "name": "string",
          "description": "string",
          "users": [
            {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "type": "user",
              "username": "string",
              "avatar": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              },
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "passwordModified": "2019-08-24T14:15:22Z",
              "twoFactorAuthentication": true,
              "status": "DELETED",
              "loginMethod": "DEFAULT",
              "timezone": "string",
              "vehicleGroups": [
                {
                  "vehicles": []
                }
              ],
              "activeAdministration": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "primary": true,
                "business": {
                  "documents": [],
                  "banners": [],
                  "locations": [],
                  "identification": [],
                  "contactDetails": [],
                  "contactPersons": []
                },
                "currency": {},
                "balance": {},
                "numberFormat": "string",
                "numberLength": 0,
                "dueDays": 0,
                "invoiceNumberIndex": {},
                "quoteNumberIndex": {},
                "automaticallySendReminders": true,
                "invoiceTermsAndConditions": "string",
                "quoteTermsAndConditions": "string",
                "invoiceNumbering": 0,
                "quoteNumbering": 0
              },
              "accountType": "default",
              "standardLoadingSize": 0
            }
          ]
        },
        "termsAndConditions": "string",
        "lastVersion": {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "name": "string",
          "description": "string",
          "buildNumber": 0,
          "version": "string",
          "permissions": [
            {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "read": true,
              "write": true,
              "delete": true,
              "permissionScope": "PUBLIC",
              "isObjectPermission": true
            }
          ],
          "approved": true
        },
        "versions": [
          {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "description": "string",
            "buildNumber": 0,
            "version": "string",
            "permissions": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "read": true,
                "write": true,
                "delete": true,
                "permissionScope": "PUBLIC",
                "isObjectPermission": true
              }
            ],
            "approved": true
          }
        ],
        "approved": true,
        "public": true
      }
    ],
    "disablingAt": "2019-08-24T14:15:22Z",
    "disabled": true,
    "inWaitList": true
  }'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
platformobject(PlatformModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "platform": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "nameSpace": "string",
    "logo": { … },
    "favicon": { … },
    "notificationLogo": { … },
    "fullLogo": { … },
    "backgroundImage": { … },
    "darkLogo": { … },
    "darkFavicon": { … },
    "darkNotificationLogo": { … },
    "darkFullLogo": { … },
    "darkBackgroundImage": { … },
    "primaryColor": "string",
    "secondaryColor": "string",
    "darkPrimaryColor": "string",
    "darkSecondaryColor": "string",
    "hostNames": [ … ],
    "features": [ … ],
    "planningSettings": { … },
    "pricingSettings": { … },
    "credentialSettings": { … },
    "routingSettings": { … },
    "translationSettings": { … },
    "uiSettings": { … },
    "canRegister": true,
    "canRequestAccess": true,
    "description": "string",
    "contactEmail": "string",
    "apps": [ … ],
    "disablingAt": "2019-08-24T14:15:22Z",
    "disabled": true,
    "inWaitList": true
  }
}

Create platform

Request

Create a new platform

Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
noncestring
namestring
nameSpacestring
logoobject(FileModel)
faviconobject(FileModel)
notificationLogoobject(FileModel)
fullLogoobject(FileModel)
backgroundImageobject(FileModel)
darkLogoobject(FileModel)
darkFaviconobject(FileModel)
darkNotificationLogoobject(FileModel)
darkFullLogoobject(FileModel)
darkBackgroundImageobject(FileModel)
primaryColorstring
secondaryColorstring
darkPrimaryColorstring
darkSecondaryColorstring
hostNamesArray of objects(PlatformHostNameModel)
featuresArray of objects(PlatformFeature)
planningSettingsobject(PlatformPlanningSettings)
pricingSettingsobject(PlatformPricingSettings)
credentialSettingsobject(PlatformCredentialSettings)
routingSettingsobject(PlatformRoutingSettings)
translationSettingsobject(PlatformTranslationSettings)
canRegisterboolean
canRequestAccessboolean
descriptionstring
contactEmailstring
appsArray of objects(AppModel)
disablingAtstring(date-time)
disabledboolean
inWaitListboolean
curl -i -X POST \
  https://docs.transportial.com/_mock/apis/platform \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "nonce": "string",
    "name": "string",
    "nameSpace": "string",
    "logo": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "favicon": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "notificationLogo": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "fullLogo": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "backgroundImage": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "darkLogo": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "darkFavicon": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "darkNotificationLogo": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "darkFullLogo": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "darkBackgroundImage": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "primaryColor": "string",
    "secondaryColor": "string",
    "darkPrimaryColor": "string",
    "darkSecondaryColor": "string",
    "hostNames": [
      {
        "id": "string",
        "nonce": "string",
        "uuid": "string",
        "primaryPlatformId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "hostName": "string"
      }
    ],
    "features": [
      {
        "name": "string"
      }
    ],
    "planningSettings": {
      "defaultDeliveryTerms": "EXW",
      "alwaysCombinedTransport": true,
      "finishTripOnActionsComplete": true,
      "loadActionDefaultDuration": 0,
      "unloadActionDefaultDuration": 0,
      "stopActionDefaultDuration": 0,
      "attachTransportEquipmentActionDefaultDuration": 0,
      "detachTransportEquipmentActionDefaultDuration": 0,
      "defaultTransportOrderTemplate": "string",
      "defaultTripStartDuration": 0
    },
    "pricingSettings": {
      "defaultChauffeurCostPricing": [
        {
          "nonce": "string",
          "type": "fixed",
          "name": "string",
          "sequenceNr": 0,
          "description": "string",
          "category": {
            "nonce": "string",
            "name": "string",
            "creditCode": "string",
            "debitCode": "string",
            "defaultValue": 0.1,
            "enabled": true
          },
          "taxRates": [
            {
              "nonce": "string",
              "sequenceNr": 0,
              "name": "string",
              "description": "string",
              "taxRate": {
                "nonce": "string",
                "creditCode": "string",
                "debitCode": "string",
                "identifiers": [
                  null
                ],
                "name": "string",
                "description": "string",
                "jurisdiction": "string",
                "percentage": 0.1,
                "inclusive": true,
                "active": true
              },
              "filters": [
                {
                  "filters": []
                }
              ]
            }
          ],
          "filters": [
            {
              "selector": "string",
              "comparisonType": "equal",
              "value": "string",
              "linkType": "and",
              "filters": [
                {
                  "filters": []
                }
              ],
              "sequenceNr": 0
            }
          ],
          "oncePerInvoice": true
        }
      ],
      "defaultVehicleCostPricing": [
        {
          "nonce": "string",
          "type": "fixed",
          "name": "string",
          "sequenceNr": 0,
          "description": "string",
          "category": {
            "nonce": "string",
            "name": "string",
            "creditCode": "string",
            "debitCode": "string",
            "defaultValue": 0.1,
            "enabled": true
          },
          "taxRates": [
            {
              "nonce": "string",
              "sequenceNr": 0,
              "name": "string",
              "description": "string",
              "taxRate": {
                "nonce": "string",
                "creditCode": "string",
                "debitCode": "string",
                "identifiers": [
                  null
                ],
                "name": "string",
                "description": "string",
                "jurisdiction": "string",
                "percentage": 0.1,
                "inclusive": true,
                "active": true
              },
              "filters": [
                {
                  "filters": []
                }
              ]
            }
          ],
          "filters": [
            {
              "selector": "string",
              "comparisonType": "equal",
              "value": "string",
              "linkType": "and",
              "filters": [
                {
                  "filters": []
                }
              ],
              "sequenceNr": 0
            }
          ],
          "oncePerInvoice": true
        }
      ]
    },
    "credentialSettings": {
      "force2FA": true,
      "stripeKey": "string",
      "stripePublicKey": "string",
      "ptvKey": "string",
      "ptvSecret": "string",
      "awsKey": "string",
      "awsSecret": "string",
      "googleApiKey": "string",
      "googleApiSecret": "string",
      "googleCaptchaKey": "string",
      "googleCaptchaSecret": "string"
    },
    "routingSettings": {
      "routingEngine": "transportial",
      "seaPassages": {
        "allowSuez": true,
        "allowPanama": true,
        "allowMalacca": true,
        "allowGibraltar": true,
        "allowDover": true,
        "allowBering": true,
        "allowMagellan": true,
        "allowBabelmandeb": true,
        "allowKiel": true,
        "allowCorinth": true,
        "allowNorthwest": true,
        "allowNortheast": true
      }
    },
    "translationSettings": {
      "languagesLabels": [
        {
          "language": "string",
          "labels": "string"
        }
      ]
    },
    "canRegister": true,
    "canRequestAccess": true,
    "description": "string",
    "contactEmail": "string",
    "apps": [
      {
        "id": "string",
        "nonce": "string",
        "uuid": "string",
        "primaryPlatformId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "logo": {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "url": "string",
          "path": "string",
          "name": "string",
          "originalName": "string",
          "size": 0,
          "purpose": "string",
          "type": "IMAGE",
          "mimeType": "string",
          "extension": "string",
          "uploadedAt": "2019-08-24T14:15:22Z"
        },
        "name": "string",
        "description": "string",
        "publisher": {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "logo": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "url": "string",
            "path": "string",
            "name": "string",
            "originalName": "string",
            "size": 0,
            "purpose": "string",
            "type": "IMAGE",
            "mimeType": "string",
            "extension": "string",
            "uploadedAt": "2019-08-24T14:15:22Z"
          },
          "name": "string",
          "description": "string",
          "users": [
            {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "type": "user",
              "username": "string",
              "avatar": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              },
              "firstName": "string",
              "lastName": "string",
              "email": "string",
              "phone": "string",
              "passwordModified": "2019-08-24T14:15:22Z",
              "twoFactorAuthentication": true,
              "status": "DELETED",
              "loginMethod": "DEFAULT",
              "timezone": "string",
              "vehicleGroups": [
                {
                  "vehicles": []
                }
              ],
              "activeAdministration": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "primary": true,
                "business": {
                  "documents": [],
                  "banners": [],
                  "locations": [],
                  "identification": [],
                  "contactDetails": [],
                  "contactPersons": []
                },
                "currency": {},
                "balance": {},
                "numberFormat": "string",
                "numberLength": 0,
                "dueDays": 0,
                "invoiceNumberIndex": {},
                "quoteNumberIndex": {},
                "automaticallySendReminders": true,
                "invoiceTermsAndConditions": "string",
                "quoteTermsAndConditions": "string",
                "invoiceNumbering": 0,
                "quoteNumbering": 0
              },
              "accountType": "default",
              "standardLoadingSize": 0
            }
          ]
        },
        "termsAndConditions": "string",
        "lastVersion": {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "name": "string",
          "description": "string",
          "buildNumber": 0,
          "version": "string",
          "permissions": [
            {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "read": true,
              "write": true,
              "delete": true,
              "permissionScope": "PUBLIC",
              "isObjectPermission": true
            }
          ],
          "approved": true
        },
        "versions": [
          {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "description": "string",
            "buildNumber": 0,
            "version": "string",
            "permissions": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "read": true,
                "write": true,
                "delete": true,
                "permissionScope": "PUBLIC",
                "isObjectPermission": true
              }
            ],
            "approved": true
          }
        ],
        "approved": true,
        "public": true
      }
    ],
    "disablingAt": "2019-08-24T14:15:22Z",
    "disabled": true,
    "inWaitList": true
  }'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
platformobject(PlatformModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "platform": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "nameSpace": "string",
    "logo": { … },
    "favicon": { … },
    "notificationLogo": { … },
    "fullLogo": { … },
    "backgroundImage": { … },
    "darkLogo": { … },
    "darkFavicon": { … },
    "darkNotificationLogo": { … },
    "darkFullLogo": { … },
    "darkBackgroundImage": { … },
    "primaryColor": "string",
    "secondaryColor": "string",
    "darkPrimaryColor": "string",
    "darkSecondaryColor": "string",
    "hostNames": [ … ],
    "features": [ … ],
    "planningSettings": { … },
    "pricingSettings": { … },
    "credentialSettings": { … },
    "routingSettings": { … },
    "translationSettings": { … },
    "uiSettings": { … },
    "canRegister": true,
    "canRequestAccess": true,
    "description": "string",
    "contactEmail": "string",
    "apps": [ … ],
    "disablingAt": "2019-08-24T14:15:22Z",
    "disabled": true,
    "inWaitList": true
  }
}

Get platform

Request

Get a platform on id

Path
idstringrequired
Headers
Authorizationstringrequired
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/platform/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
platformobject(PlatformModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "platform": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "nameSpace": "string",
    "logo": { … },
    "favicon": { … },
    "notificationLogo": { … },
    "fullLogo": { … },
    "backgroundImage": { … },
    "darkLogo": { … },
    "darkFavicon": { … },
    "darkNotificationLogo": { … },
    "darkFullLogo": { … },
    "darkBackgroundImage": { … },
    "primaryColor": "string",
    "secondaryColor": "string",
    "darkPrimaryColor": "string",
    "darkSecondaryColor": "string",
    "hostNames": [ … ],
    "features": [ … ],
    "planningSettings": { … },
    "pricingSettings": { … },
    "credentialSettings": { … },
    "routingSettings": { … },
    "translationSettings": { … },
    "uiSettings": { … },
    "canRegister": true,
    "canRequestAccess": true,
    "description": "string",
    "contactEmail": "string",
    "apps": [ … ],
    "disablingAt": "2019-08-24T14:15:22Z",
    "disabled": true,
    "inWaitList": true
  }
}

Delete platform

Request

Delete a platform

Path
idstringrequired
Headers
Authorizationstringrequired
curl -i -X DELETE \
  'https://docs.transportial.com/_mock/apis/platform/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
platformobject(PlatformModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "platform": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "nameSpace": "string",
    "logo": { … },
    "favicon": { … },
    "notificationLogo": { … },
    "fullLogo": { … },
    "backgroundImage": { … },
    "darkLogo": { … },
    "darkFavicon": { … },
    "darkNotificationLogo": { … },
    "darkFullLogo": { … },
    "darkBackgroundImage": { … },
    "primaryColor": "string",
    "secondaryColor": "string",
    "darkPrimaryColor": "string",
    "darkSecondaryColor": "string",
    "hostNames": [ … ],
    "features": [ … ],
    "planningSettings": { … },
    "pricingSettings": { … },
    "credentialSettings": { … },
    "routingSettings": { … },
    "translationSettings": { … },
    "uiSettings": { … },
    "canRegister": true,
    "canRequestAccess": true,
    "description": "string",
    "contactEmail": "string",
    "apps": [ … ],
    "disablingAt": "2019-08-24T14:15:22Z",
    "disabled": true,
    "inWaitList": true
  }
}

Get platforms

Request

Get list of platforms

Path
offsetinteger(int64)required
amountinteger(int64)required
Headers
Authorizationstringrequired
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/platforms/{offset}/{amount}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
totalResultsinteger(int32)
platformsArray of objects(PlatformModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "totalResults": 0,
  "platforms": [
    { … }
  ]
}

Get platforms

Request

Get list of platforms

Path
offsetinteger(int64)required
amountinteger(int64)required
Headers
Authorizationstringrequired
curl -i -X POST \
  'https://docs.transportial.com/_mock/apis/platforms/{offset}/{amount}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
totalResultsinteger(int32)
platformsArray of objects(PlatformModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "totalResults": 0,
  "platforms": [
    { … }
  ]
}

Update platform settings

Request

Update a platform's settings

Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
idstring
namestring
logoobject(File)
faviconobject(File)
notificationLogoobject(File)
fullLogoobject(File)
backgroundImageobject(File)
primaryColorstring
secondaryColorstring
darkPrimaryColorstring
darkSecondaryColorstring
businessobject(Business)
featuresArray of objects(PlatformFeature)
planningSettingsobject(PlatformPlanningSettings)
pricingSettingsobject(PlatformPricingSettings)
credentialSettingsobject(PlatformCredentialSettings)
routingSettingsobject(PlatformRoutingSettings)
translationSettingsobject(PlatformTranslationSettings)
curl -i -X PUT \
  https://docs.transportial.com/_mock/apis/platform/settings \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "name": "string",
    "logo": {
      "nonce": "string",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "favicon": {
      "nonce": "string",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "notificationLogo": {
      "nonce": "string",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "fullLogo": {
      "nonce": "string",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "backgroundImage": {
      "nonce": "string",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "primaryColor": "string",
    "secondaryColor": "string",
    "darkPrimaryColor": "string",
    "darkSecondaryColor": "string",
    "business": {
      "id": "string",
      "nonce": "string",
      "uuid": "string",
      "primaryPlatformId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "relationType": "string",
      "alias": "string",
      "description": "string",
      "transportLicenseNumber": "string",
      "eori": "string",
      "scacCode": "string",
      "industry": {
        "id": "string",
        "nonce": "string",
        "uuid": "string",
        "primaryPlatformId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "abbreviated": "string",
        "enabled": true
      },
      "website": "string",
      "coc": "string",
      "vat": "string",
      "verified": true,
      "documents": [
        {
          "associationType": "inline",
          "entity": {
            "nonce": "string",
            "description": "string",
            "expiresAt": "2019-08-24T14:15:22Z",
            "fileName": "string",
            "mimeType": "string",
            "encoding": "string",
            "verified": true,
            "content": {
              "contentType": "data",
              "data": "string"
            },
            "file": {
              "nonce": "string",
              "url": "string",
              "path": "string",
              "name": "string",
              "originalName": "string",
              "size": 0,
              "purpose": "string",
              "type": "IMAGE",
              "mimeType": "string",
              "extension": "string",
              "uploadedAt": "2019-08-24T14:15:22Z"
            },
            "externalAttributes": {
              "property1": {},
              "property2": {}
            },
            "name": "string"
          }
        }
      ],
      "logo": {
        "nonce": "string",
        "url": "string",
        "path": "string",
        "name": "string",
        "originalName": "string",
        "size": 0,
        "purpose": "string",
        "type": "IMAGE",
        "mimeType": "string",
        "extension": "string",
        "uploadedAt": "2019-08-24T14:15:22Z"
      },
      "banners": [
        {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "url": "string",
          "path": "string",
          "name": "string",
          "originalName": "string",
          "size": 0,
          "purpose": "string",
          "type": "IMAGE",
          "mimeType": "string",
          "extension": "string",
          "uploadedAt": "2019-08-24T14:15:22Z"
        }
      ],
      "locations": [
        {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "type": "warehouse",
          "name": "string",
          "unCode": "string",
          "geoReference": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "type": "addressGeoReference",
            "name": "string",
            "street": "string",
            "houseNumber": "string",
            "houseNumberAddition": "string",
            "postalCode": "string",
            "city": "string",
            "country": "string",
            "hash": "string"
          },
          "administrativeReference": {
            "name": "string",
            "street": "string",
            "houseNumber": "string",
            "houseNumberAddition": "string",
            "postalCode": "string",
            "city": "string",
            "country": "string"
          },
          "contactDetails": [
            {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "type": "iban",
              "value": "string",
              "remarks": "string"
            }
          ],
          "constraints": [
            {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "type": "accessConstraint",
              "name": "string",
              "enforceability": "enforced",
              "description": "string"
            }
          ],
          "pricingElements": [
            {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "description": "string",
              "category": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "creditCode": "string",
                "debitCode": "string",
                "defaultValue": 0.1,
                "enabled": true
              },
              "amount": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "amount": 0.1,
                "currency": {},
                "taxRate": {
                  "identifiers": []
                },
                "inclusiveOfTax": true
              }
            }
          ],
          "remark": "string",
          "hash": "string",
          "externalAttributes": {
            "property1": {},
            "property2": {}
          }
        }
      ],
      "identification": [
        {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "url": "string",
          "path": "string",
          "name": "string",
          "originalName": "string",
          "size": 0,
          "purpose": "string",
          "type": "IMAGE",
          "mimeType": "string",
          "extension": "string",
          "uploadedAt": "2019-08-24T14:15:22Z"
        }
      ],
      "contactDetails": [
        {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "type": "iban",
          "value": "string",
          "remarks": "string"
        }
      ],
      "contactPersons": [
        {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "firstName": "string",
          "lastName": "string",
          "position": "string",
          "email": "string",
          "phone": "string"
        }
      ],
      "administration": {
        "id": "string",
        "nonce": "string",
        "uuid": "string",
        "primaryPlatformId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "primary": true,
        "business": {},
        "currency": {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "name": "string",
          "short": "string",
          "sign": "string",
          "decimalDelimiter": "string",
          "thousandDelimiter": "string",
          "enabled": true
        },
        "balance": {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "amount": 0.1,
          "currency": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "short": "string",
            "sign": "string",
            "decimalDelimiter": "string",
            "thousandDelimiter": "string",
            "enabled": true
          },
          "taxRate": {
            "nonce": "string",
            "creditCode": "string",
            "debitCode": "string",
            "identifiers": [
              {
                "nonce": "string",
                "name": "string",
                "system": "string",
                "value": "string",
                "expiredAt": "2019-08-24T14:15:22Z"
              }
            ],
            "name": "string",
            "description": "string",
            "jurisdiction": "string",
            "percentage": 0.1,
            "inclusive": true,
            "active": true
          },
          "inclusiveOfTax": true
        },
        "numberFormat": "string",
        "numberLength": 0,
        "dueDays": 0,
        "invoiceNumberIndex": {
          "property1": 0,
          "property2": 0
        },
        "quoteNumberIndex": {
          "property1": 0,
          "property2": 0
        },
        "automaticallySendReminders": true,
        "invoiceTermsAndConditions": "string",
        "quoteTermsAndConditions": "string",
        "invoiceNumbering": 0,
        "quoteNumbering": 0
      },
      "pricingConfigurationCount": 0,
      "hasAgreedToPrice": true
    },
    "features": [
      {
        "name": "string"
      }
    ],
    "planningSettings": {
      "defaultDeliveryTerms": "EXW",
      "alwaysCombinedTransport": true,
      "finishTripOnActionsComplete": true,
      "loadActionDefaultDuration": 0,
      "unloadActionDefaultDuration": 0,
      "stopActionDefaultDuration": 0,
      "attachTransportEquipmentActionDefaultDuration": 0,
      "detachTransportEquipmentActionDefaultDuration": 0,
      "defaultTransportOrderTemplate": "string",
      "defaultTripStartDuration": 0
    },
    "pricingSettings": {
      "defaultChauffeurCostPricing": [
        {
          "nonce": "string",
          "type": "fixed",
          "name": "string",
          "sequenceNr": 0,
          "description": "string",
          "category": {
            "nonce": "string",
            "name": "string",
            "creditCode": "string",
            "debitCode": "string",
            "defaultValue": 0.1,
            "enabled": true
          },
          "taxRates": [
            {
              "nonce": "string",
              "sequenceNr": 0,
              "name": "string",
              "description": "string",
              "taxRate": {
                "nonce": "string",
                "creditCode": "string",
                "debitCode": "string",
                "identifiers": [
                  null
                ],
                "name": "string",
                "description": "string",
                "jurisdiction": "string",
                "percentage": 0.1,
                "inclusive": true,
                "active": true
              },
              "filters": [
                {
                  "filters": []
                }
              ]
            }
          ],
          "filters": [
            {
              "selector": "string",
              "comparisonType": "equal",
              "value": "string",
              "linkType": "and",
              "filters": [
                {
                  "filters": []
                }
              ],
              "sequenceNr": 0
            }
          ],
          "oncePerInvoice": true
        }
      ],
      "defaultVehicleCostPricing": [
        {
          "nonce": "string",
          "type": "fixed",
          "name": "string",
          "sequenceNr": 0,
          "description": "string",
          "category": {
            "nonce": "string",
            "name": "string",
            "creditCode": "string",
            "debitCode": "string",
            "defaultValue": 0.1,
            "enabled": true
          },
          "taxRates": [
            {
              "nonce": "string",
              "sequenceNr": 0,
              "name": "string",
              "description": "string",
              "taxRate": {
                "nonce": "string",
                "creditCode": "string",
                "debitCode": "string",
                "identifiers": [
                  null
                ],
                "name": "string",
                "description": "string",
                "jurisdiction": "string",
                "percentage": 0.1,
                "inclusive": true,
                "active": true
              },
              "filters": [
                {
                  "filters": []
                }
              ]
            }
          ],
          "filters": [
            {
              "selector": "string",
              "comparisonType": "equal",
              "value": "string",
              "linkType": "and",
              "filters": [
                {
                  "filters": []
                }
              ],
              "sequenceNr": 0
            }
          ],
          "oncePerInvoice": true
        }
      ]
    },
    "credentialSettings": {
      "force2FA": true,
      "stripeKey": "string",
      "stripePublicKey": "string",
      "ptvKey": "string",
      "ptvSecret": "string",
      "awsKey": "string",
      "awsSecret": "string",
      "googleApiKey": "string",
      "googleApiSecret": "string",
      "googleCaptchaKey": "string",
      "googleCaptchaSecret": "string"
    },
    "routingSettings": {
      "routingEngine": "transportial",
      "seaPassages": {
        "allowSuez": true,
        "allowPanama": true,
        "allowMalacca": true,
        "allowGibraltar": true,
        "allowDover": true,
        "allowBering": true,
        "allowMagellan": true,
        "allowBabelmandeb": true,
        "allowKiel": true,
        "allowCorinth": true,
        "allowNorthwest": true,
        "allowNortheast": true
      }
    },
    "translationSettings": {
      "languagesLabels": [
        {
          "language": "string",
          "labels": "string"
        }
      ]
    }
  }'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
platformobject(PlatformModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "platform": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "nameSpace": "string",
    "logo": { … },
    "favicon": { … },
    "notificationLogo": { … },
    "fullLogo": { … },
    "backgroundImage": { … },
    "darkLogo": { … },
    "darkFavicon": { … },
    "darkNotificationLogo": { … },
    "darkFullLogo": { … },
    "darkBackgroundImage": { … },
    "primaryColor": "string",
    "secondaryColor": "string",
    "darkPrimaryColor": "string",
    "darkSecondaryColor": "string",
    "hostNames": [ … ],
    "features": [ … ],
    "planningSettings": { … },
    "pricingSettings": { … },
    "credentialSettings": { … },
    "routingSettings": { … },
    "translationSettings": { … },
    "uiSettings": { … },
    "canRegister": true,
    "canRequestAccess": true,
    "description": "string",
    "contactEmail": "string",
    "apps": [ … ],
    "disablingAt": "2019-08-24T14:15:22Z",
    "disabled": true,
    "inWaitList": true
  }
}

SAML

SAML Configuration for Single-SignOn(SSO) establishment between Service-Provider(SP) and Identity-Provider(IDP)

Operations

Pricing

A pricing models the path going from one location to at least one other location.

Operations

Route

A route models the path going from one location to at least one other location.

Operations

Routing

Everything routing: meaning the routes from A-B supporting multiple modalities

Operations

ScheduleRoute

A scheduleRoute is a device that is able to measure a quantity in a certain unit, such as measuring the speed in km/h.

Operations

Sensor

A sensor is a device that is able to measure a quantity in a certain unit, such as measuring the speed in km/h.

Operations

Support

Support tickets are there to diagnose issues in the software or help users if they have a question

Operations

Tachograph

Tachograph methods

Operations

Team

A Team is a group of Vehicle's. Groups can be used to reference a list of vehicles without having to select each individual one.

Operations

Tender

Tenders can be stacked and constrain different activities in their context

Operations

Terminal

Terminals

Operations

ToDoComment

Object describing a geographic toDoComment. A toDoComment can either be a point or an area.

Operations

TQL

TQL stands for "Transportial Query Language". It's used to be able to run any query from a given JSON request

Operations

TransportOrder

The TransportOrder is the top-level entity to model a group of related consignments that might be transported separately, but need to be administered together.

Operations

Trip

A Trip is an aggregate entity that combines various entities to model visiting various locations, potentially doing one or multiple actions on each location, such as loading or unloading consignments. It is optionally coupled to a Vehicle that is/was driving this trip.

Operations

Type

Types

Operations

User

Users related to the platform and all actions required

Operations

User roles

The permissions grouped by a "Role", that can be assigned to a user

Operations

Settings

The user settings for the system

Operations

BoardComputer

A Boardcomputer is a device that tracks properties of a Vehicle. Values received from a BoardComputer can be the current location, speed, temperatues etc.

Operations

Vehicle

A Vehicle is a means to transport consignments from one location to potentially multiple other locations. There are various types of vehicles, each with their own unique properties like size, dimensions, fuel type and means of transport (by air, on land, over sea).

Operations

VehicleGroup

A VehicleGroup is a group of Vehicle's. Groups can be used to reference a list of vehicles without having to select each individual one.

Operations

Widget

Widgets can be stacked and constrain different activities in their context

Operations