Plantit-Planning 2.1.5 documentation

Plantit-Planning 2.1.5

Apache 2.0
application/json
External Docs
Andres Koch
plantit@kochse.ch
ID: https://ch.kochse/educ/plantit/planning/api

Manages reservations and orders and dispatches the production and transport

Servers

amqp://tcp://masse-mq.dynu.net:62616/amqpproduction
message broker for MAS/SE ADS exercise

Operations

RECEIVE Q.plantit.prod.planning.{grpid}
Operation IDreserve
Available only on servers:
- production
object
description
required
string
Accepts one of the following messages:
- #0Planning Reservation RequestReservation
  Requests for a reservation for delivery specific products
  application/json
  Message IDReservation
  object
  Request which defines a reservation for producing a specific product for delivery including transport to a desired location
  
  inquiryId
  string
  uuid to correlate the reservation to the corresponding order
  
  customerId
  string
  Customer reference for who the reservation is designated
  
  productId
  string
  product identifier
  
  productname
  string
  short description such as name of the product
  
  unit
  string
  quantity related unit of product
  
  Allowed values:
  "kg"
  "ton"
  "liter"
  "m3"
  "pcs"
  plannedDelivery
  string
  format: date-time
  requested delivery date of the required or minimal quantity of the product
  
  requiredQty
  number
  requested quantity of product to grow and deliver
  
  minimalQty
  number
  minimal quantity to reserve in case the complete quatity cannot be covered.
  
  object
  longitude
  required
  number
  longitude of location
  
  latitude
  required
  number
  latitude of location
  
  siteSpecifics
  string
  specific instruction at site
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "inquiryId": "string", "customerId": "string", "productId": "string", "productname": "string", "unit": "kg", "plannedDelivery": "2019-08-24T14:15:22Z", "requiredQty": 0, "minimalQty": 0, "deliveryLocation": { "longitude": 0, "latitude": 0, "siteSpecifics": "string" } }
  
  This example has been generated automatically.
- #1Planning Order or Reservation CancellationCancellation
  Request to cancel a previous reservation or an order
  application/json
  Message IDCancellation
  object
  planningId
  string
  id of the reservation or order
  
  inquiryId
  string
  uuid to correlate the reservation to corresponding order
  
  reason
  string
  reason for the cancellation
  
  Additional properties are allowed.
  Examples
  { "planningId": "string", "inquiryId": "string", "reason": "string" }
  
  This example has been generated automatically.
- #2Planning Order RequestOrder
  Definitive order or change of a reservation to an order
  application/json
  Message IDOrder
  object
  reservationId
  string
  reservation id of the reservation of the supplier
  
  inquiryId
  string
  uuid to correlate the reservation to the corresponding order
  
  customerId
  string
  Customer reference for who the reservation is designated
  
  productId
  string
  product identifier
  
  productname
  string
  short description such as name of the product
  
  unit
  string
  quantity related unit of product
  
  Allowed values:
  "kg"
  "ton"
  "liter"
  "m3"
  "pcs"
  plannedDelivery
  string
  format: date-time
  requested delivery date of the required or minimal quantity of the product
  
  orderedQty
  number
  requested quantity of product to grow and deliver. This quantity has to be the same or less than the reserved quanity
  
  object
  longitude
  required
  number
  longitude of location
  
  latitude
  required
  number
  latitude of location
  
  siteSpecifics
  string
  specific instruction at site
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "reservationId": "string", "inquiryId": "string", "customerId": "string", "productId": "string", "productname": "string", "unit": "kg", "plannedDelivery": "2019-08-24T14:15:22Z", "orderedQty": 0, "deliveryLocation": { "longitude": 0, "latitude": 0, "siteSpecifics": "string" } }
  
  This example has been generated automatically.
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
Planning Reservation Response
response to a reservation request for delivery specific products
application/json
object
reservationId
string
reservation id of the reservation

inquiryId
string
uuid to correlate the reservation to corresponding order

