Skip to content

List delivery options

GET
/delivery-options
curl --request GET \
--url 'https://example.com/delivery-options?archived=true' \
--cookie bottle.session_token=<bottle.session_token>

The service levels this business offers, in the order it lists them: a name, the earliest and latest calendar day from the day the order is taken, and a price excluding VAT. Live options only unless archived=true.

archived
string
Allowed values: true false

The options

Media typeapplication/json
object
items
required
Array<object>
object
id
required

UUID v7

string format: uuid
name
required
string
minDays
required
integer
<= 60
maxDays
required
integer
<= 60
pricePence
required
integer
<= 100000000
sortOrder
required
integer
archivedAt
required
string | null format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
"items": [
{
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"name": "Next day"
}
]
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
"error": "not_found",
"message": "Customer not found"
}

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

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