Needs the organization:read scope.
Call
- Tool:
list_merchants - Scope:
organization:read - Reads only.
- Acts on your account.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
merchant |
object |
No | Narrows the list to the seller’s one membership of it, e.g. one past the cap. |
store |
object |
No | Narrows the list to the membership of the merchant holding it, listing that store alone. |
cursor |
string |
No | Lists the memberships past a previous page, from that page’s cursor. |
{
"type": "object",
"properties": {
"merchant": {
"description": "Narrows the list to the seller's one membership of it, e.g. one past the cap.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"id"
],
"additionalProperties": false
},
"store": {
"description": "Narrows the list to the membership of the merchant holding it, listing that store alone.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"id"
],
"additionalProperties": false
},
"cursor": {
"description": "Lists the memberships past a previous page, from that page's `cursor`.",
"type": "string",
"maxLength": 1024
}
},
"additionalProperties": false
}Answer
| Name | Type | Required | Description |
|---|---|---|---|
items |
array of object |
Yes | |
total |
number |
Yes | |
owns_suspended |
boolean |
Yes | |
cursor |
string or null |
Yes | The next page’s, null on the last; a page its seats leave empty may still have one. |
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.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.