reservationStatus
string
Default value:"undefined"
Allowed values:
"unavailable"
"reserved"
"ordered"
"cancelled"
"planted"
"growing"
"harvested"
"depraved"
"loaded"
"moving"
"unloaded"
"delivered"
"undefined"
productId
string
product identifier

productname
string
short description such as name of the product

expectedDelivery
string
format: date-time
expected delivery date of the reserved quantity of the product

unit
string
quantity related unit of product

Allowed values:
"kg"
"ton"
"liter"
"m3"
"pcs"
reservedQty
number
effectively reserved quanity. 0 means minimalQty cannot be satisfied

object
responseCode
integer
Error code 0 = success <0 error codes >0 completion: code

responseMessage
string
individual human readable completion: message

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "reservationId": "string", "inquiryId": "string", "reservationStatus": "unavailable", "productId": "string", "productname": "string", "expectedDelivery": "2019-08-24T14:15:22Z", "unit": "kg", "reservedQty": 0, "completion": { "responseCode": 0, "responseMessage": "string" } }

This example has been generated automatically.
RECEIVE Q.plantit.prod.planning.{grpid}
Operation IDcancel
Available only on servers:
- production
object
description
required
string
Accepts one of the following messages:
- #0Planning Reservation RequestReservation
  Requests for a reservation for delivery specific products
  application/json
  Message IDReservation
  object
  Request which defines a reservation for producing a specific product for delivery including transport to a desired location
  
  inquiryId
  string
  uuid to correlate the reservation to the corresponding order
  
  customerId
  string
  Customer reference for who the reservation is designated
  
  productId
  string
  product identifier
  
  productname
  string
  short description such as name of the product
  
  unit
  string
  quantity related unit of product
  
  Allowed values:
  "kg"
  "ton"
  "liter"
  "m3"
  "pcs"
  plannedDelivery
  string
  format: date-time
  requested delivery date of the required or minimal quantity of the product
  
  requiredQty
  number
  requested quantity of product to grow and deliver
  
  minimalQty
  number
  minimal quantity to reserve in case the complete quatity cannot be covered.
  
  object
  longitude
  required
  number
  longitude of location
  
  latitude
  required
  number
  latitude of location
  
  siteSpecifics
  string
  specific instruction at site
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "inquiryId": "string", "customerId": "string", "productId": "string", "productname": "string", "unit": "kg", "plannedDelivery": "2019-08-24T14:15:22Z", "requiredQty": 0, "minimalQty": 0, "deliveryLocation": { "longitude": 0, "latitude": 0, "siteSpecifics": "string" } }
  
  This example has been generated automatically.
- #1Planning Order or Reservation CancellationCancellation
  Request to cancel a previous reservation or an order
  application/json
  Message IDCancellation
  object
  planningId
  string
  id of the reservation or order
  
  inquiryId
  string
  uuid to correlate the reservation to corresponding order
  
  reason
  string
  reason for the cancellation
  
  Additional properties are allowed.
  Examples
  { "planningId": "string", "inquiryId": "string", "reason": "string" }
  
  This example has been generated automatically.
- #2Planning Order RequestOrder
  Definitive order or change of a reservation to an order
  application/json
  Message IDOrder
  object
  reservationId
  string
  reservation id of the reservation of the supplier
  
  inquiryId
  string
  uuid to correlate the reservation to the corresponding order
  
  customerId
  string
  Customer reference for who the reservation is designated
  
  productId
  string
  product identifier
  
  productname
  string
  short description such as name of the product
  
  unit
  string
  quantity related unit of product
  
  Allowed values:
  "kg"
  "ton"
  "liter"
  "m3"
  "pcs"
  plannedDelivery
  string
  format: date-time
  requested delivery date of the required or minimal quantity of the product
  
  orderedQty
  number
  requested quantity of product to grow and deliver. This quantity has to be the same or less than the reserved quanity
  
  object
  longitude
  required
  number
  longitude of location
  
  latitude
  required
  number
  latitude of location
  
  siteSpecifics
  string
  specific instruction at site
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "reservationId": "string", "inquiryId": "string", "customerId": "string", "productId": "string", "productname": "string", "unit": "kg", "plannedDelivery": "2019-08-24T14:15:22Z", "orderedQty": 0, "deliveryLocation": { "longitude": 0, "latitude": 0, "siteSpecifics": "string" } }
  
  This example has been generated automatically.
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
Response Cancellation Order or Reservation
Response of a cancellation of a previous reservation or an order
application/json
object
planningId
string
id of the reservation or order

