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

# Listar checkouts de um produto

> Lista as páginas de checkout associadas a um produto da empresa autenticada, com paginação, para o vendedor escolher qual editar ou divulgar — é a listagem que alimenta um teste A/B, em que o mesmo produto vende por mais de uma página. A geração de cada checkout vem no campo `version`. Responde 404 quando o produto não existe ou pertence a outra empresa.



## OpenAPI

````yaml /openapi.yaml get /v1/products/{productId}/checkouts
openapi: 3.0.3
info:
  title: Ephra API
  description: >-
    API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks
    e a API do vendedor sobre catálogo, checkout, vendas, reembolsos,
    financeiro, crescimento e plataforma.


    **Limite de requisições.** 1000 requisições por minuto por IP de origem.
    Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e
    `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a
    resposta é `429` com `retry-after`.


    **Erros.** Toda falha responde o mesmo envelope: `{ "success": false,
    "message": "..." }`.
  version: 1.0.0
servers:
  - url: https://api.ephra.io
    description: Servidor de produção
security: []
tags:
  - name: Catálogo
    description: Produtos, ofertas, categorias e cupons — o que a empresa vende.
  - name: Checkout
    description: Checkouts, order bumps, upsells e links de pagamento.
  - name: Vendas
    description: Vendas, clientes, assinaturas e entregas já realizadas.
  - name: Reembolsos
    description: Pedidos de reembolso, contestações e o quiz de retenção.
  - name: Financeiro
    description: Saldo, saques, antecipações, taxas e extratos da empresa.
  - name: Crescimento
    description: Afiliados, coprodução, indicações, pixels e integrações de marketing.
  - name: Plataforma
    description: Conta, membros, chaves de API, webhooks e configurações gerais.
paths:
  /v1/products/{productId}/checkouts:
    get:
      tags:
        - Checkout
      summary: Listar checkouts de um produto
      description: >-
        Lista as páginas de checkout associadas a um produto da empresa
        autenticada, com paginação, para o vendedor escolher qual editar ou
        divulgar — é a listagem que alimenta um teste A/B, em que o mesmo
        produto vende por mais de uma página. A geração de cada checkout vem no
        campo `version`. Responde 404 quando o produto não existe ou pertence a
        outra empresa.
      operationId: listProductCheckouts
      parameters:
        - schema:
            type: integer
            minimum: 1
            default: 1
          in: query
          name: page
          required: false
          description: Página desejada, começando em 1.
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
          in: query
          name: pageSize
          required: false
          description: Quantidade de itens por página (máximo 100).
        - schema:
            type: string
            minLength: 1
          in: path
          name: productId
          required: true
          description: Identificador do produto.
      responses:
        '200':
          description: Página de checkouts do produto.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `true` em uma resposta bem-sucedida.
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Identificador do checkout.
                        version:
                          type: string
                          enum:
                            - v1
                            - v2
                          description: >-
                            Geração do construtor que criou o checkout: `v1`
                            (antigo) ou `v2` (atual).
                        checkoutName:
                          type: string
                          description: >-
                            Nome interno do checkout, usado pelo vendedor para
                            diferenciar variações.
                        productId:
                          type: string
                          description: Produto ao qual o checkout pertence.
                        active:
                          type: boolean
                          description: >-
                            `false` quando o checkout foi excluído e parou de
                            atender no link público.
                        slug:
                          type: string
                          nullable: true
                          description: >-
                            Identificador curto do checkout na URL pública. Só
                            em checkouts `v2`.
                        isDefault:
                          type: boolean
                          nullable: true
                          description: >-
                            Se este é o checkout padrão do produto. Só em
                            checkouts `v1`; `null` em `v2`.
                        defaultOfferId:
                          type: integer
                          nullable: true
                          description: Oferta que abre pela URL do checkout. Só em `v2`.
                        imageUrl:
                          type: string
                          nullable: true
                          description: Imagem do produto exibida na página do checkout.
                        createdAt:
                          type: string
                          format: date-time
                          description: Momento de criação do checkout.
                        updatedAt:
                          type: string
                          format: date-time
                          description: Momento da última alteração.
                      required:
                        - id
                        - version
                        - checkoutName
                        - productId
                        - active
                        - slug
                        - isDefault
                        - defaultOfferId
                        - imageUrl
                        - createdAt
                        - updatedAt
                      additionalProperties: false
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                        description: Página devolvida.
                      pageSize:
                        type: integer
                        description: Itens por página pedidos.
                      total:
                        type: integer
                        description: Total de itens que satisfazem o filtro.
                      totalPages:
                        type: integer
                        description: Total de páginas disponíveis.
                    required:
                      - page
                      - pageSize
                      - total
                      - totalPages
                    additionalProperties: false
                required:
                  - success
                  - data
                  - pagination
                additionalProperties: false
                description: Página de checkouts do produto.
              example:
                success: true
                data:
                  - id: clx9f1m2p0004qz0a7h8j9k0l
                    version: v2
                    checkoutName: Checkout principal
                    productId: clx8a2h4k0001qz0a1b2c3d4e
                    active: true
                    slug: trafego-pago-2026
                    isDefault: null
                    defaultOfferId: 4821
                    imageUrl: >-
                      https://images.ephra.io/checkouts/clx9f1m2p0004qz0a7h8j9k0l.jpg
                    createdAt: '2026-09-02T10:15:00.000Z'
                    updatedAt: '2026-09-11T17:40:00.000Z'
                pagination:
                  page: 1
                  pageSize: 10
                  total: 1
                  totalPages: 1
        '401':
          description: Token ausente, inválido, expirado ou de empresa bloqueada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: Token ausente, inválido, expirado ou de empresa bloqueada.
              example:
                success: false
                message: Token inválido ou expirado
        '404':
          description: O recurso não existe, foi excluído ou pertence a outra empresa.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  O recurso não existe, foi excluído ou pertence a outra
                  empresa.
              example:
                success: false
                message: Produto não encontrado
        '422':
          description: A requisição não passou na validação de schema.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: A requisição não passou na validação de schema.
              example:
                success: false
                message: 'name: Nome é obrigatório'
        '429':
          description: >-
            Requisições demais: o limite é de 1000 requisições por minuto por IP
            de origem. Espere o número de segundos do header `retry-after` e
            repita com recuo exponencial.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Requisições demais: o limite é de 1000 requisições por minuto
                  por IP de origem. Espere o número de segundos do header
                  `retry-after` e repita com recuo exponencial.
              example:
                success: false
                message: Muitas requisições. Tente novamente em breve.
          headers:
            retry-after:
              $ref: '#/components/headers/retry-after'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-reset:
              $ref: '#/components/headers/x-ratelimit-reset'
        '500':
          description: >-
            Falha interna ao processar a requisição. Repita; se persistir, abra
            chamado com o horário e a rota.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Falha interna ao processar a requisição. Repita; se persistir,
                  abra chamado com o horário e a rota.
              example:
                success: false
                message: Erro interno do servidor
      security:
        - bearerAuth: []
components:
  headers:
    retry-after:
      description: Segundos a esperar antes de repetir a requisição.
      schema:
        type: integer
    x-ratelimit-limit:
      description: Teto de requisições na janela (1000). Presente em toda resposta.
      schema:
        type: integer
    x-ratelimit-remaining:
      description: >-
        Quantas requisições ainda cabem na janela atual. Presente em toda
        resposta.
      schema:
        type: integer
    x-ratelimit-reset:
      description: Segundos até o contador da janela zerar. Presente em toda resposta.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````