Skip to content
Bottle

List imported products waiting for a look

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

Every product with a suggestion nobody has answered yet: what Bottle thinks it is, which gas type and size, and how sure it is. Surest first. A suggestion is a proposal and changes nothing until accepted.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Suggestions waiting

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

UUID v7

string format: uuid
product
required
object
id
required

UUID v7

string format: uuid
name
required
string
sku
required
string | null
unitPrice
required
integer
<= 100000000
weightKg
required
number | null
volumeLitres
required
integer | null
gasTypeId
required

UUID v7

string | null format: uuid
shop
required
string | null
Allowed values: woocommerce shopify
kind
required

A cylinder of gas, a deposit or rent on cylinders, an accessory such as a regulator, the delivery charge, or nothing Bottle could tell.

string
Allowed values: cylinder deposit hire accessory delivery unknown
gasTypeName
required
string | null
gasTypeId
required

UUID v7

string | null format: uuid
brand
required
string | null
sizeKg
required
number | null
sizeLitres
required
number | null
confidence
required
number
<= 1
source
required

Whether the rules alone said so, or a model refined them.

string
Allowed values: rules ai
reason
required
string | null
status
required
string
Allowed values: pending accepted dismissed
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
total
required
integer
Example
{
  "items": [
    {
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "product": {
        "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
        "name": "Calor Propane 13kg Refill",
        "gasTypeId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
        "shop": "woocommerce"
      },
      "kind": "cylinder",
      "gasTypeName": "Calor Propane",
      "gasTypeId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "brand": "Calor",
      "sizeKg": 13,
      "sizeLitres": 10,
      "source": "rules",
      "status": "pending"
    }
  ]
}

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