Skip to content
Bottle

List products

GET
/products
curl --request GET \
  --url https://example.com/products \
  --cookie bottle.session_token=<bottle.session_token>

Ordered by name. Archived products are left out unless asked for.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
includeArchived

Include things no longer sold.

string

Include things no longer sold.

Responses

Section titled “Responses”

200

Section titled “200”

Products

Media typeapplication/json
object
items
required
Array<object>
object
id
required

UUID v7

string format: uuid
name
required
string
shortCode
required
string | null
sku
required
string | null
unitPrice
required

Pence, excluding VAT.

integer
<= 100000000
vatRate
required

VAT in basis points: 2000 is 20%, 500 is 5%, 0 is zero rated.

integer
<= 10000
charge
required
string | null
Allowed values: deposit hire
chargePeriod
required
string | null
Allowed values: once daily weekly monthly
chargeForProductId
required

UUID v7

string | null format: uuid
gasTypeId
required

UUID v7

string | null format: uuid
weightKg
required
number | null
volumeLitres
required
integer | null
notes
required
string | null
links
required
Array<object>
object
source
required
string
Allowed values: woocommerce shopify
externalId
required
string
externalVariantId
required
string | null
externalSku
required
string | null
lastSyncedAt
required
string | null format: date-time
archivedAt
required
string | null format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
total
required
integer
Example
{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "name": "19kg propane",
      "shortCode": "19",
      "sku": "PROP-19",
      "unitPrice": 5400,
      "vatRate": 2000,
      "charge": "deposit",
      "chargePeriod": "once",
      "chargeForProductId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "gasTypeId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "weightKg": 38.5,
      "volumeLitres": 60,
      "links": [
        {
          "source": "woocommerce",
          "externalId": "1043"
        }
      ]
    }
  ]
}

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