Skip to content
Bottle

Add a delivery area

POST
/storefront/delivery-areas
curl --request POST \
  --url https://example.com/storefront/delivery-areas \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "name": "example", "patchIds": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ], "deliveryOptionIds": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ], "freeOverPence": null, "minimumOrderPence": null, "sortOrder": 0 }'

Some of the business’s delivery patches, one of its delivery options for the days and the charge, and optionally free delivery over a basket value and a minimum order, both VAT in. A patch can be in one area only.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 80 characters
patchIds
required
Array<string>
>= 1 items <= 100 items
deliveryOptionIds
required
Array<string>
>= 1 items <= 10 items
freeOverPence
integer | null
<= 10000000
minimumOrderPence
integer | null
<= 10000000
sortOrder
integer
0 <= 10000

Responses

Section titled “Responses”

201

Section titled “201”

Added

Media typeapplication/json
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
{
  "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"
}

404

Section titled “404”

No such delivery area, or no such delivery option

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

409

Section titled “409”

A patch is already in another area: patch and area say which

Media typeapplication/json
object
error
required
string
message
required
string
patch
required
object
id
required

UUID v7

string format: uuid
name
required
string
area
required
object
id
required

UUID v7

string format: uuid
name
required
string
Example
{
  "patch": {
    "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
  },
  "area": {
    "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
  }
}

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