inquiryId
string
uuid to correlate the reservation to corresponding order

cancellationStatus
string
Default value:"undefined"
Allowed values:
"unavailable"
"reserved"
"ordered"
"cancelled"
"planted"
"growing"
"harvested"
"depraved"
"loaded"
"moving"
"unloaded"
"delivered"
"undefined"
object
responseCode
integer
Error code 0 = success <0 error codes >0 completion: code

responseMessage
string
individual human readable completion: message

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "planningId": "string", "inquiryId": "string", "cancellationStatus": "unavailable", "completion": { "responseCode": 0, "responseMessage": "string" } }

This example has been generated automatically.
RECEIVE Q.plantit.prod.planning.{grpid}
Operation IDorder
Available only on servers:
- production
object
description
required
string
Accepts one of the following messages:
- #0Planning Reservation RequestReservation
  Requests for a reservation for delivery specific products
  application/json
  Message IDReservation
  object
  Request which defines a reservation for producing a specific product for delivery including transport to a desired location
  
  inquiryId
  string
  uuid to correlate the reservation to the corresponding order
  
  customerId
  string
  Customer reference for who the reservation is designated
  
  productId
  string
  product identifier
  
  productname
  string
  short description such as name of the product
  
  unit
  string
  quantity related unit of product
  
  Allowed values:
  "kg"
  "ton"
  "liter"
  "m3"
  "pcs"
  plannedDelivery
  string
  format: date-time
  requested delivery date of the required or minimal quantity of the product
  
  requiredQty
  number
  requested quantity of product to grow and deliver
  
  minimalQty
  number
  minimal quantity to reserve in case the complete quatity cannot be covered.
  
  object
  longitude
  required
  number
  longitude of location
  
  latitude
  required
  number
  latitude of location
  
  siteSpecifics
  string
  specific instruction at site
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "inquiryId": "string", "customerId": "string", "productId": "string", "productname": "string", "unit": "kg", "plannedDelivery": "2019-08-24T14:15:22Z", "requiredQty": 0, "minimalQty": 0, "deliveryLocation": { "longitude": 0, "latitude": 0, "siteSpecifics": "string" } }
  
  This example has been generated automatically.
- #1Planning Order or Reservation CancellationCancellation
  Request to cancel a previous reservation or an order
  application/json
  Message IDCancellation
  object
  planningId
  string
  id of the reservation or order
  
  inquiryId
  string
  uuid to correlate the reservation to corresponding order
  
  reason
  string
  reason for the cancellation
  
  Additional properties are allowed.
  Examples
  { "planningId": "string", "inquiryId": "string", "reason": "string" }
  
  This example has been generated automatically.
- #2Planning Order RequestOrder
  Definitive order or change of a reservation to an order
  application/json
  Message IDOrder
  object
  reservationId
  string
  reservation id of the reservation of the supplier
  
  inquiryId
  string
  uuid to correlate the reservation to the corresponding order
  
  customerId
  string
  Customer reference for who the reservation is designated
  
  productId
  string
  product identifier
  
  productname
  string
  short description such as name of the product
  
  unit
  string
  quantity related unit of product
  
  Allowed values:
  "kg"
  "ton"
  "liter"
  "m3"
  "pcs"
  plannedDelivery
  string
  format: date-time
  requested delivery date of the required or minimal quantity of the product
  
  orderedQty
  number
  requested quantity of product to grow and deliver. This quantity has to be the same or less than the reserved quanity
  
  object
  longitude
  required
  number
  longitude of location
  
  latitude
  required
  number
  latitude of location
  
  siteSpecifics
  string
  specific instruction at site
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "reservationId": "string", "inquiryId": "string", "customerId": "string", "productId": "string", "productname": "string", "unit": "kg", "plannedDelivery": "2019-08-24T14:15:22Z", "orderedQty": 0, "deliveryLocation": { "longitude": 0, "latitude": 0, "siteSpecifics": "string" } }
  
  This example has been generated automatically.
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
Planning Order Response
Response of a definitive order or change of a reservation to an order
application/json
object
orderId
string
id of the reservation or order

