> ## 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 Win-Back buyers

> The buyers Win-Back has written to or will within 7 days, the latest to have moved first, 25 a page. A buyer is here once for each time they go quiet. `state` is `due` (`dueAt` says when its first email goes), `first` or `second` (the email it last had), `won` (they ordered within 14 days of an email: `wonOrderId`, `wonAt`, `wonAfter`, `quietDays`), `unsubscribed`, or `stopped` (`stopped` says why: `ordered`, `off`, `audience`, `disputed`, `failed`). `orders` and `spent` are their completed orders at the store, `tags` theirs as on Get a customer, `couponCode` and `couponExpiresAt` the second email's coupon, and `clickedAt` when a browser first opened an email's button.

Needs the `marketing.read` permission (Read Email Marketing).



## OpenAPI

````yaml /api-reference/openapi.json get /stores/{storeId}/win-back/buyers
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}/win-back/buyers:
    get:
      tags:
        - Email Marketing
      summary: List Win-Back buyers
      description: >-
        The buyers Win-Back has written to or will within 7 days, the latest to
        have moved first, 25 a page. A buyer is here once for each time they go
        quiet. `state` is `due` (`dueAt` says when its first email goes),
        `first` or `second` (the email it last had), `won` (they ordered within
        14 days of an email: `wonOrderId`, `wonAt`, `wonAfter`, `quietDays`),
        `unsubscribed`, or `stopped` (`stopped` says why: `ordered`, `off`,
        `audience`, `disputed`, `failed`). `orders` and `spent` are their
        completed orders at the store, `tags` theirs as on Get a customer,
        `couponCode` and `couponExpiresAt` the second email's coupon, and
        `clickedAt` when a browser first opened an email's button.


        Needs the `marketing.read` permission (Read Email Marketing).
      operationId: winBack.buyers
      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: show
          in: query
          required: false
          description: Only these.
          schema:
            type: string
            enum:
              - all
              - due
              - emailed
              - won
              - 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
                        customerId:
                          type: string
                        orders:
                          type: integer
                        spent:
                          type: integer
                        tags:
                          type:
                            - array
                            - object
                        state:
                          type: string
                        stopped:
                          nullable: true
                        lastOrderId:
                          type: string
                        lastOrderAt:
                          type: string
                        what:
                          type: string
                        nextStep:
                          type: string
                        dueAt:
                          type: string
                        emailedAt:
                          nullable: true
                        secondEmailAt:
                          nullable: true
                        clickedAt:
                          nullable: true
                        couponCode:
                          nullable: true
                        couponExpiresAt:
                          nullable: true
                        wonOrderId:
                          nullable: true
                        wonAt:
                          nullable: true
                        wonAfter:
                          nullable: true
                        quietDays:
                          nullable: true
                        unsubscribedAt:
                          nullable: true
                  pages:
                    type: integer
                  total:
                    type: integer
                  meta:
                    type: object
                    properties:
                      page:
                        type: integer
              example:
                success: true
                message: null
                code: null
                data:
                  - id: ba7dde28-5c97-407e-beb8-009cee5397bf
                    email: mira@example.com
                    customerId: aa69d001-1621-42a1-823a-6d654e5d49cb
                    orders: 1
                    spent: 89
                    tags: []
                    state: due
                    stopped: null
                    lastOrderId: 091f818e-ac4c-4244-982b-a03d345f0b1a
                    lastOrderAt: '2026-09-24T16:20:19Z'
                    what: Northwind Pro
                    nextStep: first
                    dueAt: '2026-10-24T16:20:19Z'
                    emailedAt: null
                    secondEmailAt: null
                    clickedAt: null
                    couponCode: null
                    couponExpiresAt: null
                    wonOrderId: null
                    wonAt: null
                    wonAfter: null
                    quietDays: null
                    unsubscribedAt: null
                pages: 1
                total: 1
                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.winBack.buyers();

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

            require 'vendor/autoload.php';

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

            $page = $shoply->winBack->buyers();

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

            client = shoply.Client()  # reads SHOPLY_API_KEY

            page = client.winBack.buyers()

            # Or every row of every page:
            for row in client.winBack.buyers():
                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.