Skip to content

Read store

Reads the store: its name, hostname, subdomain, branding and plan.

Needs the site:read scope.

Call

  • Tool: get_store
  • Scope: site:read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
store string No The store to act on.
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    }
  },
  "additionalProperties": false
}

Answer

Name Type Required Description
site object Yes
plan object Yes
files object Yes
integrations array of object Yes
redirects object Yes
notifications object Yes
work object Yes
locale string Yes
tint string or null Yes
tint_dark string or null Yes
delivery_ttl_seconds number Yes
refund_revokes_access boolean Yes
description string or null Yes
time_zone string Yes
currency string or null Yes
settings object Yes
metadata object Yes
revision number Yes
updated_at string or null Yes
id string Yes
name string Yes
merchant_id string Yes
hostname string or null Yes
url string or null Yes The store home’s absolute URL on its verified hostname, or null before it has one.
subdomain string or null Yes
hostnames array of string Yes
swatch string or null Yes
icon 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_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. A read marked transient may be retried.
  • client-fault: the server failed around the call. reached_core says whether it reached Sherpo; the call may be made 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