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

# Criar um produto

> Cria um produto para a empresa autenticada, já com o checkout e a oferta padrão. Formas de entrega que dependem de integração (memberkit, cademi, telegram, discord) exigem a integração configurada antes e respondem 400 sem ela.



## OpenAPI

````yaml /openapi.yaml post /v1/products
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:
    post:
      tags:
        - Catálogo
      summary: Criar um produto
      description: >-
        Cria um produto para a empresa autenticada, já com o checkout e a oferta
        padrão. Formas de entrega que dependem de integração (memberkit, cademi,
        telegram, discord) exigem a integração configurada antes e respondem 400
        sem ela.
      operationId: createProduct
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 160
                  description: Nome do produto exibido no checkout.
                categoryId:
                  type: integer
                  exclusiveMinimum: true
                  minimum: 0
                  description: Categoria do produto (ver `GET /v1/product-categories`).
                price:
                  type: integer
                  minimum: 500
                  description: Preço em centavos (R$ 49,90 = 4990).
                productType:
                  type: string
                  enum:
                    - physical
                    - digital
                    - subscription
                  description: 'Natureza do produto: físico ou digital.'
                deliveryType:
                  type: string
                  enum:
                    - payment
                    - link
                    - shipping
                    - memberkit
                    - ephraClub
                    - astronMembers
                    - cademi
                    - telegram
                    - discord
                  description: Como o comprador recebe o produto após o pagamento.
                billingType:
                  type: string
                  enum:
                    - one_time
                    - subscription
                  default: one_time
                  description: Cobrança única (`one_time`) ou recorrente.
                description:
                  type: string
                  maxLength: 1000
                  description: Descrição livre do produto.
                productorName:
                  type: string
                  maxLength: 100
                  description: Nome do produtor exibido ao comprador.
                supportEmail:
                  type: string
                  format: email
                  description: E-mail de suporte.
                supportPhone:
                  type: string
                  description: Telefone de suporte.
                salesPage:
                  type: string
                  format: uri
                  description: URL da página de vendas.
                refundPeriodDays:
                  anyOf:
                    - type: number
                      enum:
                        - 7
                    - type: number
                      enum:
                        - 15
                    - type: number
                      enum:
                        - 30
                  description: 'Dias de garantia: 7, 15 ou 30.'
              required:
                - name
                - categoryId
                - price
                - productType
                - deliveryType
              additionalProperties: false
            example:
              name: Curso de Tráfego Pago
              categoryId: 1
              price: 49900
              productType: digital
              deliveryType: link
              billingType: one_time
              description: Do primeiro anúncio ao primeiro real faturado.
              salesPage: https://exemplo.com.br/trafego-pago
              supportEmail: suporte@exemplo.com.br
              refundPeriodDays: 7
      responses:
        '201':
          description: Produto criado.
          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.
                      name:
                        type: string
                        description: Nome do produto exibido no checkout.
                      description:
                        type: string
                        nullable: true
                        description: Descrição livre do produto.
                      status:
                        type: string
                        enum:
                          - draft
                          - approved
                          - pending
                          - refused
                          - banned
                        description: Situação do produto na esteira de aprovação.
                      categoryId:
                        type: integer
                        nullable: true
                        description: Categoria do produto.
                      price:
                        type: integer
                        nullable: true
                        description: Preço em centavos (R$ 49,90 = 4990).
                      productType:
                        type: string
                        enum:
                          - physical
                          - digital
                          - subscription
                        description: 'Natureza do produto: físico ou digital.'
                      billingType:
                        type: string
                        enum:
                          - one_time
                          - subscription
                        nullable: true
                        description: Cobrança única (`one_time`) ou recorrente.
                      deliveryType:
                        type: string
                        enum:
                          - payment
                          - link
                          - shipping
                          - memberkit
                          - ephraClub
                          - astronMembers
                          - cademi
                          - telegram
                          - discord
                        description: Como o comprador recebe o produto após o pagamento.
                      imageUrl:
                        type: string
                        nullable: true
                        description: URL pública da imagem de capa.
                      salesPage:
                        type: string
                        nullable: true
                        description: URL da página de vendas do produto.
                      productorName:
                        type: string
                        nullable: true
                        description: Nome do produtor exibido ao comprador.
                      supportEmail:
                        type: string
                        nullable: true
                        description: E-mail de suporte exibido ao comprador.
                      supportPhone:
                        type: string
                        nullable: true
                        description: Telefone de suporte exibido ao comprador.
                      refundPeriodDays:
                        type: integer
                        description: Dias de garantia de reembolso após o pagamento.
                      createdAt:
                        type: string
                        format: date-time
                        description: Momento de criação do produto.
                      updatedAt:
                        type: string
                        format: date-time
                        description: Momento da última alteração.
                    required:
                      - id
                      - name
                      - description
                      - status
                      - categoryId
                      - price
                      - productType
                      - billingType
                      - deliveryType
                      - imageUrl
                      - salesPage
                      - productorName
                      - supportEmail
                      - supportPhone
                      - refundPeriodDays
                      - createdAt
                      - updatedAt
                    additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
                description: Produto criado.
              example:
                success: true
                data:
                  id: clx8a2h4k0001qz0a1b2c3d4e
                  name: Curso de Tráfego Pago
                  description: Do primeiro anúncio ao primeiro real faturado.
                  status: approved
                  categoryId: 1
                  price: 49900
                  productType: digital
                  billingType: one_time
                  deliveryType: link
                  imageUrl: >-
                    https://images.ephra.io/products/clx8a2h4k0001qz0a1b2c3d4e.jpg
                  salesPage: https://exemplo.com.br/trafego-pago
                  productorName: Ana Souza
                  supportEmail: suporte@exemplo.com.br
                  supportPhone: '+5511999999999'
                  refundPeriodDays: 7
                  createdAt: '2026-09-01T13:45:00.000Z'
                  updatedAt: '2026-09-10T08:12:00.000Z'
        '400':
          description: A requisição está bem formada, mas uma regra de negócio a recusou.
          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 está bem formada, mas uma regra de negócio a
                  recusou.
              example:
                success: false
                message: >-
                  Não foi possível concluir: uma regra de negócio recusou os
                  dados enviados.
        '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
        '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

````