Skip to content
Bottle

Create a product detail

POST
/product-details
curl --request POST \
  --url https://example.com/product-details \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "name": "example", "type": "choice", "multiple": true, "unit": "example", "kinds": [ "cylinder" ], "options": [ "Clip-on", "Screw-fit" ] }'

Goes last in the order. Its key is made from the name, with a number added when another detail has it. A choice needs its options. Up to 50 per business, archived ones included.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 60 characters
type
required

Choice: one of a list of options, or several when multiple is true. number: a number, in the fixed unit set on the detail, such as kg. yesno: yes or no. text: a short line of text, shown on the product and not a filter.

string
Allowed values: choice number yesno text
multiple

On a choice: let a product have several options. Ignored on other types.

boolean
unit

On a number: the unit, such as kg or litres.

string | null
<= 12 characters
kinds

The kinds of product it applies to. Null or left out: every product.

Array<string> | null
>= 1 items <= 9 items
Allowed values: cylinder deposit hire accessory appliance fuel consumable delivery other
options

On a choice: the options, in order. Needed on a choice, ignored otherwise.

Array<string>
<= 100 items

Example 

[
  "Clip-on",
  "Screw-fit"
]

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
name
required
string
key
required

In the shop’s filter addresses: /products?d-regulator-fitting=clip-on. Made from the name when the detail is created and kept when it is renamed, so shared links keep working. Unique within the business.

string
type
required

Choice: one of a list of options, or several when multiple is true. number: a number, in the fixed unit set on the detail, such as kg. yesno: yes or no. text: a short line of text, shown on the product and not a filter.

string
Allowed values: choice number yesno text
multiple
required

On a choice: whether a product can have several options. False otherwise.

boolean
unit
required

On a number: the unit it is in, as shown after it. Null when there is none.

string | null
kinds
required

The kinds of product it applies to. Null: every product.

Array<string> | null
Allowed values: cylinder deposit hire accessory appliance fuel consumable delivery other
options
required

On a choice: its options in order, archived ones included. Empty otherwise.

Array<object>
object
id
required

UUID v7

string format: uuid
label
required
string
archivedAt
required

Archived options are kept on the products that have them and are not offered for new ones.

string | null format: date-time
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": "Regulator fitting",
  "key": "regulator-fitting",
  "type": "choice",
  "unit": "kg",
  "kinds": [
    "cylinder"
  ],
  "options": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "label": "Clip-on"
    }
  ]
}

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

409

Section titled “409”

The business already has 50 product details

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