createDeliveryRequest

WRITE

Create an unassigned propane delivery request for a tank and service date. Read tankId from getDispatchWorkspace. Requested gallons and an operational note are optional; do not invent a quantity. This does not assign a driver, issue an invoice, or send a customer message..

POST /api/v1/routes/createDeliveryRequest

curl -X POST '<your-host>/api/v1/routes/createDeliveryRequest' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "tankId": "string",
    "serviceDate": "string"
  }'

Response

{
  "entityId": "string",
  "message": "string",
  "serviceDate": "string",
  "routePlanId": "string"
}

Parameters

ParameterType

date

min length 1

max length 2000

> 0

Input schema

schema

{
  "type": "object",
  "properties": {
    "tankId": {
      "type": "string",
      "minLength": 1
    },
    "serviceDate": {
      "type": "string",
      "format": "date"
    },
    "requestedGallons": {
      "type": "number",
      "exclusiveMinimum": 0
    },
    "note": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "tankId",
    "serviceDate"
  ],
  "additionalProperties": false
}