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

# Consultar produto do marketplace

> Devolve a página de um produto do marketplace: ofertas, percentual de comissão, página de vendas e suporte do produtor, mais a situação da SUA afiliação a ele. É o que você lê antes de decidir pedir afiliação. Responde 404 quando o produto não está exposto na vitrine.



## OpenAPI

````yaml /openapi.yaml get /v1/marketplace/products/{productId}
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/marketplace/products/{productId}:
    get:
      tags:
        - Crescimento
      summary: Consultar produto do marketplace
      description: >-
        Devolve a página de um produto do marketplace: ofertas, percentual de
        comissão, página de vendas e suporte do produtor, mais a situação da SUA
        afiliação a ele. É o que você lê antes de decidir pedir afiliação.
        Responde 404 quando o produto não está exposto na vitrine.
      operationId: getMarketplaceProduct
      parameters:
        - schema:
            type: string
            minLength: 1
          in: path
          name: productId
          required: true
          description: Identificador do produto no marketplace.
      responses:
        '200':
          description: Produto do marketplace.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `true` em uma resposta bem-sucedida.
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Identificador do produto no marketplace.
                      name:
                        type: string
                        description: Nome do produto.
                      companyName:
                        type: string
                        description: Empresa produtora dona do produto.
                      imageUrl:
                        type: string
                        nullable: true
                        description: URL pública da imagem de capa.
                      price:
                        type: integer
                        description: >-
                          Preço da oferta padrão em centavos (R$ 499,00 =
                          49900).
                      commission:
                        type: integer
                        description: >-
                          Quanto o afiliado ganha por venda da oferta padrão, em
                          centavos.
                      slug:
                        type: string
                        nullable: true
                        description: >-
                          Slug público do produto — é o `productSlug` de `POST
                          /v1/affiliations`.
                      description:
                        type: string
                        nullable: true
                        description: Descrição do produto.
                      categoryName:
                        type: string
                        nullable: true
                        description: Categoria do produto.
                      deliveryType:
                        type: string
                        enum:
                          - payment
                          - link
                          - shipping
                          - memberkit
                          - ephraClub
                          - astronMembers
                          - cademi
                          - telegram
                          - discord
                        description: Como o comprador recebe o produto após o pagamento.
                      salesPage:
                        type: string
                        nullable: true
                        description: URL da página de vendas que o afiliado vai divulgar.
                      supportEmail:
                        type: string
                        nullable: true
                        description: E-mail de suporte do produtor para os afiliados.
                      commissionPercentage:
                        type: integer
                        nullable: true
                        description: >-
                          Percentual de comissão do programa de afiliados, de 0
                          a 100.
                      affiliationStatus:
                        type: string
                        enum:
                          - open
                          - pending
                          - approved
                          - rejected
                          - inactive
                        description: >-
                          Situação da SUA afiliação a este produto. `open`
                          quando você ainda não pediu.
                      offers:
                        type: array
                        items:
                          type: object
                          properties:
                            title:
                              type: string
                              description: Título da oferta.
                            price:
                              type: integer
                              description: Preço da oferta em centavos.
                          required:
                            - title
                            - price
                          additionalProperties: false
                        description: >-
                          Ofertas do produto, para dimensionar o ticket antes de
                          se afiliar.
                    required:
                      - id
                      - name
                      - companyName
                      - imageUrl
                      - price
                      - commission
                      - slug
                      - description
                      - categoryName
                      - deliveryType
                      - salesPage
                      - supportEmail
                      - commissionPercentage
                      - affiliationStatus
                      - offers
                    additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
                description: Produto do marketplace.
              example:
                success: true
                data:
                  id: clx8a2h4k0001qz0a1b2c3d4e
                  name: Curso de Tráfego Pago
                  companyName: Ephra Educação Ltda
                  imageUrl: >-
                    https://images.ephra.io/products/clx8a2h4k0001qz0a1b2c3d4e.jpg
                  price: 49900
                  commission: 19960
                  slug: trafego-pago
                  description: Do primeiro anúncio ao primeiro real faturado.
                  categoryName: Cursos e Treinamentos
                  deliveryType: link
                  salesPage: https://exemplo.com.br/trafego-pago
                  supportEmail: afiliados@exemplo.com.br
                  commissionPercentage: 40
                  affiliationStatus: open
                  offers:
                    - title: Curso de Tráfego Pago — à vista
                      price: 49900
                    - title: Curso de Tráfego Pago + Mentoria
                      price: 129900
        '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: Recurso 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

````