Skip to content
Bottle

List a day's orders with delivery partners

GET
/partner-deliveries
curl --request GET \
  --url 'https://example.com/partner-deliveries?date=2026-04-15&partnerId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Orders a delivery partner has for that day, with the partner. They have no driver, vehicle or estimated time.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
date
required

The delivery day, in the UK.

string format: date

The delivery day, in the UK.

partnerId

Only this partner.

string format: uuid

Example 

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

Only this partner.

Responses

Section titled “Responses”

200

Section titled “200”

The day

Media typeapplication/json
object
date
required
string format: date
items
required
Array<object>
object
orderId
required

UUID v7

string format: uuid
trackingRef
required
string
customerName
required
string | null
status
required
string
Allowed values: placed delivered
location
required
object
latitude
required
number
longitude
required
number
address
required
string | null
lines
required
Array<object>
object
productName
required
string
quantity
required
integer
cylinder
required
boolean
delivery
required
object
id
required

UUID v7

string format: uuid
partnerId
required

UUID v7

string format: uuid
partnerName
required
string
deliveryDate
required
string format: date
setAt
required
string format: date-time
sentAt
required
string | null format: date-time
sentVia
required
string | null
Allowed values: email csv
sentBy
string | null
edited
Array<string>
Allowed values: products address notes contact
downloadedAt
string | null format: date-time
downloadedBy
string | null
takenOff
required

Orders on the list last sent to a partner that have since come off it.

Array<object>
object
orderId
required

UUID v7

string format: uuid
partnerId
required

UUID v7

string format: uuid
trackingRef
required
string
customerName
required
string | null

Example 

{
  "items": [
    {
      "orderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "status": "placed",
      "delivery": {
        "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
        "partnerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
        "sentVia": "email",
        "edited": [
          "products"
        ]
      }
    }
  ],
  "takenOff": [
    {
      "orderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "partnerId": "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, 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"
    }
  ]
}