Skip to content
Bottle

Update planning settings

PATCH
/planning
curl --request PATCH \
  --url https://example.com/planning \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "routingPreferences": "example", "dayStart": "07:30", "dayEnd": "07:30", "breakMinutes": 1, "deliveryWindowHours": 1, "loadMinutes": 1, "stopMinutes": 1, "itemMinutes": 1, "trafficPercent": 1, "peakPercent": 1, "peakMorningFrom": "07:30", "peakMorningTo": "07:30", "peakEveningFrom": "07:30", "peakEveningTo": "07:30" }'

Rounds already planned keep the estimate they were planned with until they are measured again.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
routingPreferences
string
<= 2000 characters
dayStart
string
/^([01]\d|2[0-3]):[0-5]\d$/

Example 

07:30
dayEnd
string
/^([01]\d|2[0-3]):[0-5]\d$/

Example 

07:30
breakMinutes
integer
<= 240
deliveryWindowHours
Any of:
number
Allowed values: 1
loadMinutes
integer
<= 240
stopMinutes
number
<= 120
itemMinutes
number
<= 60
trafficPercent
integer
<= 200
peakPercent
integer
<= 300
peakMorningFrom
string | null
/^([01]\d|2[0-3]):[0-5]\d$/

Example 

07:30
peakMorningTo
string | null
/^([01]\d|2[0-3]):[0-5]\d$/

Example 

07:30
peakEveningFrom
string | null
/^([01]\d|2[0-3]):[0-5]\d$/

Example 

07:30
peakEveningTo
string | null
/^([01]\d|2[0-3]):[0-5]\d$/

Example 

07:30

Responses

Section titled “Responses”

200

Section titled “200”

The settings as they now stand

Media typeapplication/json
object
routingPreferences
string
<= 2000 characters
dayStart
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
dayEnd
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
breakMinutes
required
integer
<= 240
deliveryWindowHours
required
Any of:
number
Allowed values: 1
loadMinutes
required
integer
<= 240
stopMinutes
required
number
<= 120
itemMinutes
required
number
<= 60
trafficPercent
required
integer
<= 200
peakPercent
required
integer
<= 300
peakMorningFrom
required
string | null
/^([01]\d|2[0-3]):[0-5]\d$/
peakMorningTo
required
string | null
/^([01]\d|2[0-3]):[0-5]\d$/
peakEveningFrom
required
string | null
/^([01]\d|2[0-3]):[0-5]\d$/
peakEveningTo
required
string | null
/^([01]\d|2[0-3]):[0-5]\d$/
updatedAt
required
string format: date-time

Example 

{
  "dayStart": "07:30",
  "dayEnd": "07:30",
  "deliveryWindowHours": 1,
  "peakMorningFrom": "07:30",
  "peakMorningTo": "07:30",
  "peakEveningFrom": "07:30",
  "peakEveningTo": "07:30"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example 

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}