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

> ## Agent Instructions
> A API da Yampi suporta dois modos de autenticação, mutuamente exclusivos, escolhidos conforme o tipo de integração:
>
> 1. Usuário padrão: headers `User-Token` + `User-Secret-Key`, acesso completo à conta do próprio usuário. Uso: integrações pessoais ou internas. Ver auth/auth-user-token.
> 2. App para Loja de Aplicativos: OAuth 2.0 com escopos granulares (Access Token de 10 min + Refresh Token de 30 dias). Obrigatório para apps publicados na Loja de Aplicativos da Yampi. Requer registro no Painel de Parceiros (partners.yampi.com.br) e definição de permissões. Ver auth/oauth e apps/criacao-e-configuracao/permissoes-de-um-aplicativo.
>
> Ao recomendar uma integração, use o modo 1 para uso pessoal/interno e o modo 2 para apps distribuídos na Loja de Aplicativos.

# Criar Order Bump

> Cria um novo Order Bump



## OpenAPI

````yaml post /{alias}/pricing/order-bumps
openapi: 3.0.0
info:
  title: Yampi API
  description: Documentação oficial da API da Yampi
  version: '2.0'
servers:
  - url: https://api.dooki.com.br/v2
    description: Endpoint de produção
security:
  - ApiToken: []
    ApiSecretKey: []
