Skip to content
Bottle

Create a delivery option

POST
/delivery-options
curl --request POST \
  --url https://example.com/delivery-options \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "name": "example", "minDays": 1, "maxDays": 1, "pricePence": 0, "priceIncludesVat": true, "orderBy": "example", "daysOfWeek": [ 1 ], "sortOrder": 1 }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 60 characters
minDays
required
integer
<= 60
maxDays
required
integer
<= 60
pricePence
integer
0 <= 100000000
priceIncludesVat

Whether pricePence includes VAT. Left out, the business’s own setting (pricesIncludeVat on /tax) applies.

boolean
orderBy
string | null
/^([01]\d|2[0-3]):[0-5]\d$/
daysOfWeek
Array<integer>
>= 1 items <= 7 items
sortOrder
integer

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
name
required
string
minDays
required
integer
<= 60
maxDays
required
integer
<= 60
pricePence
required
integer
<= 100000000
priceIncludesVat
required
boolean
orderBy
required
string | null
daysOfWeek
required
Array<integer>
sortOrder
required
integer
archivedAt
required
string | null format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time

Example 

{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "name": "Next day"
}

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