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

# List carts

> The checkouts buyers left in the period, newest first, 25 a page, each with where it stands. A cart's `id` is its checkout's order ID. `state` is `waiting` (its first email is to come, `note` says when), `not_emailed` (it will not be written to, `note` says why), `first`, `declined` or `second` (the email it last had), `recovered`, `unsubscribed`, or `stopped` (let go with nothing sent). `emailedAt` and `secondEmailAt` are when its emails went, `couponCode` the second email's coupon, `clickedAt` when a browser first opened its button, and `recoveredOrderId` and `recoveredAt` the order that paid: the cart's own, or the checkout its button opened.

Needs the `recovery.read` permission (Read Cart Recovery).



## OpenAPI

````yaml /api-reference/openapi.json get /stores/{storeId}/cart-recovery/carts
openapi: 3.1.0
info:
  title: Shoply API
  version: '1'
  description: >-
    Everything a store's own server can do with a secret API key: its catalogue,
    orders, customers, marketing, finance and the rest of what the dashboard
    does. And the Customer API, which a buyer's own device asks with a token of
    theirs.
servers:
  - url: https://api.shoply.gg/v1
security:
  - apiKey: []
tags:
  - name: API key
  - name: Store
  - name: Domain
  - name: Payment methods
  - name: Analytics
  - name: Storefronts
  - name: Storefront code
  - name: Payment Routing
  - name: Custom payment methods
  - name: Products
  - name: Product pictures
  - name: Stock
  - name: Categories
  - name: Upsells
  - name: Subscriptions
  - name: Orders
  - name: Invoices
  - name: Reviews
  - name: Coupons
  - name: Coupon categories
  - name: Coupon pop-up
  - name: Sales
  - name: Blog
  - name: Search settings
  - name: Redirects
  - name: Sitemap
  - name: Cart Recovery
  - name: Email Marketing
  - name: Email Templates
  - name: Customers
  - name: Affiliates
  - name: Support Tickets
  - name: Blacklist
  - name: Fraud protection
  - name: Disputes
  - name: Finance
  - name: Tax
  - name: Expenses
  - name: Expense setup
  - name: API requests
  - name: Webhook endpoints
  - name: Webhook deliveries
  - name: Customer API
