Plantit-Transport 2.1.3

Accepts one of the following messages:

• #0Transport Order RequestOrder

  Ordering of a transport

  • application/json

  Message IDOrder

  Payload

  Expand all

  object

  inquiryId

  string

  uuid to correlate the to the corresponding order

  goodsName

  string

  short description of the goods

  freightWeight

  number

  weight of the freight in freightUnit

  freightUnit

  string

  quantity related unit of goods

  Allowed values:
  • "kg"
  • "ton"
  • "liter"
  • "m3"
  • "pcs"

  freightVolume

  number

  volume in m3 needed for the freight

  plannedLoading

  string

  format: date-time

  planned loading time of the transport

  loadingPoint

  Expand all

  object

  terminalType

  string

  Allowed values:
  • "warehouse"
  • "terminal"
  • "gate"
  • "openfield"

  location

  Expand all

  object

  longitude

  number

  longitude of location

  latitude

  number

  latitude of location

  siteSpecifics

  string

  specific instruction at site

  Additional properties are allowed.

  reference

  string

  reference for checking in/out at the terminal. can be empty

  Additional properties are allowed.

  plannedUnloading

  string

  format: date-time

  planned unloading time of the transport

  unloadingPoint

  Expand all

  object

  terminalType

  string

  Allowed values:
  • "warehouse"
  • "terminal"
  • "gate"
  • "openfield"

  location

  Expand all

  object

  longitude

  number

  longitude of location

  latitude

  number

  latitude of location

  siteSpecifics

  string

  specific instruction at site

  Additional properties are allowed.

  reference

  string

  reference for checking in/out at the terminal. can be empty

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "inquiryId": "string",
    "goodsName": "string",
    "freightWeight": 0,
    "freightUnit": "kg",
    "freightVolume": 0,
    "plannedLoading": "2019-08-24T14:15:22Z",
    "loadingPoint": {
      "terminalType": "warehouse",
      "location": {
        "longitude": 0,
        "latitude": 0,
        "siteSpecifics": "string"
      },
      "reference": "string"
    },
    "plannedUnloading": "2019-08-24T14:15:22Z",
    "unloadingPoint": {
      "terminalType": "warehouse",
      "location": {
        "longitude": 0,
        "latitude": 0,
        "siteSpecifics": "string"
      },
      "reference": "string"
    }
  }
  

  This example has been generated automatically.

• #1Transport Cancellation RequestCancellation

  Cancels a previous transport order

  • application/json

  Message IDCancellation

  Payload

  Expand all

  object

  transportId

  string

  transport id of the order

  transportStatus

  string

  Default value:"undefined"

  Allowed values:
  • "unavailable"
  • "ordered"
  • "cancelled"
  • "loaded"
  • "driving"
  • "holding"
  • "unloaded"
  • "complete"
  • "undefined"

  inquiryId

  string

  uuid to correlate to corresponding order

  reason

  string

  reason the transport order was cancelled

  Additional properties are allowed.

  Examples

  Payload

  {
    "transportId": "string",
    "transportStatus": "unavailable",
    "inquiryId": "string",
    "reason": "string"
  }
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Transport Order RequestOrder

  Ordering of a transport

  • application/json

  Message IDOrder

  Payload

  Expand all

  object

  inquiryId

  string

  uuid to correlate the to the corresponding order

  goodsName

  string

  short description of the goods

  freightWeight

  number

  weight of the freight in freightUnit

  freightUnit

  string

  quantity related unit of goods

  Allowed values:
  • "kg"
  • "ton"
  • "liter"
  • "m3"
  • "pcs"

  freightVolume

  number

  volume in m3 needed for the freight

  plannedLoading

  string

  format: date-time

  planned loading time of the transport

  loadingPoint

  Expand all

  object

  terminalType

  string

  Allowed values:
  • "warehouse"
  • "terminal"
  • "gate"
  • "openfield"

  location

  Expand all

  object

  longitude

  number

  longitude of location

  latitude

  number

  latitude of location

  siteSpecifics

  string

  specific instruction at site

  Additional properties are allowed.

  reference

  string

  reference for checking in/out at the terminal. can be empty

  Additional properties are allowed.

  plannedUnloading

  string

  format: date-time

  planned unloading time of the transport

  unloadingPoint

  Expand all

  object

  terminalType

  string

  Allowed values:
  • "warehouse"
  • "terminal"
  • "gate"
  • "openfield"

  location

  Expand all

  object

  longitude

  number

  longitude of location

  latitude

  number

  latitude of location

  siteSpecifics

  string

  specific instruction at site

  Additional properties are allowed.

  reference

  string

  reference for checking in/out at the terminal. can be empty

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "inquiryId": "string",
    "goodsName": "string",
    "freightWeight": 0,
    "freightUnit": "kg",
    "freightVolume": 0,
    "plannedLoading": "2019-08-24T14:15:22Z",
    "loadingPoint": {
      "terminalType": "warehouse",
      "location": {
        "longitude": 0,
        "latitude": 0,
        "siteSpecifics": "string"
      },
      "reference": "string"
    },
    "plannedUnloading": "2019-08-24T14:15:22Z",
    "unloadingPoint": {
      "terminalType": "warehouse",
      "location": {
        "longitude": 0,
        "latitude": 0,
        "siteSpecifics": "string"
      },
      "reference": "string"
    }
  }
  

  This example has been generated automatically.

