Skip to content
Bottle

Email a delivery partner the day's list

POST
/delivery-partners/{id}/list/send
curl --request POST \
  --url https://example.com/delivery-partners/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/list/send \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "date": "2026-04-15", "orderIds": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ], "takenOffOrderIds": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ], "lastSentAt": "2026-04-15T12:00:00Z", "email": "hello@example.com" }'

Sends the listed orders as a CSV file, with no prices or payment details, says which orders have been taken off since the last list, and records the send on each order. With no orders left it says there is nothing to deliver. Refused if the day has changed since the list was read. Nothing is recorded if the email fails. Signed-in people only.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
date
required

The delivery day, in the UK.

string format: date
orderIds
required

The orders on the list. Refused if the day has changed since it was read.

Array<string>
<= 500 items
takenOffOrderIds

The orders shown as taken off. Refused if that has changed since it was read.

Array<string>
<= 500 items
lastSentAt

When the list was last sent, as read. Refused if someone has sent it since.

string | null format: date-time
email

Where to send it, for a partner with no email address. Saved on the partner.

string format: email
<= 320 characters

Responses

Section titled “Responses”

200

Section titled “200”

Sent

Media typeapplication/json
object
sentAt
required
string format: date-time
to
required
string
orders
required
integer
recorded
required

False if the email went but the send could not be recorded. Do not send it again.

boolean

Example generated

{
  "sentAt": "2026-04-15T12:00:00Z",
  "to": "example",
  "orders": 1,
  "recorded": true
}

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, without the permission this needs, or on a plan without delivery partners

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

409

Section titled “409”

Refused, with the reason

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