Needs the product:read scope.
Call
- Tool:
get_product - Scope:
product:read - Reads only.
- Acts on a store.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
store |
string |
No | The store to act on. |
product |
object |
Yes |
{
"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
}
]
}
},
"required": [
"product"
],
"additionalProperties": false
}Answer
| Name | Type | Required | Description |
|---|---|---|---|
holders |
number |
Yes | |
seats |
object or null |
Yes | An event’s seats: what frozen carts hold and sales took, each ticket type’s too; null for another category. |
poster |
object or null |
No | |
description |
string or null |
Yes | The page’s long description, in the rich text format as stored. |
what_you_get |
string or null |
Yes | What a buyer gets, in the rich text format as stored. |
files |
object |
Yes | |
tiers |
array of object |
Yes | |
prices |
array of object |
Yes | |
in_use |
array of object |
Yes | |
delete_blocked_by |
array of object |
Yes | |
stats |
array of object |
Yes | |
ratings |
object |
Yes | |
event_map |
object or null |
Yes | An event’s venue maps at its location’s point, one image per theme; null until drawn, or for any other product. |
id |
string |
Yes | |
slug |
string |
Yes | |
path |
string |
Yes | The storefront path. |
url |
string or null |
Yes | The absolute URL on the store’s verified hostname, or null before it has one. |
title |
string |
Yes | |
subtitle |
string or null |
Yes | The short line shown under the title. |
category |
string |
Yes | |
listing |
string |
Yes | |
priority |
number |
Yes | |
status |
string |
Yes | |
unlisted |
boolean |
Yes | |
feed_url |
string or null |
Yes | The public feed’s absolute URL, for a blog or a podcast that is published (discontinued too), listed and on a verified hostname; else null. |
published_at |
string or null |
Yes | |
discontinued_at |
string or null |
Yes | |
unlisted_at |
string or null |
Yes | |
created_at |
string or null |
Yes | |
updated_at |
string or null |
Yes | |
settings |
object |
Yes | |
metadata |
object |
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.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. A read markedtransientmay be retried.client-fault: the server failed around the call.reached_coresays 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.