inquiryId
string
uuid to correlate the reservation to corresponding order

orderStatus
string
Default value:"undefined"
Allowed values:
"unavailable"
"reserved"
"ordered"
"cancelled"
"planted"
"growing"
"harvested"
"depraved"
"loaded"
"moving"
"unloaded"
"delivered"
"undefined"
productId
string
product identifier

productname
string
short description such as name of the product

expectedDelivery
string
format: date-time
expected delivery date of the amount of the product

orderedQty
number
requested quantity of product to grow and deliver

unit
string
quantity related unit of product

Allowed values:
"kg"
"ton"
"liter"
"m3"
"pcs"
object
responseCode
integer
Error code 0 = success <0 error codes >0 completion: code

responseMessage
string
individual human readable completion: message

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "orderId": "string", "inquiryId": "string", "orderStatus": "unavailable", "productId": "string", "productname": "string", "expectedDelivery": "2019-08-24T14:15:22Z", "orderedQty": 0, "unit": "kg", "completion": { "responseCode": 0, "responseMessage": "string" } }

This example has been generated automatically.
RECEIVE Q.plantit.prod.planning.{grpid}
Operation IDnotify
Available only on servers:
- production
object
description
required
string
Accepts one of the following messages:
- #0Planning Reservation RequestReservation
  Requests for a reservation for delivery specific products
  application/json
  Message IDReservation
  object
  Request which defines a reservation for producing a specific product for delivery including transport to a desired location
  
  inquiryId
  string
  uuid to correlate the reservation to the corresponding order
  
  customerId
  string
  Customer reference for who the reservation is designated
  
  productId
  string
  product identifier
  
  productname
  string
  short description such as name of the product
  
  unit
  string
  quantity related unit of product
  
  Allowed values:
  "kg"
  "ton"
  "liter"
  "m3"
  "pcs"
  plannedDelivery
  string
  format: date-time
  requested delivery date of the required or minimal quantity of the product
  
  requiredQty
  number
  requested quantity of product to grow and deliver
  
  minimalQty
  number
  minimal quantity to reserve in case the complete quatity cannot be covered.
  
  object
  longitude
  required
  number
  longitude of location
  
  latitude
  required
  number
  latitude of location
  
  siteSpecifics
  string
  specific instruction at site
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "inquiryId": "string", "customerId": "string", "productId": "string", "productname": "string", "unit": "kg", "plannedDelivery": "2019-08-24T14:15:22Z", "requiredQty": 0, "minimalQty": 0, "deliveryLocation": { "longitude": 0, "latitude": 0, "siteSpecifics": "string" } }
  
  This example has been generated automatically.
- #1Planning Order or Reservation CancellationCancellation
  Request to cancel a previous reservation or an order
  application/json
  Message IDCancellation
  object
  planningId
  string
  id of the reservation or order
  
  inquiryId
  string
  uuid to correlate the reservation to corresponding order
  
  reason
  string
  reason for the cancellation
  
  Additional properties are allowed.
  Examples
  { "planningId": "string", "inquiryId": "string", "reason": "string" }
  
  This example has been generated automatically.