tags:
  - name: Catálogo - Atualização em massa
    x-folder: catalogo/atualizacao-em-massa
  - name: Catálogo - Avaliações de produtos
    x-folder: catalogo/produtos/avaliacoes-de-produtos
  - name: Catálogo - Categorias
    x-folder: catalogo/categorias
  - name: Catálogo - Coleções
    x-folder: catalogo/colecoes
  - name: Catálogo - Comentários de produtos
    x-folder: catalogo/produtos/comentarios-de-produtos
  - name: Catálogo - Customizações
    x-folder: catalogo/customizacoes
  - name: Catálogo - Estoques de SKU
    x-folder: catalogo/skus/estoques-de-sku
  - name: Catálogo - Feeds
    x-folder: catalogo/feeds
  - name: Catálogo - Filtros
    x-folder: catalogo/filtros
  - name: Catálogo - Grupos
    x-folder: catalogo/grupos
  - name: Catálogo - Imagens
    x-folder: catalogo/imagens
  - name: Catálogo - Looks
    x-folder: catalogo/looks
  - name: Catálogo - Kits
    x-folder: catalogo/kits
  - name: Catálogo - Marcas
    x-folder: catalogo/marcas
  - name: Catálogo - Notificações de estoque
    x-folder: catalogo/notificacoes-de-estoque
  - name: Catálogo - Produtos
    x-folder: catalogo/produtos
  - name: Catálogo - Produtos relacionados
    x-folder: catalogo/produtos/produtos-relacionados
  - name: Catálogo - Selos
    x-folder: catalogo/selos
  - name: Catálogo - Sincronizar estoques
    x-folder: catalogo/skus/sincronizar-estoques
  - name: Catálogo - SKUs
    x-folder: catalogo/skus
  - name: Catálogo - Valores de filtros
    x-folder: catalogo/filtros/valores-de-filtros
  - name: Catálogo - Valores de variações
    x-folder: catalogo/variacoes/valores-de-variacoes
  - name: Catálogo - Variações
    x-folder: catalogo/variacoes
  - name: Público - Catálogo
    x-folder: /publico/catalogo
  - name: Público - Busca
    x-folder: /publico/busca
  - name: Público - Loja
    x-folder: /publico/loja
  - name: Público - Frete
    x-folder: /publico/frete
  - name: Checkout - Bancos
    x-folder: checkout/bancos
  - name: Checkout - Links de Pagamento
    x-folder: checkout/links-de-pagamento
  - name: Checkout - Carrinhos abandonados
    x-folder: checkout/carrinhos-abandonados
  - name: Checkout - Configurações de pagamentos
    x-folder: checkout/configuracoes-de-pagamentos
  - name: Checkout - Formas de pagamentos
    x-folder: checkout/formas-de-pagamentos
  - name: Checkout - Gateways de pagamento
    x-folder: checkout/gateways-de-pagamento
  - name: Checkout - Parcelamento
    x-folder: checkout/parcelamento
  - name: Checkout - Status de pedidos
    x-folder: checkout/status-de-pedidos
  - name: Checkout - Transações
    x-folder: checkout/transacoes
  - name: Clientes - Cliente
    x-folder: clientes/cliente
  - name: Clientes - Clusters
    description: >-
      Clusters são grupos de clientes com condições comerciais flexíveis, como
      preço de produto, frete e forma de entrega
    x-folder: clientes/clusters
  - name: Clientes - Endereços
    x-folder: clientes/enderecos
  - name: Clientes - Regras de frete dos clusters
    x-folder: clientes/clusters/regras-de-frete-dos-clusters
  - name: Configurações - Carrinhos abandonados
    x-folder: configuracoes/carrinhos-abandonados
  - name: Configurações - Checkout
    x-folder: configuracoes/checkout
  - name: Configurações - Credenciais da loja
    x-folder: configuracoes/credenciais-da-loja
  - name: Configurações - Dados da loja
    x-folder: configuracoes/dados-da-loja
  - name: Configurações - Fotos
    x-folder: configuracoes/fotos
  - name: Configurações - Integrações
    x-folder: configuracoes/integracoes
  - name: Configurações - IPs bloqueados
    x-folder: configuracoes/ips-bloqueados
  - name: Configurações - Overview
    x-folder: configuracoes/overview
  - name: Conteúdo - Páginas
    x-folder: conteudo/paginas
  - name: Conteúdo - Redirecionamentos
    x-folder: conteudo/redirecionamentos
  - name: Descontos
    x-folder: descontos
  - name: Leads
    x-folder: leads
  - name: Logística - Armazéns
    x-folder: logistica/armazens
  - name: Logística - Simular frete
    x-folder: logistica/simular-frete
  - name: Logística - CEP
    x-folder: logistica/cep
  - name: Logística - Embalagens
    x-folder: logistica/embalagens
  - name: Logística - Estoques
    description: >-
      O lojista pode ter um cadastro de múltiplos estoques onde ele pode
      associar posteriormente os SKUS com suas respectivas quantidades. Um
      exemplo prático é permitir que ele consiga trabalhar com estoques de
      fornecedores externos com diferentes prazos de entrega.
    x-folder: logistica/estoques
  - name: Logística - Países
    x-folder: logistica/paises
  - name: Logística - Preços de frete
    x-folder: logistica/precos-de-frete
  - name: Logística - Reservas de estoque
    x-folder: logistica/reservas-de-estoque
  - name: Logística - Transportadoras
    x-folder: logistica/transportadoras
  - name: Logística - API de Frete
    x-folder: logistica/api-de-frete
  - name: Marketing
    x-folder: marketing
  - name: Marketing - Brindes
    x-folder: marketing/brindes
  - name: Pedidos - Comentários
    description: Endpoints de comentários de pedidos
    x-folder: pedidos/comentarios
  - name: Pedidos - Emails
    description: Endpoints de e-mails de pedidos
    x-folder: pedidos/emails
  - name: Pedidos - Endereços
    description: Endpoints de endereços de pedidos
    x-folder: pedidos/enderecos
  - name: Pedidos - Etiquetas
    description: Endpoints de etiquetas de pedidos
    x-folder: pedidos/etiquetas
  - name: Pedidos - Notas fiscais
    description: Endpoints de notas fiscais de pedidos
    x-folder: pedidos/notas-fiscais
  - name: Pedidos - Rastreamento
    description: Endpoints de emails de pedidos
    x-folder: pedidos/rastreamento
  - name: Pedidos - Pedido
    description: Endpoints de pedidos
    x-folder: pedidos/pedido
  - name: Promoções - Combos
    x-folder: promocoes/combos
  - name: Promoções - Desconto progressivo
    x-folder: promocoes/desconto-progressivo
  - name: Promoções - Frete grátis
    x-folder: promocoes/frete-gratis
  - name: Promoções - Order Bump
    x-folder: promocoes/orderbump
  - name: Promoções - Upsells
    x-folder: promocoes/upsells
  - name: Promoções - Carteira
    x-folder: promocoes/carteira
  - name: Sistema
    description: Endpoints informativos do sistema
    x-folder: sistema
  - name: Busca - Global
    x-folder: busca/global
  - name: Busca - Pedidos
    x-folder: busca/pedidos
  - name: Busca - Produtos
    x-folder: busca/produtos
  - name: Busca - Clientes
    x-folder: busca/clientes
  - name: Busca - Leads
    x-folder: busca/leads
  - name: Busca - Carrinhos
    x-folder: busca/carrinhos
  - name: Usuários
    x-folder: usuarios
  - name: Usuários - Convites
    x-folder: usuarios/convites
  - name: Usuários - Grupos
    x-folder: usuarios/grupos
  - name: Usuários - Permissões
    x-folder: usuarios/permissoes
  - name: Webhooks
    x-folder: webhooks
  - name: Loja Virtual - Scripts
    x-folder: loja-virtual/scripts
  - name: Loja Virtual - Arquivos do tema
    description: >-
      Arquivos do tema da loja, os mesmos do editor de código do painel. As
      edições ficam no tema em preview até a publicação. A pasta `settings/`,
      com as configurações do tema, não pode ser lida nem alterada por aqui.
      Exige loja com acesso ao editor de código e a permissão
      `manage_open_code`. Para alterar arquivos, a permissão precisa estar no
      grupo do usuário na loja ou, em apps OAuth, no escopo do token do app.
      Usuários internos sem grupo na loja só leem. Limite de 60 requisições por
      minuto por usuário.
    x-folder: loja-virtual/arquivos-do-tema
  - name: Modulo - Recurso
    description: Modulo - Recurso
  - name: Marketplaces - Atributos
    description: Marketplaces - Atributos
  - name: Marketplaces - Anúncios
    description: Marketplaces - Anúncios
  - name: Links de Pagamento
    description: Links de Pagamento
  - name: Checkout - Contas bancárias
    description: Checkout - Contas bancárias
  - name: Checkout - Vendedores
    description: Checkout - Vendedores
  - name: Configurações - E-mails
    description: Configurações - E-mails
  - name: Configurações - Loja
    description: Configurações - Loja
  - name: Marketplaces - Categorias
    description: Marketplaces - Categorias
  - name: Marketplaces - Contas
    description: Marketplaces - Contas
  - name: Marketplaces - Lista de erros
    description: Marketplaces - Lista de erros
  - name: Marketplaces
    description: Marketplaces
  - name: Métricas - Cashback
    description: Métricas - Cashback
  - name: Promoções - Cashbacks
    description: Promoções - Cashbacks
  - name: Promoções - Cashback
    description: Promoções - Cashback
  - name: Promoções - Cupons de desconto
    description: Promoções - Cupons de desconto
  - name: Promoções - Produtos
    description: Promoções - Produtos
  - name: Filas
    description: Filas