• #1Transport Cancellation RequestCancellation

  Cancels a previous transport order

  • application/json

  Message IDCancellation

  Payload

  Expand all

  object

  transportId

  string

  transport id of the order

  transportStatus

  string

  Default value:"undefined"

  Allowed values:
  • "unavailable"
  • "ordered"
  • "cancelled"
  • "loaded"
  • "driving"
  • "holding"
  • "unloaded"
  • "complete"
  • "undefined"

  inquiryId

  string

  uuid to correlate to corresponding order

  reason

  string

  reason the transport order was cancelled

  Additional properties are allowed.

  Examples

  Payload

  {
    "transportId": "string",
    "transportStatus": "unavailable",
    "inquiryId": "string",
    "reason": "string"
  }
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0Transport Order RequestOrder

  Ordering of a transport

  • application/json

  Message IDOrder

  Payload

  Expand all

  object

  inquiryId

  string

  uuid to correlate the to the corresponding order

  goodsName

  string

  short description of the goods

  freightWeight

  number

  weight of the freight in freightUnit

  freightUnit

  string

  quantity related unit of goods

  Allowed values:
  • "kg"
  • "ton"
  • "liter"
  • "m3"
  • "pcs"

  freightVolume

  number

  volume in m3 needed for the freight

  plannedLoading

  string

  format: date-time

  planned loading time of the transport

  loadingPoint

  Expand all

  object

  terminalType

  string

  Allowed values:
  • "warehouse"
  • "terminal"
  • "gate"
  • "openfield"

  location

  Expand all

  object

  longitude

  number

  longitude of location

  latitude

  number

  latitude of location

  siteSpecifics

  string

  specific instruction at site

  Additional properties are allowed.

  reference

  string

  reference for checking in/out at the terminal. can be empty

  Additional properties are allowed.

  plannedUnloading

  string

  format: date-time

  planned unloading time of the transport

  unloadingPoint

  Expand all

  object

  terminalType

  string

  Allowed values:
  • "warehouse"
  • "terminal"
  • "gate"
  • "openfield"

  location

  Expand all

  object

  longitude

  number

  longitude of location

  latitude

  number

  latitude of location

  siteSpecifics

  string

  specific instruction at site

  Additional properties are allowed.

  reference

  string

  reference for checking in/out at the terminal. can be empty

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "inquiryId": "string",
    "goodsName": "string",
    "freightWeight": 0,
    "freightUnit": "kg",
    "freightVolume": 0,
    "plannedLoading": "2019-08-24T14:15:22Z",
    "loadingPoint": {
      "terminalType": "warehouse",
      "location": {
        "longitude": 0,
        "latitude": 0,
        "siteSpecifics": "string"
      },
      "reference": "string"
    },
    "plannedUnloading": "2019-08-24T14:15:22Z",
    "unloadingPoint": {
      "terminalType": "warehouse",
      "location": {
        "longitude": 0,
        "latitude": 0,
        "siteSpecifics": "string"
      },
      "reference": "string"
    }
  }
  

  This example has been generated automatically.

• #1Transport Cancellation RequestCancellation

  Cancels a previous transport order

  • application/json

  Message IDCancellation

  Payload

  Expand all

  object

  transportId

  string

  transport id of the order

  transportStatus

  string

  Default value:"undefined"

  Allowed values:
  • "unavailable"
  • "ordered"
  • "cancelled"
  • "loaded"
  • "driving"
  • "holding"
  • "unloaded"
  • "complete"
  • "undefined"

  inquiryId

  string

  uuid to correlate to corresponding order

  reason

  string

  reason the transport order was cancelled

  Additional properties are allowed.

  Examples

  Payload

  {
    "transportId": "string",
    "transportStatus": "unavailable",
    "inquiryId": "string",
    "reason": "string"
  }
  

  This example has been generated automatically.