paths:
  /stores/{storeId}/cart-recovery/carts:
    get:
      tags:
        - Cart Recovery
      summary: List carts
      description: >-
        The checkouts buyers left in the period, newest first, 25 a page, each
        with where it stands. A cart's `id` is its checkout's order ID. `state`
        is `waiting` (its first email is to come, `note` says when),
        `not_emailed` (it will not be written to, `note` says why), `first`,
        `declined` or `second` (the email it last had), `recovered`,
        `unsubscribed`, or `stopped` (let go with nothing sent). `emailedAt` and
        `secondEmailAt` are when its emails went, `couponCode` the second
        email's coupon, `clickedAt` when a browser first opened its button, and
        `recoveredOrderId` and `recoveredAt` the order that paid: the cart's
        own, or the checkout its button opened.


        Needs the `recovery.read` permission (Read Cart Recovery).
      operationId: cartRecovery.carts
      parameters:
        - name: storeId
          in: path
          required: true
          description: >-
            The store's ID. A key reaches the store it was made in: `GET /key`
            answers which.
          schema:
            type: string
        - name: range
          in: query
          required: false
          description: The period.
          schema:
            type: string
            enum:
              - today
              - yesterday
              - 7d
              - 30d
              - this_week
              - last_week
              - this_month
              - last_month
              - this_year
            default: 30d
        - name: from
          in: query
          required: false
          description: >-
            The first day of a period of your own, as `YYYY-MM-DD`. With `to`,
            in place of `range`.
          schema:
            type: string
        - name: to
          in: query
          required: false
          description: Its last day, as `YYYY-MM-DD`.
          schema:
            type: string
        - name: tz
          in: query
          required: false
          description: The time zone those days are in, as an IANA name. Left out, UTC.
          schema:
            type: string
            example: Europe/Berlin
        - name: show
          in: query
          required: false
          description: Only these.
          schema:
            type: string
            enum:
              - all
              - waiting
              - emailed
              - recovered
              - unsubscribed
              - clicked
            default: all
        - name: search
          in: query
          required: false
          description: Part of a buyer's email.
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: Which page of the list. The first is 1.
          schema:
            type: integer
            default: 1
      responses:
        '200':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        email:
                          type: string
                        total:
                          type: number
                        currency:
                          type: string
                        what:
                          type: string
                        leftAt:
                          type: string
                        state:
                          type: string
                        note:
                          type: string
                        clickedAt:
                          nullable: true
                        emailedAt:
                          nullable: true
                        secondEmailAt:
                          nullable: true
                        couponCode:
                          nullable: true
                        recoveredOrderId:
                          nullable: true
                        recoveredAt:
                          nullable: true
                  pages:
                    type: integer
                  total:
                    type: integer
                  meta:
                    type: object
                    properties:
                      page:
                        type: integer
              example:
                success: true
                message: null
                code: null
                data:
                  - id: 3fece4e5-6aad-4160-b583-a4c4d355d90c
                    email: sam@example.com
                    total: 9.99
                    currency: USD
                    what: Northwind Pro
                    leftAt: '2026-10-22T16:20:19Z'
                    state: waiting
                    note: Declined card email in 15 min
                    clickedAt: null
                    emailedAt: null
                    secondEmailAt: null
                    couponCode: null
                    recoveredOrderId: null
                    recoveredAt: null
                  - id: be860a5c-29b9-481a-806a-0036f9d9cae1
                    email: noor@example.com
                    total: 9.99
                    currency: USD
                    what: Northwind Pro
                    leftAt: '2026-10-22T15:55:19Z'
                    state: waiting
                    note: First email in 35 min
                    clickedAt: null
                    emailedAt: null
                    secondEmailAt: null
                    couponCode: null
                    recoveredOrderId: null
                    recoveredAt: null
                pages: 1
                total: 2
                meta:
                  page: 1
        '401':
          $ref: '#/components/responses/NoKey'
        '403':
          $ref: '#/components/responses/NotAllowed'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooMany'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: |
            import Shoply from "@shoplygg/node";

            const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

            const page = await shoply.cartRecovery.carts();

            // Or every row of every page:
            for await (const row of shoply.cartRecovery.carts()) {
              console.log(row);
            }
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $page = $shoply->cartRecovery->carts();

            // Or every row of every page:
            foreach ($shoply->cartRecovery->carts() as $row) {
                print_r($row);
            }
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            page = client.cartRecovery.carts()

            # Or every row of every page:
            for row in client.cartRecovery.carts():
                print(row)
components:
  responses:
    NoKey:
      description: >-
        No API key was sent, or the one sent is not a live key:
        `api_key_required`, `invalid_api_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotAllowed:
      description: >-
        The key is real and may not do this: `missing_scope` (with
        `requiredScope`), `ip_not_allowed`, `account_unavailable`, or
        `dashboard_only` for something only a person in the dashboard may do.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotFound:
      description: >-
        There is no such thing in this store: `not_found`. A store that is not
        the key's own is answered the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    TooMany:
      description: >-
        The key has used up its budget for now: `rate_limited`. `Retry-After`
        says how many seconds to wait.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
  schemas:
    Refusal:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          description: What is wrong, in words for a person.
        code:
          type: string
          description: What is wrong, as a word that does not change.
        data:
          nullable: true
        errors:
          type: object
          description: >-
            For `validation_failed`: what is wrong with each field, by the
            field's name.
          additionalProperties:
            type: string
      required:
        - success
        - message
        - code
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A secret API key, made under Developers in the dashboard:
        `Authorization: Bearer shoply_sk_...`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.