Skip to content

Update product question

Rewords a product question, makes it required or not, changes its options or pattern, or moves it.

Needs the product:write scope.

Call

  • Tool: update_product_question
  • Scope: product:write
  • Writes, and may change or remove what is there.
  • Acts on a store.

Arguments

Name Type Required Description
store string No The store to act on.
product object Yes
question object Yes
position integer No Where it goes among the product’s questions, from zero; last when unset.
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.
from_position integer No Where the caller last read it; one moved since is refused, so two moves never compound.
{
  "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
        }
      ]
    },
    "question": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    },
    "position": {
      "description": "Where it goes among the product's questions, from zero; last when unset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 19
    },
    "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"
        }
      ]
    },
    "from_position": {
      "description": "Where the caller last read it; one moved since is refused, so two moves never compound.",
      "type": "integer",
      "minimum": 0,
      "maximum": 19
    }
  },
  "required": [
    "product",
    "question"
  ],
  "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.path names it.
  • invalid at ["store"]: store is 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; context names the field and, where it helps, its current value, and for a from, live, expect or version that no longer matches, the argument (path) and what it takes (reason).
  • not_permitted: this connection may not make this call. When context.reason is limit, too many calls: retry_after says when to try again.
  • internal or unavailable: 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_answer ok means the write landed, so don’t send it again. When reached_core is 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.

Type to search…

↑↓ navigate↵ selectEsc close