Skip to content
Bottle

Change a delivery area

PATCH
/storefront/delivery-areas/{id}
curl --request PATCH \
  --url https://example.com/storefront/delivery-areas/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f \
  --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": 1, "minimumOrderPence": 1, "sortOrder": 1 }'

Only what is sent changes. patchIds, when sent, replaces the list.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Request Bodyrequired

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

Responses

Section titled “Responses”

200

Section titled “200”

Changed

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