Skip to content

Suggest gas types for imported products

POST
/products/review/suggest
curl --request POST \
--url https://example.com/products/review/suggest \
--header 'Content-Type: application/json' \
--cookie bottle.session_token=<bottle.session_token> \
--data '{ "productIds": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ] }'

Works out what each product is from its name, with a model refining the answer where one is configured, and writes a suggestion per product for somebody to accept. Given no ids, looks at every imported product that has no gas type and no answer yet. A product already answered is left alone.

Media typeapplication/json
object
productIds
Array<string>
<= 500 items

How many were looked at and how many are waiting

Media typeapplication/json
object
considered
required
integer
pending
required
integer
source
required

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

string
Allowed values: rules ai
Example
{
"source": "rules"
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
"error": "not_found",
"message": "Customer not found"
}

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

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