Skip to content

Read customer

Reads one customer.

Needs the customer:read scope.

Call

  • Tool: get_customer
  • Scope: customer:read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
store string No The store to act on.
customer object Yes
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "customer": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "customer"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
orders object Yes
subscriptions object Yes
grants object Yes
entitlements object Yes
reviews object Yes
attempts object Yes
certificates object Yes
feeds object Yes Their private feeds, live and stopped, newest first; listFeeds pages the rest.
contacts array of object Yes
totals object Yes
id string Yes
display_name string or null Yes
locale string or null Yes
country string or null Yes
erased_at string or null Yes
invited_at string or null Yes
created_at string or null 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.
  • 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