- #2Planning Order RequestOrder
  Definitive order or change of a reservation to an order
  application/json
  Message IDOrder
  object
  reservationId
  string
  reservation id of the reservation of the supplier
  
  inquiryId
  string
  uuid to correlate the reservation to the corresponding order
  
  customerId
  string
  Customer reference for who the reservation is designated
  
  productId
  string
  product identifier
  
  productname
  string
  short description such as name of the product
  
  unit
  string
  quantity related unit of product
  
  Allowed values:
  "kg"
  "ton"
  "liter"
  "m3"
  "pcs"
  plannedDelivery
  string
  format: date-time
  requested delivery date of the required or minimal quantity of the product
  
  orderedQty
  number
  requested quantity of product to grow and deliver. This quantity has to be the same or less than the reserved quanity
  
  object
  longitude
  required
  number
  longitude of location
  
  latitude
  required
  number
  latitude of location
  
  siteSpecifics
  string
  specific instruction at site
  
  Additional properties are allowed.
  Additional properties are allowed.
  Examples
  { "reservationId": "string", "inquiryId": "string", "customerId": "string", "productId": "string", "productname": "string", "unit": "kg", "plannedDelivery": "2019-08-24T14:15:22Z", "orderedQty": 0, "deliveryLocation": { "longitude": 0, "latitude": 0, "siteSpecifics": "string" } }
  
  This example has been generated automatically.
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be directed to the address specified at this location: $message.header#/replyTo
REPLY address information
REPLY will be sent to the address provided in:$message.header#/replyTo
Planning Goods Ready Notification
Notification of the delivery of the ordered products
application/json
object
orderId
string
order id of the order

inquiryId
string
uuid to correlate to the to corresponding reservation or order

array<object>
one or more (in case of partial production) delivery location where the goods can be picked up

deliveryStatus
string
Default value:"undefined"
Allowed values:
"unavailable"
"reserved"
"ordered"
"cancelled"
"planted"
"growing"
"harvested"
"depraved"
"loaded"
"moving"
"unloaded"
"delivered"
"undefined"
shareAmount
integer
[ 0 .. 100 ]
Share of delivery in %. Partial 1..99% full delivery 100%

object
longitude
required
number
longitude of location

latitude
required
number
latitude of location

siteSpecifics
string
specific instruction at site

Additional properties are allowed.
storageRef
string
reference at the storage location to pickup and access the goods

deliveryDate
string
format: date-time
time when goods can be picked up

info
string
additional information about the delivered goods

Additional properties are allowed.
Examples
{ "orderId": "string", "inquiryId": "string", "deliveryShares": [ { "deliveryStatus": "unavailable", "shareAmount": 100, "deliveryLocation": { "longitude": 0, "latitude": 0, "siteSpecifics": "string" }, "storageRef": "string" } ], "deliveryDate": "2019-08-24T14:15:22Z", "info": "string" }

This example has been generated automatically.

Messages

#1Planning Reservation RequestPlanningReservationReqMsg
Requests for a reservation for delivery specific products
- application/json
Message IDPlanningReservationReqMsg
object
Request which defines a reservation for producing a specific product for delivery including transport to a desired location

inquiryId
string
uuid to correlate the reservation to the corresponding order

customerId
string
Customer reference for who the reservation is designated

productId
string
product identifier

productname
string
short description such as name of the product

unit
string
quantity related unit of product

Allowed values:
"kg"
"ton"
"liter"
"m3"
"pcs"
plannedDelivery
string
format: date-time
requested delivery date of the required or minimal quantity of the product

requiredQty
number
requested quantity of product to grow and deliver

minimalQty
number
minimal quantity to reserve in case the complete quatity cannot be covered.

object
longitude
required
number
longitude of location

latitude
required
number
latitude of location

siteSpecifics
string
specific instruction at site

Additional properties are allowed.
Additional properties are allowed.
#2Planning Reservation ResponsePlanningReservationRspMsg
response to a reservation request for delivery specific products
- application/json
Message IDPlanningReservationRspMsg
object
reservationId
string
reservation id of the reservation

inquiryId
string
uuid to correlate the reservation to corresponding order

