Needs the transaction:read scope.
Call
- Tool:
get_order - Scope:
transaction:read - Reads only.
- Acts on a store.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
store |
string |
No | The store to act on. |
order |
object |
Yes |
{
"type": "object",
"properties": {
"store": {
"type": "string",
"description": "The store to act on."
},
"order": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"required": [
"order"
],
"additionalProperties": false
}Answer
| Name | Type | Required | Description |
|---|---|---|---|
refunds_refused |
array of object |
Yes | |
customer |
object or null |
Yes | |
settled |
number or null |
Yes | |
refunded |
number or null |
Yes | |
revocable |
boolean |
Yes | Whether a revocation of the order would end anything: its customer’s grants or running subscriptions on its products, or its guests’ tickets. |
revocation |
object or null |
Yes | The latest revocation of its access for cause; null while none. |
failed_revocations |
object |
Yes | |
refund_status |
string or null |
Yes | How much of what it settled came back: none, part or all of it; null while it settled and refunded nothing, or withheld. |
lines |
object |
Yes | |
settlements |
object |
Yes | |
refunds |
object |
Yes | |
affiliates |
object |
Yes | |
id |
string |
Yes | |
number |
number |
Yes | |
customer_id |
string or null |
Yes | |
currency |
string |
Yes | |
exponent |
number or null |
Yes | |
amount |
number or null |
Yes | |
discount |
number or null |
Yes | |
total |
number or null |
Yes | |
free |
boolean |
Yes | |
fees |
number or null |
Yes | |
source |
string |
Yes | |
source_key |
string or null |
Yes | |
statements |
object |
Yes | |
note |
string or null |
Yes | |
occurred_at |
string or null |
Yes | |
recorded_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.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.