Skip to content
Bottle

List delivery areas

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

Where the shop delivers, in the order the office set: each area is some of the business’s delivery patches, matched as rounds match them (postcode terms by prefix, towns and counties by name). Where patches overlap, the most specific match wins: a postcode district over a postcode area over a place name. Archived areas are left out.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The areas

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

UUID v7

string format: uuid
name
required
string
patchIds
required
Array<string>
deliveryOptionIds
required
Array<string>
freeOverPence
required
integer | null
minimumOrderPence
required
integer | null
sortOrder
required
integer
Example
{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "name": "Thirsk and villages",
      "patchIds": [
        "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
      ],
      "deliveryOptionIds": [
        "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"
}

402

Section titled “402”

The plan does not include a shop

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