reservationStatus
string
Default value:"undefined"
Allowed values:
"unavailable"
"reserved"
"ordered"
"cancelled"
"planted"
"growing"
"harvested"
"depraved"
"loaded"
"moving"
"unloaded"
"delivered"
"undefined"
productId
string
product identifier

productname
string
short description such as name of the product

expectedDelivery
string
format: date-time
expected delivery date of the reserved quantity of the product

unit
string
quantity related unit of product

Allowed values:
"kg"
"ton"
"liter"
"m3"
"pcs"
reservedQty
number
effectively reserved quanity. 0 means minimalQty cannot be satisfied

object
responseCode
integer
Error code 0 = success <0 error codes >0 completion: code

responseMessage
string
individual human readable completion: message

Additional properties are allowed.
Additional properties are allowed.
#3Planning Order RequestPlanningOrderReqMsg
Definitive order or change of a reservation to an order
- application/json
Message IDPlanningOrderReqMsg
object
reservationId
string
reservation id of the reservation of the supplier

inquiryId
string
uuid to correlate the reservation to the corresponding order

customerId
string
Customer reference for who the reservation is designated

productId
string
product identifier

productname
string
short description such as name of the product

unit
string
quantity related unit of product

Allowed values:
"kg"
"ton"
"liter"
"m3"
"pcs"
plannedDelivery
string
format: date-time
requested delivery date of the required or minimal quantity of the product

orderedQty
number
requested quantity of product to grow and deliver. This quantity has to be the same or less than the reserved quanity

object
longitude
required
number
longitude of location

latitude
required
number
latitude of location

siteSpecifics
string
specific instruction at site

Additional properties are allowed.
Additional properties are allowed.
#4Planning Order ResponsePlanningOrderRspMsg
Response of a definitive order or change of a reservation to an order
- application/json
Message IDPlanningOrderRspMsg
object
orderId
string
id of the reservation or order

inquiryId
string
uuid to correlate the reservation to corresponding order

orderStatus
string
Default value:"undefined"
Allowed values:
"unavailable"
"reserved"
"ordered"
"cancelled"
"planted"
"growing"
"harvested"
"depraved"
"loaded"
"moving"
"unloaded"
"delivered"
"undefined"
productId
string
product identifier

productname
string
short description such as name of the product

expectedDelivery
string
format: date-time
expected delivery date of the amount of the product

orderedQty
number
requested quantity of product to grow and deliver

unit
string
quantity related unit of product

Allowed values:
"kg"
"ton"
"liter"
"m3"
"pcs"
object
responseCode
integer
Error code 0 = success <0 error codes >0 completion: code

responseMessage
string
individual human readable completion: message

Additional properties are allowed.
Additional properties are allowed.
#5Planning Order or Reservation CancellationPlanningCancellationReqMsg
Request to cancel a previous reservation or an order
- application/json
Message IDPlanningCancellationReqMsg
object
planningId
string
id of the reservation or order

inquiryId
string
uuid to correlate the reservation to corresponding order

reason
string
reason for the cancellation

Additional properties are allowed.
#6Response Cancellation Order or ReservationPlanningCancellationRspMsg
Response of a cancellation of a previous reservation or an order
- application/json
Message IDPlanningCancellationRspMsg
object
planningId
string
id of the reservation or order

inquiryId
string
uuid to correlate the reservation to corresponding order

cancellationStatus
string
Default value:"undefined"
Allowed values:
"unavailable"
"reserved"
"ordered"
"cancelled"
"planted"
"growing"
"harvested"
"depraved"
"loaded"
"moving"
"unloaded"
"delivered"
"undefined"
object
responseCode
integer
Error code 0 = success <0 error codes >0 completion: code

responseMessage
string
individual human readable completion: message

Additional properties are allowed.
Additional properties are allowed.
#7Planning Goods Ready NotificationPlanningDeliveryNotificationMsg
Notification of the delivery of the ordered products
- application/json
Message IDPlanningDeliveryNotificationMsg
object
orderId
string
order id of the order

