---
title: "List checkouts"
description: "Pages the customer's checkouts."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List checkouts

Needs the read scope.

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

Filters: status (eq, in), currency (eq).

Sorts: created.

## Call

- Tool: `list_checkouts`
- Scope: `read`
- Reads only.
- Acts on a store.

## Arguments

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `query` | `object` | No |  |

```json
{
  "type": "object",
  "properties": {
    "query": {
      "type": "object",
      "properties": {
        "filter": {
          "type": "object",
          "properties": {
            "status": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "open",
                    "frozen",
                    "paid",
                    "abandoned",
                    "expired"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "eq": {
                      "type": "string",
                      "enum": [
                        "open",
                        "frozen",
                        "paid",
                        "abandoned",
                        "expired"
                      ]
                    },
                    "in": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "enum": [
                          "open",
                          "frozen",
                          "paid",
                          "abandoned",
                          "expired"
                        ]
                      },
                      "minItems": 1,
                      "maxItems": 50
                    }
                  },
                  "minProperties": 1,
                  "additionalProperties": false
                }
              ]
            },
            "currency": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "object",
                  "properties": {
                    "eq": {
                      "type": "string"
                    }
                  },
                  "minProperties": 1,
                  "additionalProperties": false
                }
              ]
            }
          },
          "additionalProperties": false
        },
        "sort": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "enum": [
                "created"
              ]
            },
            "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
    }
  },
  "additionalProperties": false
}
```

## Answer

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `total` | `number` | No |  |
| `items` | `array of object` | Yes |  |
| `cursor` | `string or null` | Yes |  |

The answer's full shape is on [its API reference page](/customer-api/reference/list-checkouts).

Source: https://docs.sherpo.io/customer-mcp/tools/list_checkouts/index.mdx
