Skip to content
Bottle

Create a base

POST
/locations
curl --request POST \
  --url https://example.com/locations \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "kind": "depot", "name": "example", "line1": "example", "city": "example", "postcode": "example" }'

Placed on the map from its postcode as it is saved.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
kind
string
Allowed values: depot home
name
required
string
>= 1 characters <= 120 characters
line1
required
string
>= 1 characters <= 200 characters
city
string | null
<= 120 characters
postcode
required
string
>= 5 characters <= 8 characters

Responses

Section titled “Responses”

201

Section titled “201”

Added

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
kind
required
string
Allowed values: depot home
name
required
string
>= 1 characters <= 120 characters
line1
required
string
>= 1 characters <= 200 characters
city
required
string | null
<= 120 characters
postcode
required
string
>= 5 characters <= 8 characters
archivedAt
required
string | null 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
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "kind": "depot",
  "name": "Yard",
  "postcode": "KT3 4BP",
  "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, 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"
    }
  ]
}