inquiryId
string
uuid to correlate to the to corresponding reservation or order

array<object>
one or more (in case of partial production) delivery location where the goods can be picked up

deliveryStatus
string
Default value:"undefined"
Allowed values:
"unavailable"
"reserved"
"ordered"
"cancelled"
"planted"
"growing"
"harvested"
"depraved"
"loaded"
"moving"
"unloaded"
"delivered"
"undefined"
shareAmount
integer
[ 0 .. 100 ]
Share of delivery in %. Partial 1..99% full delivery 100%

object
longitude
required
number
longitude of location

latitude
required
number
latitude of location

siteSpecifics
string
specific instruction at site

Additional properties are allowed.
storageRef
string
reference at the storage location to pickup and access the goods

deliveryDate
string
format: date-time
time when goods can be picked up

info
string
additional information about the delivered goods

Additional properties are allowed.

Schemas

object
Request which defines a reservation for producing a specific product for delivery including transport to a desired location

inquiryId
string
uuid to correlate the reservation to the corresponding order

customerId
string
Customer reference for who the reservation is designated

productId
string
product identifier

productname
string
short description such as name of the product

unit
string
quantity related unit of product

Allowed values:
"kg"
"ton"
"liter"
"m3"
"pcs"
plannedDelivery
string
format: date-time
requested delivery date of the required or minimal quantity of the product

requiredQty
number
requested quantity of product to grow and deliver

minimalQty
number
minimal quantity to reserve in case the complete quatity cannot be covered.

object
longitude
required
number
longitude of location

latitude
required
number
latitude of location

siteSpecifics
string
specific instruction at site

Additional properties are allowed.
Additional properties are allowed.
object
reservationId
string
reservation id of the reservation

inquiryId
string
uuid to correlate the reservation to corresponding order

reservationStatus
string
Default value:"undefined"
Allowed values:
"unavailable"
"reserved"
"ordered"
"cancelled"
"planted"
"growing"
"harvested"
"depraved"
"loaded"
"moving"
"unloaded"
"delivered"
"undefined"
productId
string
product identifier

productname
string
short description such as name of the product

expectedDelivery
string
format: date-time
expected delivery date of the reserved quantity of the product

unit
string
quantity related unit of product

Allowed values:
"kg"
"ton"
"liter"
"m3"
"pcs"
reservedQty
number
effectively reserved quanity. 0 means minimalQty cannot be satisfied

object
responseCode
integer
Error code 0 = success <0 error codes >0 completion: code

responseMessage
string
individual human readable completion: message

Additional properties are allowed.
Additional properties are allowed.
object
reservationId
string
reservation id of the reservation of the supplier

inquiryId
string
uuid to correlate the reservation to the corresponding order

customerId
string
Customer reference for who the reservation is designated

productId
string
product identifier

productname
string
short description such as name of the product

unit
string
quantity related unit of product

Allowed values:
"kg"
"ton"
"liter"
"m3"
"pcs"
plannedDelivery
string
format: date-time
requested delivery date of the required or minimal quantity of the product

orderedQty
number
requested quantity of product to grow and deliver. This quantity has to be the same or less than the reserved quanity

object
longitude
required
number
longitude of location

latitude
required
number
latitude of location

siteSpecifics
string
specific instruction at site

Additional properties are allowed.
Additional properties are allowed.
object
orderId
string
id of the reservation or order

inquiryId
string
uuid to correlate the reservation to corresponding order

orderStatus
string
Default value:"undefined"
Allowed values:
"unavailable"
"reserved"
"ordered"
"cancelled"
"planted"
"growing"
"harvested"
"depraved"
"loaded"
"moving"
"unloaded"
"delivered"
"undefined"
productId
string
product identifier

productname
string
short description such as name of the product

expectedDelivery
string
format: date-time
expected delivery date of the amount of the product

orderedQty
number
requested quantity of product to grow and deliver

unit
string
quantity related unit of product

