routeStorefrontRequest

Requires permission storefront:storefront:update.

Decide whether one theme-editor chat message asks for a page (several library sections, startStorefrontPageGeneration) or one section (startStorefrontSectionGeneration). A model decides (the typed decider, else a small model), never a word list. Synchronous; writes nothing; meters AI credits.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation RouteStorefrontRequest($input: RouteStorefrontRequestInput!) {
  routeStorefrontRequest(input: $input) {
    confidence
    costDisplay
    creditsUsedCents
    decidedBy
    scope
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation RouteStorefrontRequest($input: RouteStorefrontRequestInput!) {\n  routeStorefrontRequest(input: $input) {\n    confidence\n    costDisplay\n    creditsUsedCents\n    decidedBy\n    scope\n  }\n}",
  "variables": {
    "input": {
      "request": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "request": "string"
  }
}

Response:

{
  "data": {
    "routeStorefrontRequest": {
      "confidence": 0,
      "costDisplay": "string",
      "creditsUsedCents": 0,
      "decidedBy": "string",
      "scope": "string"
    }
  }
}

routeStorefrontRequest(
  input: RouteStorefrontRequestInput!
): StorefrontRequestRoute!

Arguments

routeStorefrontRequest.input ● RouteStorefrontRequestInput! non-null input

The seller's chat message, where it goes, the page it is for and how many images go with it.

Type

StorefrontRequestRoute object

Where a storefront request was routed.