Skip to content
Bottle

List the day's deliveries and collections

GET
/deliveries
curl --request GET \
  --url https://example.com/deliveries \
  --cookie bottle.session_token=<bottle.session_token>

Orders going out on the day, grouped by delivery area (or postcode district where no area covers them), and customers collecting from the yard. An order is on the list from the day it is wanted or first expected until it is done, so one left from an earlier day shows as late; one done that day stays on, marked done. Each stop says what goes out, what comes back, and any cash to take at the door.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
date

The day, in the UK. Today when left out.

string format: date

The day, in the UK. Today when left out.

Responses

Section titled “Responses”

200

Section titled “200”

The day

Media typeapplication/json
object
date
required
string format: date
deliver
required
Array<object>
object
area
required
string | null
stops
required
Array<object>
object
orderId
required

UUID v7

string format: uuid
trackingRef
required
string
name
required
string | null
phone
required
string | null
address
required
string | null
postcode
required
string | null
notes
required
string | null
lines
required
Array<object>
object
productId
required

UUID v7

string format: uuid
productName
required
string
quantity
required
integer
> 0
cylinder
required
boolean
collect
required
Array<object>
object
productId
required

UUID v7

string format: uuid
productName
required
string
quantity
required
integer
> 0
cylinder
required
boolean
paymentMethod
required

On_account: billed later, nothing to collect. link: a payment link raised in the accounting system. cash: the driver takes it at the door.

string
Allowed values: on_account link cash
cashDuePence
required
integer
paid
required
boolean
done
required
boolean
late
required
boolean
collect
required
Array<object>
object
orderId
required

UUID v7

string format: uuid
trackingRef
required
string
name
required
string | null
phone
required
string | null
address
required
string | null
postcode
required
string | null
notes
required
string | null
lines
required
Array<object>
object
productId
required

UUID v7

string format: uuid
productName
required
string
quantity
required
integer
> 0
cylinder
required
boolean
collect
required
Array<object>
object
productId
required

UUID v7

string format: uuid
productName
required
string
quantity
required
integer
> 0
cylinder
required
boolean
paymentMethod
required

On_account: billed later, nothing to collect. link: a payment link raised in the accounting system. cash: the driver takes it at the door.

string
Allowed values: on_account link cash
cashDuePence
required
integer
paid
required
boolean
done
required
boolean
late
required
boolean
Example
{
  "deliver": [
    {
      "stops": [
        {
          "orderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
          "lines": [
            {
              "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
            }
          ],
          "collect": [
            {
              "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
            }
          ],
          "paymentMethod": "on_account"
        }
      ]
    }
  ],
  "collect": [
    {
      "orderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "lines": [
        {
          "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
        }
      ],
      "collect": [
        {
          "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
        }
      ],
      "paymentMethod": "on_account"
    }
  ]
}

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