Allowed values:
"kg"
"ton"
"liter"
"m3"
"pcs"
object
responseCode
integer
Error code 0 = success <0 error codes >0 completion: code

responseMessage
string
individual human readable completion: message

Additional properties are allowed.
Additional properties are allowed.
object
planningId
string
id of the reservation or order

inquiryId
string
uuid to correlate the reservation to corresponding order

reason
string
reason for the cancellation

Additional properties are allowed.
object
planningId
string
id of the reservation or order

inquiryId
string
uuid to correlate the reservation to corresponding order

cancellationStatus
string
Default value:"undefined"
Allowed values:
"unavailable"
"reserved"
"ordered"
"cancelled"
"planted"
"growing"
"harvested"
"depraved"
"loaded"
"moving"
"unloaded"
"delivered"
"undefined"
object
responseCode
integer
Error code 0 = success <0 error codes >0 completion: code

responseMessage
string
individual human readable completion: message

Additional properties are allowed.
Additional properties are allowed.
object
orderId
string
order id of the order

inquiryId
string
uuid to correlate to the to corresponding reservation or order

array<object>
one or more (in case of partial production) delivery location where the goods can be picked up

deliveryStatus
string
Default value:"undefined"
Allowed values:
"unavailable"
"reserved"
"ordered"
"cancelled"
"planted"
"growing"
"harvested"
"depraved"
"loaded"
"moving"
"unloaded"
"delivered"
"undefined"
shareAmount
integer
[ 0 .. 100 ]
Share of delivery in %. Partial 1..99% full delivery 100%

object
longitude
required
number
longitude of location

latitude
required
number
latitude of location

siteSpecifics
string
specific instruction at site

Additional properties are allowed.
storageRef
string
reference at the storage location to pickup and access the goods

deliveryDate
string
format: date-time
time when goods can be picked up

info
string
additional information about the delivered goods

Additional properties are allowed.
object
defines a location of storage where the whole or part of the original order is available or in case of depraved production which part is not delivered

deliveryStatus
string
Default value:"undefined"
Allowed values:
"unavailable"
"reserved"
"ordered"
"cancelled"
"planted"
"growing"
"harvested"
"depraved"
"loaded"
"moving"
"unloaded"
"delivered"
"undefined"
shareAmount
integer
[ 0 .. 100 ]
Share of delivery in %. Partial 1..99% full delivery 100%

object
longitude
required
number
longitude of location

latitude
required
number
latitude of location

siteSpecifics
string
specific instruction at site

Additional properties are allowed.
storageRef
string
reference at the storage location to pickup and access the goods

Additional properties are allowed.
object
longitude
required
number
longitude of location

latitude
required
number
latitude of location

siteSpecifics
string
specific instruction at site

Additional properties are allowed.
object
responseCode
integer
Error code 0 = success <0 error codes >0 completion: code

responseMessage
string
individual human readable completion: message

Additional properties are allowed.
ProductUnit
string
quantity related unit of product

Allowed values:
"kg"
"ton"
"liter"
"m3"
"pcs"
ProductionStatus
string
Default value:"undefined"
Allowed values:
"unavailable"
"reserved"
"ordered"
"cancelled"
"planted"
"growing"
"harvested"
"depraved"
"loaded"
"moving"
"unloaded"
"delivered"
"undefined"

Plantit-Planning 2.1.5

Servers

Operations

RECEIVE Q.plantit.prod.planning.{grpid}

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

REPLY CHANNEL INFORMATION

REPLY address information

Examples

This example has been generated automatically.

RECEIVE Q.plantit.prod.planning.{grpid}

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

REPLY CHANNEL INFORMATION

REPLY address information

Examples

This example has been generated automatically.

RECEIVE Q.plantit.prod.planning.{grpid}

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

REPLY CHANNEL INFORMATION

REPLY address information

Examples

This example has been generated automatically.

RECEIVE Q.plantit.prod.planning.{grpid}

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

REPLY CHANNEL INFORMATION

REPLY address information

Examples

This example has been generated automatically.

Messages

Schemas