Skip to content

List order refunds

Pages an order's refunds.

Needs the read scope.

Pages its answer: pass the cursor back for the next page, at most 100 items a page.

Sorts: occurred.

Call

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

Arguments

Name Type Required Description
order object Yes
query object No
{
  "type": "object",
  "properties": {
    "order": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    },
    "query": {
      "type": "object",
      "properties": {
        "filter": {
          "type": "object",
          "properties": {},
          "additionalProperties": false
        },
        "sort": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "enum": [
                "occurred"
              ]
            },
            "direction": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ]
            }
          },
          "additionalProperties": false
        },
        "limit": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100
        },
        "cursor": {
          "type": "string",
          "maxLength": 8192
        },
        "count": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "order"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
total number No
items array of object Yes
cursor string or null Yes
currency string Yes
exponent number or null Yes

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close