Skip to content
Bottle

Download a delivery partner's list for the day

POST
/delivery-partners/{id}/list/download
curl --request POST \
  --url https://example.com/delivery-partners/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/list/download \
  --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" ] }'

The same CSV file a send attaches. Records that it was downloaded, and the list stays not sent. 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

Responses

Section titled “Responses”

200

Section titled “200”

The CSV file

Media typetext/csv
string

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