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

# Criar upsell



## OpenAPI

````yaml /openapi.json post /api/v1/upsells
openapi: 3.0.3
info:
  title: Corvex API
  version: 1.0.0
  description: >-
    API pública da Corvex para gerenciar catálogo, pedidos, checkout marketing,
    webhooks, clientes e leads. Autenticação exclusiva por API Key
    (`Authorization: Bearer cvx_live_...`).
servers:
  - url: https://apiv3.usecorvex.com.br
    description: Produção
  - url: http://localhost:3333
    description: Desenvolvimento local
security:
  - bearerAuth: []
tags:
  - name: Checkout externo
    description: >-
      Criar link de pagamento a partir de um carrinho no seu site. Autenticação
      com `x-api-key` do painel (não é a API v1 `cvx_live_...`).
  - name: Produtos
    description: >-
      Catálogo da loja. Variantes aparecem só na consulta por id, em modo
      leitura.
  - name: Coleções
    description: Categorias da loja. Use para agrupar produtos na vitrine.
  - name: Kits
    description: Pacotes de produtos vendidos juntos.
  - name: Pedidos
    description: Pedidos da loja. Criar pedido continua no checkout, não nesta API.
  - name: Rastreio
    description: Envios e códigos de rastreio.
  - name: Carrinhos abandonados
    description: Checkouts iniciados e não concluídos.
  - name: Clientes
    description: Compradores agrupados por documento.
  - name: Leads
    description: Contatos capturados na loja virtual.
  - name: Order bumps
    description: Ofertas extras no checkout.
  - name: Brindes
    description: Brindes liberados por regras de carrinho.
  - name: Upsell one-click
    description: Oferta pós-compra com um clique.
  - name: Cupons
    description: 'Cupons de desconto. Não há exclusão: altere o status.'
  - name: Faixas de desconto
    description: Desconto progressivo por valor ou quantidade.
  - name: Desconto por pagamento
    description: Percentual por PIX, cartão ou boleto. Um desconto por método.
  - name: Webhooks
    description: >-
      URLs chamadas quando eventos da loja acontecem. O secret nunca é
      devolvido.
  - name: Automações
    description: >-
      Fluxos, templates de mensagem e metatags. Automações novas nascem
      desativadas (`active: false`).
paths:
  /api/v1/upsells:
    post:
      tags:
        - Upsell one-click
      summary: Criar upsell
      operationId: createUpsell
      parameters:
        - $ref: '#/components/parameters/StoreId'
      requestBody:
        required: true
        content:
          application/json:
            example:
              name: Upgrade kit
              triggerAnyProduct: false
              triggerProductIds:
                - 22222222-2222-4222-8222-222222222222
              offerProductId: 22222222-2222-4222-8222-222222222222
              offerVariantId: null
              price: 39.9
              discountPercent: null
              discountAmount: null
              title: Leve o kit com desconto
              description: null
              buttonText: Quero essa oferta
              active: true
            schema:
              type: object
              required:
                - name
                - offerProductId
                - title
              properties:
                name:
                  type: string
                  minLength: 3
                  maxLength: 200
                  description: Nome interno.
                triggerAnyProduct:
                  type: boolean
                  description: >-
                    true = dispara após qualquer produto. false usa
                    triggerProductIds.
                triggerProductIds:
                  type: array
                  items:
                    type: string
                    format: uuid
                  description: >-
                    Produtos que disparam o upsell. Vazio se triggerAnyProduct é
                    true.
                offerProductId:
                  type: string
                  format: uuid
                  description: Produto oferecido no one-click.
                offerVariantId:
                  type: string
                  nullable: true
                  format: uuid
                  description: Variante específica. null = produto sem variante.
                price:
                  type: number
                  nullable: true
                  minimum: 0
                  description: Preço da oferta. null se usar só desconto.
                discountPercent:
                  type: number
                  nullable: true
                  minimum: 0
                  maximum: 100
                  description: Desconto percentual. null se não usar.
                discountAmount:
                  type: number
                  nullable: true
                  minimum: 0
                  description: Desconto em reais. null se não usar.
                title:
                  type: string
                  minLength: 3
                  maxLength: 200
                  description: Título no checkout.
                description:
                  type: string
                  nullable: true
                  maxLength: 1000
                buttonText:
                  type: string
                  minLength: 3
                  maxLength: 100
                active:
                  type: boolean
      responses:
        '201':
          description: Criado.
          content:
            application/json:
              example:
                success: true
                data:
                  upsell:
                    id: 88888888-8888-4888-8888-888888888888
                    storeId: 11111111-1111-4111-8111-111111111111
                    name: Upgrade kit
                    triggerAnyProduct: false
                    triggerProductIds:
                      - 22222222-2222-4222-8222-222222222222
                    offerProductId: 22222222-2222-4222-8222-222222222222
                    offerProductName: Kit completo
                    offerVariantId: null
                    price: 39.9
                    discountPercent: null
                    discountAmount: null
                    title: Leve o kit com desconto
                    description: null
                    buttonText: Quero essa oferta
                    active: true
                    createdAt: '2026-09-24T14:00:00.000Z'
                    updatedAt: '2026-09-24T14:00:00.000Z'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    StoreId:
      name: X-Store-Id
      in: header
      required: true
      schema:
        type: string
        format: uuid
      description: UUID da loja. A chave precisa ter esta loja autorizada.
      example: 11111111-1111-4111-8111-111111111111
  responses:
    ValidationError:
      description: Header `X-Store-Id`, query ou body inválidos.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            success: false
            error:
              message: X-Store-Id deve ser um UUID válido
              code: VALIDATION_ERROR
            meta:
              timestamp: '2026-09-24T14:00:00.000Z'
              status: 400
    Unauthorized:
      description: API Key ausente, inválida, expirada ou revogada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            success: false
            error:
              message: >-
                Esta rota exige uma API Key. Use Authorization: Bearer
                cvx_live_...
              code: AUTH_API_KEY_REQUIRED
            meta:
              timestamp: '2026-09-24T14:00:00.000Z'
              status: 401
    Forbidden:
      description: >-
        Falta o escopo desta operação (`AUTH_SCOPE_DENIED`) ou a loja não está
        autorizada na chave (`AUTH_STORE_ACCESS_DENIED`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            success: false
            error:
              message: Sua API Key não tem o escopo necessário para esta operação.
              code: AUTH_SCOPE_DENIED
            meta:
              timestamp: '2026-09-24T14:00:00.000Z'
              status: 403
    RateLimited:
      description: Muitas requisições. Respeite Retry-After.
      headers:
        Retry-After:
          schema:
            type: integer
          description: Segundos até poder tentar de novo.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
              error:
                type: string
                example: RATE_LIMITED
              retryAfter:
                type: integer
          example:
            success: false
            message: Muitas requisições. Tente novamente em instantes.
            error: RATE_LIMITED
            retryAfter: 12
  schemas:
    ErrorBody:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
            details: {}
        meta:
          type: object
          properties:
            timestamp:
              type: string
              format: date-time
            status:
              type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key no formato `cvx_live_...`, criada no painel Corvex. Não use JWT
        de sessão nem `x-api-key`.

````