paths:
  /{alias}/pricing/order-bumps:
    post:
      tags:
        - Promoções - Order Bump
      summary: Criar Order Bump
      description: Cria um novo Order Bump
      operationId: PostPricingOrder-bumps
      parameters:
        - name: alias
          in: path
          description: Alias da loja
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderBumpRequest'
      responses:
        '200':
          description: Order Bump criado com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderBump'
        '400':
          description: Requisição inválida
        '422':
          description: Verifique os campos obrigatórios e os formatos esperados.
components:
  schemas:
    OrderBumpRequest:
      description: Estrutura de dados para criação/atualização de Order Bump
      required:
        - name
        - active
        - resource_type
        - resource_id
        - price_sale
        - params
        - accepted_payment
        - display_rule
        - displayed_quantity
      properties:
        name:
          description: Nome do Order Bump. Deve ser único na loja.
          type: string
          example: Oferta especial de camiseta
        active:
          description: Define se o Order Bump está ativo e pode ser exibido no checkout.
          type: boolean
          example: true
        is_ia:
          description: Define se o Order Bump é gerado por IA
          type: boolean
          example: false
        pre_select_variation:
          description: Se a variação deve ser pré-selecionada
          type: boolean
          example: true
        resource_type:
          description: Tipo do item oferecido
          type: string
          enum:
            - sku
            - product
          example: product
        resource_id:
          description: ID do produto ou SKU oferecido
          type: integer
          example: 42533439
        price_sale:
          description: Preço de tabela do item na oferta, em reais.
          type: number
          format: float
          example: 50
        price_discount:
          description: >-
            Preço promocional do item na oferta, em reais. É um preço final, não
            um valor de desconto.
          type: number
          format: float
          example: 0
          nullable: true
        params:
          description: Textos personalizados exibidos na oferta durante o checkout.
          required:
            - button_text
          properties:
            button_text:
              description: Texto do botão que adiciona a oferta ao pedido.
              type: string
              example: + Adicionar oferta
            title:
              description: Título exibido na oferta.
              type: string
              example: null
              nullable: true
            message:
              description: Mensagem complementar exibida na oferta.
              type: string
              example: null
              nullable: true
          type: object
        accepted_payment:
          description: Método de pagamento aceito para exibir a oferta
          type: string
          enum:
            - all
            - deposit
            - billet
            - credit_card
            - pix
            - pix_in_installments
            - wallet
          example: all
        display_rule:
          description: Regra de exibição da oferta
          type: string
          enum:
            - always
            - products_amount
            - selected_products
          example: always
        amount_rule:
          description: >-
            Comparação aplicada ao valor dos produtos do carrinho:
            `greater_than` ou `lower_than`. Obrigatório quando `display_rule`
            for `products_amount`.
          type: string
          example: greater_than
          nullable: true
        amount_value:
          description: >-
            Valor de referência, em reais, comparado ao total dos produtos do
            carrinho conforme `amount_rule`. Obrigatório quando `display_rule`
            for `products_amount`.
          type: number
          format: float
          example: 100
          nullable: true
        display_product_ids:
          description: Lista de produtos exibidos no OrderBump
          type: array
          items:
            type: integer
            example: 12345
          nullable: true
        displayed_quantity:
          description: Quantidade de produtos exibidos no OrderBump
          type: integer
          maximum: 5
          minimum: 1
          example: 1
        restrictions:
          description: Exceção de produtos. Substitui as exceções salvas quando enviado.
          properties:
            exclude:
              description: >-
                No order bump manual, a oferta não aparece quando o carrinho tem
                um produto destas listas (itens de order bump e brindes não
                contam). No order bump com IA, só `products_ids` aceita itens:
                são os produtos que a IA não oferta.
              properties:
                products_ids:
                  description: Produtos.
                  type: array
                  items:
                    type: integer
                    example: 12345
                collections_ids:
                  description: Coleções. Só no order bump manual.
                  type: array
                  items:
                    type: integer
                    example: 321
                categories_ids:
                  description: Categorias. Só no order bump manual.
                  type: array
                  items:
                    type: integer
                    example: 654
                brands_ids:
                  description: Marcas. Só no order bump manual.
                  type: array
                  items:
                    type: integer
                    example: 987
              type: object
          type: object
      type: object
    OrderBump:
      description: Informações de um OrderBump individual
      properties:
        id:
          description: ID do Order Bump.
          type: integer
          example: 255787
        active:
          description: Indica se o Order Bump está ativo e pode ser exibido no checkout.
          type: boolean
          example: true
        is_ia:
          description: >-
            Indica se o Order Bump é gerado por IA, com a escolha do produto
            feita automaticamente. A loja pode ter apenas um Order Bump com IA.
          type: boolean
          example: false
        pre_select_variation:
          description: >-
            Indica se a variação do produto ofertado já vem selecionada para o
            cliente.
          type: boolean
          example: true
        name:
          description: Nome do Order Bump, único na loja.
          type: string
          example: Oferta Especial
        displayed_quantity:
          description: >-
            Quantidade de produtos exibidos na oferta, de 1 a 5. Configurável
            apenas quando `is_ia` for verdadeiro; nos demais casos é sempre 1.
          type: integer
          example: 1
        resource_id:
          description: ID do produto ou do SKU ofertado, conforme `resource_type`.
          type: integer
          example: 42533439
        resource_type:
          description: 'Tipo do item ofertado: `product` ou `sku`.'
          type: string
          example: product
        price_sale:
          description: Preço de tabela do item na oferta, em reais.
          type: string
          example: '50.00'
        price_discount:
          description: >-
            Preço promocional do item na oferta, em reais. É um preço final, não
            um valor de desconto.
          type: string
          example: '0.00'
        params:
          description: Textos personalizados exibidos na oferta durante o checkout.
          properties:
            button_text:
              description: Texto do botão que adiciona a oferta ao pedido.
              type: string
              example: + Adicionar oferta
            title:
              description: Título exibido na oferta.
              type: string
              example: null
              nullable: true
            message:
              description: Mensagem complementar exibida na oferta.
              type: string
              example: null
              nullable: true
          type: object
        accepted_payment:
          description: >-
            Meio de pagamento que o cliente precisa escolher para a oferta ser
            exibida. `all` exibe em qualquer meio.
          type: string
          example: all
        display_rule:
          description: >-
            Regra de exibição da oferta: `always` sempre exibe,
            `products_amount` compara o valor dos produtos do carrinho e
            `selected_products` exige que o carrinho tenha os produtos de
            `display_product_ids`.
          type: string
          example: always
        amount_rule:
          description: >-
            Comparação aplicada ao valor dos produtos do carrinho:
            `greater_than` ou `lower_than`. Preenchido quando `display_rule` for
            `products_amount`.
          type: string
          example: greater_than
        amount_value:
          description: >-
            Valor de referência, em reais, comparado ao total dos produtos do
            carrinho conforme `amount_rule`.
          type: string
          example: '0.00'
        updated_at:
          $ref: '#/components/schemas/BaseTimestamp'
        created_at:
          $ref: '#/components/schemas/BaseTimestamp'
        display_product_ids:
          description: >-
            IDs dos produtos que precisam estar no carrinho para a oferta ser
            exibida. Preenchido apenas quando `display_rule` for
            `selected_products`.
          type: array
          items:
            type: integer
          example: []
      type: object
    BaseTimestamp:
      description: >-
        Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário
        em que foi registrada.
      properties:
        date:
          description: Data e hora no formato YYYY-MM-DD H:MM:SS.
          type: string
          example: '2000-08-17 10:24:24'
        timezone_type:
          description: Número de representação do timezone.
          type: integer
          example: 3
        timezone:
          description: Fuso horário associado.
          type: string
          example: America/Sao_Paulo
      type: object
  securitySchemes:
    ApiToken:
      type: apiKey
      name: User-Token
      in: header
    ApiSecretKey:
      type: apiKey
      name: User-Secret-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.