order.return.settle
Flip a return to refunded when its completed refunds cover the total (honest no-op otherwise).
- scope:
orders:write - storefront-visible (bumps the catalog generation): no
- destructive: no
Payload
| field | type | required | notes |
|---|---|---|---|
returnId | string (/^ret_[a-zA-Z0-9]{1,32}$/) | yes |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"returnId": {
"type": "string",
"pattern": "^ret_[a-zA-Z0-9]{1,32}$"
}
},
"required": [
"returnId"
],
"additionalProperties": false
}Generated from the live platform registries at build time โ reference pages cannot go stale. Markdown variant: /reference/commands/order.return.settle.md