> ## 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.

# Get Cart Recovery

> Cart Recovery's settings as `data`. `meta.figures` is the period's four figures: what it recovered, the checkouts left and what was in them, the share of emailed carts recovered, and the emails sent with how many buyers clicked and unsubscribed, each with the period before. `meta.set` is false where the store has never set it up, `meta.sendable` whether the store can send email at all, and `meta.choices` the delays and discounts each setting may take.

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



## OpenAPI

````yaml /api-reference/openapi.json get /stores/{storeId}/cart-recovery
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:
    get:
      tags:
        - Cart Recovery
      summary: Get Cart Recovery
      description: >-
        Cart Recovery's settings as `data`. `meta.figures` is the period's four
        figures: what it recovered, the checkouts left and what was in them, the
        share of emailed carts recovered, and the emails sent with how many
        buyers clicked and unsubscribed, each with the period before. `meta.set`
        is false where the store has never set it up, `meta.sendable` whether
        the store can send email at all, and `meta.choices` the delays and
        discounts each setting may take.


        Needs the `recovery.read` permission (Read Cart Recovery).
      operationId: cartRecovery.show
      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
      responses:
        '200':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: object
                    properties:
                      enabled:
                        type: boolean
                      firstOn:
                        type: boolean
                      firstMinutes:
                        type: integer
                      firstSubject:
                        type: string
                      declinedOn:
                        type: boolean
                      declinedMinutes:
                        type: integer
                      declinedSubject:
                        type: string
                      secondOn:
                        type: boolean
                      secondMinutes:
                        type: integer
                      secondSubject:
                        type: string
                      secondPercent:
                        type: integer
                  meta:
                    type: object
                    properties:
                      set:
                        type: boolean
                      sendable:
                        type: boolean
                      figures:
                        type: object
                        properties:
                          recovered:
                            type: object
                            properties:
                              revenue:
                                type: integer
                              orders:
                                type: integer
                              by:
                                type: object
                                properties:
                                  first:
                                    type: object
                                    properties:
                                      revenue:
                                        type: integer
                                      orders:
                                        type: integer
                                  declined:
                                    type: object
                                    properties:
                                      revenue:
                                        type: integer
                                      orders:
                                        type: integer
                                  second:
                                    type: object
                                    properties:
                                      revenue:
                                        type: integer
                                      orders:
                                        type: integer
                          recoveredBefore:
                            type: integer
                          left:
                            type: object
                            properties:
                              count:
                                type: integer
                              total:
                                type: number
                          rate:
                            nullable: true
                          emailedCarts:
                            type: integer
                          clicked:
                            type: integer
                          sent:
                            type: integer
                          unsubscribed:
                            type: integer
                      choices:
                        type: object
                        properties:
                          firstMinutes:
                            type: array
                            items:
                              type: integer
                          declinedMinutes:
                            type: array
                            items:
                              type: integer
                          secondMinutes:
                            type: array
                            items:
                              type: integer
                          percents:
                            type: array
                            items:
                              type: integer
                          couponHours:
                            type: integer
              example:
                success: true
                message: null
                code: null
                data:
                  enabled: true
                  firstOn: true
                  firstMinutes: 60
                  firstSubject: ''
                  declinedOn: true
                  declinedMinutes: 15
                  declinedSubject: ''
                  secondOn: true
                  secondMinutes: 1200
                  secondSubject: ''
                  secondPercent: 10
                meta:
                  set: true
                  sendable: true
                  figures:
                    recovered:
                      revenue: 0
                      orders: 0
                      by:
                        first:
                          revenue: 0
                          orders: 0
                        declined:
                          revenue: 0
                          orders: 0
                        second:
                          revenue: 0
                          orders: 0
                    recoveredBefore: 0
                    left:
                      count: 2
                      total: 19.98
                    rate: null
                    emailedCarts: 0
                    clicked: 0
                    sent: 0
                    unsubscribed: 0
                  choices:
                    firstMinutes:
                      - 30
                      - 60
                    declinedMinutes:
                      - 5
                      - 15
                    secondMinutes:
                      - 720
                      - 1200
                    percents:
                      - 0
                      - 5
                    couponHours: 48
        '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 result = await shoply.cartRecovery.show();
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

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

            $result = $shoply->cartRecovery->show();
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.cartRecovery.show()
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.