Plantit-Common 2.1.3

Accepts one of the following messages:

• #0Greenhouse emitted status events

  Status changes emitted by the greenhouse

  • application/json

  Payload

  Expand all

  object

  eventId

  string

  unique id of event typically UUID

  eventType

  string

  unique name built as _

  eventTime

  string

  format: date-time

  date/time the event was issued

  reference

  string

  planting id of the reservation or order

  externalRef

  string

  uuid to correlate to the to corresponding reservation or order

  siteName

  string

  Name of the greenhouse location

  deliveryStatus

  string

  Default value:"undefined"

  Allowed values:
  • "unavailable"
  • "reserved"
  • "ordered"
  • "cancelled"
  • "planted"
  • "growing"
  • "harvested"
  • "depraved"
  • "delivered"
  • "complete"
  • "undefined"

  estimatedDelivery

  string

  format: date-time

  date and time when goods are expected to be delivered

  latestInfo

  string

  latest information to the reservation or order

  Additional properties are allowed.

  Examples

  Payload

  {
    "eventId": "string",
    "eventType": "string",
    "eventTime": "2019-08-24T14:15:22Z",
    "reference": "string",
    "externalRef": "string",
    "siteName": "string",
    "deliveryStatus": "unavailable",
    "estimatedDelivery": "2019-08-24T14:15:22Z",
    "latestInfo": "string"
  }
  

  This example has been generated automatically.

• #1Transport Status Event

  a status and location of the refered transport

  • application/json

  Payload

  Expand all

  object

  eventId

  string

  unique id of event typically UUID

  eventType

  string

  unique name built as TRANSPORT_

  eventTime

  string

  format: date-time

  date/time the event was issued

  transportId

  string

  transport id of the order

  transportStatus

  string

  Default value:"undefined"

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

  externalRef

  string

  uuid to correlate to the to corresponding customer order

  currentLocation

  Expand all

  object

  longitude

  number

  longitude of location

  latitude

  number

  latitude of location

  siteSpecifics

  string

  specific instruction at site

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "eventId": "string",
    "eventType": "string",
    "eventTime": "2019-08-24T14:15:22Z",
    "transportId": "string",
    "transportStatus": "unavailable",
    "externalRef": "string",
    "currentLocation": {
      "longitude": 0,
      "latitude": 0,
      "siteSpecifics": "string"
    }
  }
  

  This example has been generated automatically.

• #2Warehouse Status Event

  a status and location of the refered stock place

  • application/json

  Payload

  Expand all

  object

  eventId

  string

  unique id of event typically UUID

  eventType

  string

  unique name built as STOCK_

  eventTime

  string

  format: date-time

  date/time the event was issued

  stockId

  string

  stock id of the order

  stockStatus

  string

  Default value:"undefined"

  Allowed values:
  • "unavailable"
  • "reserved"
  • "cancelled"
  • "occupied"
  • "checkout"
  • "complete"
  • "undefined"

  externalRef

  string

  uuid to correlate to the to corresponding customer order

  Additional properties are allowed.

  Examples

  Payload

  {
    "eventId": "string",
    "eventType": "string",
    "eventTime": "2019-08-24T14:15:22Z",
    "stockId": "string",
    "stockStatus": "unavailable",
    "externalRef": "string"
  }
  

  This example has been generated automatically.

• #3Planning emitted status events

  Status changes emitted by the planning

  • application/json

  Payload

  Expand all

  object

  eventId

  string

  unique id of event typically UUID

  eventType

  string

  unique name built as _

  eventTime

  string

  format: date-time

  date/time the event was issued

  reference

  string

  planting id of the reservation or order

  externalRef

  string

  uuid to correlate to the to corresponding reservation or order

  deliveryStatus

  string

  Default value:"undefined"

  Allowed values:
  • "unavailable"
  • "reserved"
  • "ordered"
  • "cancelled"
  • "planted"
  • "growing"
  • "harvested"
  • "depraved"
  • "loaded"
  • "moving"
  • "unloaded"
  • "delivered"
  • "undefined"

  estimatedDelivery

  string

  format: date-time

  date and time when goods are expected to be delivered

  latestInfo

  string

  latest information to the reservation or order

  Additional properties are allowed.

  Examples

  Payload

  {
    "eventId": "string",
    "eventType": "string",
    "eventTime": "2019-08-24T14:15:22Z",
    "reference": "string",
    "externalRef": "string",
    "deliveryStatus": "unavailable",
    "estimatedDelivery": "2019-08-24T14:15:22Z",
    "latestInfo": "string"
  }
  

  This example has been generated automatically.