Skip to content
Bottle

Get ways to bring a round within its limits

GET
/rounds/{id}/relief
curl --request GET \
  --url https://example.com/rounds/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/relief \
  --cookie bottle.session_token=<bottle.session_token>

For a van carrying more than it is plated for. Returns every drop on the round, heaviest first, with the other rounds that day which have room for it and the next day that door will take a delivery; and straight swaps with another round that fix this one without pushing that one over. The planner never over-fills a round itself: this is for the round built by hand.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Responses

Section titled “Responses”

200

Section titled “200”

What could be done about it

Media typeapplication/json
object
overKg
required
number
overLitres
required
integer
drops
required
Array<object>
object
stopId
required

UUID v7

string format: uuid
orderId
required

UUID v7

string format: uuid
customerName
required
string | null
kg
required
number
litres
required
integer
clears
required
boolean
moveTo
required
Array<object>
object
roundId
required

UUID v7

string format: uuid
name
required
string
spareKg
required
number | null
spareLitres
required
integer | null
nextOpenDay
required
string | null format: date
swaps
required
Array<object>
object
giveStopId
required

UUID v7

string format: uuid
giveOrderId
required

UUID v7

string format: uuid
giveCustomerName
required
string | null
giveKg
required
number
takeStopId
required

UUID v7

string format: uuid
takeOrderId
required

UUID v7

string format: uuid
takeCustomerName
required
string | null
takeKg
required
number
withRoundId
required

UUID v7

string format: uuid
withName
required
string
Example
{
  "drops": [
    {
      "stopId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "orderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "moveTo": [
        {
          "roundId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
        }
      ]
    }
  ],
  "swaps": [
    {
      "giveStopId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "giveOrderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "takeStopId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "takeOrderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "withRoundId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ]
}

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"
}

404

Section titled “404”

No such round

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"
    }
  ]
}