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

# Definir ofertas do checkout

> Substitui, de uma vez, o conjunto de ofertas que este checkout vende e diz qual delas abre pela URL. A ordem do array é a ordem em que o comprador vê os preços na página. Oferta que sai da lista volta ao escopo do produto; oferta presa a outro checkout é recusada com 400 em vez de roubada. Responde 404 quando o checkout pertence a outra empresa.



## OpenAPI

````yaml /openapi.yaml put /v1/checkouts/{checkoutId}/offers
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/checkouts/{checkoutId}/offers:
    put:
      tags:
        - Checkout
      summary: Definir ofertas do checkout
      description: >-
        Substitui, de uma vez, o conjunto de ofertas que este checkout vende e
        diz qual delas abre pela URL. A ordem do array é a ordem em que o
        comprador vê os preços na página. Oferta que sai da lista volta ao
        escopo do produto; oferta presa a outro checkout é recusada com 400 em
        vez de roubada. Responde 404 quando o checkout pertence a outra empresa.
      operationId: setCheckoutOffers
      parameters:
        - schema:
            type: string
            minLength: 1
          in: path
          name: checkoutId
          required: true
          description: Identificador do checkout.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                offerIds:
                  type: array
                  items:
                    type: integer
                    exclusiveMinimum: true
                    minimum: 0
                  maxItems: 50
                  description: >-
                    Conjunto completo de ofertas do checkout, na ordem de
                    exibição. A lista substitui a anterior.
                defaultOfferId:
                  type: integer
                  exclusiveMinimum: true
                  minimum: 0
                  nullable: true
                  description: >-
                    Oferta que abre pela URL do checkout. Omitir mantém a atual,
                    se ela continuar disponível.
              required:
                - offerIds
              additionalProperties: false
            example:
              offerIds:
                - 4821
                - 4822
              defaultOfferId: 4821
      responses:
        '200':
          description: Ofertas vinculadas ao checkout depois da troca.
          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 checkout.
                      defaultOfferId:
                        type: integer
                        nullable: true
                        description: Oferta que abre pela URL do checkout.
                      offers:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              description: Identificador da oferta.
                            slug:
                              type: string
                              description: Identificador curto da oferta na URL de venda.
                            title:
                              type: string
                              description: Nome da oferta exibido ao comprador.
                            price:
                              type: integer
                              description: Preço em centavos (R$ 499,00 = 49900).
                            isDefault:
                              type: boolean
                              description: Se é a oferta padrão do produto.
                            active:
                              type: boolean
                              description: Se a oferta está vendendo.
                            promotional:
                              type: boolean
                              description: Se a oferta é promocional e some quando expira.
                            frequency:
                              type: string
                              enum:
                                - weekly
                                - monthly
                                - bimonthly
                                - quarterly
                                - semiannual
                                - annual
                              nullable: true
                              description: >-
                                Periodicidade da cobrança quando a oferta é
                                assinatura.
                            expiresAt:
                              type: string
                              format: date-time
                              nullable: true
                              description: Momento em que a oferta deixa de valer.
                            sortOrder:
                              type: integer
                              description: >-
                                Posição da oferta na página, do menor para o
                                maior.
                          required:
                            - id
                            - slug
                            - title
                            - price
                            - isDefault
                            - active
                            - promotional
                            - frequency
                            - expiresAt
                            - sortOrder
                          additionalProperties: false
                        description: Ofertas vinculadas ao checkout, na ordem de exibição.
                    required:
                      - id
                      - defaultOfferId
                      - offers
                    additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
                description: Ofertas vinculadas ao checkout depois da troca.
              example:
                success: true
                data:
                  id: clx9f1m2p0004qz0a7h8j9k0l
                  defaultOfferId: 4821
                  offers:
                    - id: 4821
                      slug: trafego-pago-anual
                      title: Plano anual
                      price: 149900
                      isDefault: true
                      active: true
                      promotional: false
                      frequency: annual
                      expiresAt: null
                      sortOrder: 0
                    - id: 4822
                      slug: trafego-pago-mensal
                      title: Plano mensal
                      price: 14900
                      isDefault: false
                      active: true
                      promotional: false
                      frequency: monthly
                      expiresAt: null
                      sortOrder: 1
        '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
        '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: Checkout 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

````