Skip to content
Bottle

Update a delivery address

PATCH
/addresses/{id}
curl --request PATCH \
  --url https://example.com/addresses/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "name": "example", "line1": "example", "line2": "example", "city": "example", "postcode": "example", "notes": "example", "leaveInstruction": "none", "leaveDetail": "example", "dropLatitude": 1, "dropLongitude": 1, "archived": true, "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" }'

Moving an address leaves orders already taken where they are: an order carries the customer it was taken for, so an invoice does not change hands when a pub does.

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 | null
<= 80 characters
line1
string
>= 1 characters <= 200 characters
line2
string | null
<= 200 characters
city
string | null
<= 120 characters
postcode
string | null
<= 12 characters
notes
string | null
<= 2000 characters
leaveInstruction
string | null
Allowed values: none neighbour safe_place
leaveDetail
string | null
<= 500 characters
dropLatitude
number | null
>= -90 <= 90
dropLongitude
number | null
>= -180 <= 180
archived
boolean
customerId

UUID v7

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

Responses

Section titled “Responses”

200

Section titled “200”

Updated

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
customerId
required

UUID v7

string format: uuid
name
required
string | null
line1
required
string
line2
required
string | null
city
required
string | null
postcode
required
string | null
notes
required
string | null
leaveInstruction
required
string | null
Allowed values: none neighbour safe_place
leaveDetail
required
string | null
dropLatitude
required
number | null
>= -90 <= 90
dropLongitude
required
number | null
>= -180 <= 180
archivedAt
required
string | null format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
latitude
required
number | null
longitude
required
number | null
geocodedAt
required
string | null format: date-time
postcodeDistrict
required
string | null
adminDistrict
required
string | null
adminCounty
required
string | null
region
required
string | null
Example
{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "line1": "14 High Street",
  "postcode": "KT3 4BP",
  "leaveInstruction": "none",
  "postcodeDistrict": "KT3",
  "adminDistrict": "Kingston upon Thames",
  "adminCounty": "Surrey",
  "region": "London"
}

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 of that tenant

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

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