Needs the product:write scope.
Call
- Tool:
create_product_question - Scope:
product:write - Writes, adding without changing what is there.
- Acts on a store.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
store |
string |
No | The store to act on. |
product |
object |
Yes | |
kind |
"text" or "select" or "long_text" or "multi_select" or "checkbox" |
No | What the buyer answers with: a short or long text, one option, any options, or a tick; a preset’s own when unset. |
preset |
"name" or "phone" or "address" or "company" |
No | A standard detail to ask for: name, phone, company or address, each once per product; it sets the kind, and the label and pattern unless given. |
label |
string |
No | What the buyer is asked, trimmed, with no line break or control character; required unless a preset names it. |
required |
boolean |
No | Whether checkout asks for an answer before payment; a required checkbox must be ticked. False when unset. |
options |
array of string |
No | A select’s or a multi select’s options, in order and distinct, each trimmed with no line break or control character; refused for any other kind. |
pattern |
string or null |
No | A text answer’s pattern, trimmed and matched against the whole answer: literals, ., classes, \d \w \s, groups, | and repeats up to 100; refused for any other kind and for what can’t be matched safely. |
example |
string or null |
No | An answer that fits the pattern, trimmed with no line break or control character, which checkout shows buyers as the format to follow; refused without a pattern or when the pattern doesn’t match it, and cleared with the pattern. |
position |
integer |
No | Where it goes among the product’s questions, from zero; last when unset. |
{
"type": "object",
"properties": {
"store": {
"type": "string",
"description": "The store to act on."
},
"product": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"slug"
],
"additionalProperties": false
}
]
},
"kind": {
"description": "What the buyer answers with: a short or long text, one option, any options, or a tick; a preset's own when unset.",
"type": "string",
"enum": [
"text",
"select",
"long_text",
"multi_select",
"checkbox"
]
},
"preset": {
"description": "A standard detail to ask for: `name`, `phone`, `company` or `address`, each once per product; it sets the kind, and the label and pattern unless given.",
"type": "string",
"enum": [
"name",
"phone",
"address",
"company"
]
},
"label": {
"description": "What the buyer is asked, trimmed, with no line break or control character; required unless a preset names it.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"required": {
"description": "Whether checkout asks for an answer before payment; a required checkbox must be ticked. False when unset.",
"type": "boolean"
},
"options": {
"description": "A select's or a multi select's options, in order and distinct, each trimmed with no line break or control character; refused for any other kind.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 2,
"maxItems": 20
},
"pattern": {
"description": "A text answer's pattern, trimmed and matched against the whole answer: literals, `.`, classes, `\\d \\w \\s`, groups, `|` and repeats up to 100; refused for any other kind and for what can't be matched safely.",
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 200
},
{
"type": "null"
}
]
},
"example": {
"description": "An answer that fits the pattern, trimmed with no line break or control character, which checkout shows buyers as the format to follow; refused without a pattern or when the pattern doesn't match it, and cleared with the pattern.",
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
},
"position": {
"description": "Where it goes among the product's questions, from zero; last when unset.",
"type": "integer",
"minimum": 0,
"maximum": 19
}
},
"required": [
"product"
],
"additionalProperties": false
}Answer
| Name | Type | Required | Description |
|---|---|---|---|
id |
string |
Yes | |
product_id |
string |
Yes | |
position |
number |
Yes | Where it shows among the product’s questions, from zero. |
kind |
string |
Yes | text, long_text, select, multi_select or checkbox. |
preset |
string or null |
Yes | The standard detail it asks for (name, phone, company or address), or null for one of the seller’s own. |
label |
string |
Yes | |
required |
boolean |
Yes | Whether checkout asks for an answer before payment; a required checkbox must be ticked. |
options |
array of string or null |
Yes | A select’s options, in order; null for any other kind. |
pattern |
string or null |
Yes | The pattern a text answer must match whole, or null for none. |
example |
string or null |
Yes | An answer that fits the pattern, which checkout shows as the format to follow; null for none. |
created_at |
string |
Yes | |
updated_at |
string |
Yes |
The answer’s full shape is on its API reference page.
Errors
A refused call is a tool error. Its structuredContent holds a code and its context, except for client-fault. This tool may answer:
invalid: an argument is malformed;context.pathnames it.invalidat["store"]:storeis missing while the connection reaches more than one store, or names a store it doesn’t reach.not_found: nothing matches a reference given.conflict: the call clashes with the current state;contextnames the field and, where it helps, its current value, and for afrom,live,expector version that no longer matches, the argument (path) and what it takes (reason).not_permitted: this connection may not make this call. Whencontext.reasonislimit, too many calls:retry_aftersays when to try again.internalorunavailable: the call failed inside Sherpo, and the write may have landed. This write takes no idempotency key, so read the state back before trying again.client-fault: the server failed around the call.core_answerokmeans the write landed, so don’t send it again. Whenreached_coreis false, nothing happened and the call may be made again. Otherwise, this write takes no idempotency key, so read the state back before trying again.- HTTP 403 with
insufficient_scope: the connection lacks the scope this tool needs. - HTTP 401 with
invalid_token: the access token expired or the connection ended. Refresh the token, and connect again if the refresh fails or the new token is refused too.
Any other code may come back too, such as a conflict when the state changed under the call. When the answer was already streaming, a 401 or 403 comes back as a tool error with only its text. See Errors for every code and its context.