> ## 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. # Listar order bumps > Lista as ofertas adicionais da empresa autenticada, na ordem em que aparecem no checkout. Filtre por produto para ver o que um checkout específico oferece, ou por oferta para descobrir em quantos checkouts ela é vendida como adicional. ## OpenAPI ````yaml /openapi.yaml get /v1/order-bumps 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/order-bumps: get: tags: - Catálogo summary: Listar order bumps description: >- Lista as ofertas adicionais da empresa autenticada, na ordem em que aparecem no checkout. Filtre por produto para ver o que um checkout específico oferece, ou por oferta para descobrir em quantos checkouts ela é vendida como adicional. operationId: listOrderBumps parameters: - schema: type: integer minimum: 1 default: 1 in: query name: page required: false description: Página desejada, começando em 1. - schema: type: integer minimum: 1 maximum: 100 default: 10 in: query name: pageSize required: false description: Quantidade de itens por página (máximo 100). - schema: type: string minLength: 1 in: query name: productId required: false description: Só os bumps exibidos no checkout deste produto. - schema: type: integer exclusiveMinimum: true minimum: 0 in: query name: offerId required: false description: Só os bumps que vendem esta oferta. responses: '200': description: Página de order bumps da empresa. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: array items: type: object properties: id: type: string description: Identificador do order bump. offerId: type: integer description: >- Oferta adicionada à compra quando o comprador aceita o bump. productId: type: string nullable: true description: >- Produto em cujo checkout a caixa aparece (checkout clássico). checkoutId: type: string nullable: true description: Checkout do construtor novo em que a caixa aparece. title: type: string description: Título exibido na caixa do order bump. description: type: string nullable: true description: Texto de apoio exibido abaixo do título. callToAction: type: string nullable: true description: >- Frase do botão ou da caixa de seleção, ex.: "Sim, quero!". displayImage: type: string nullable: true description: URL da imagem exibida na caixa. showProductImage: type: boolean description: >- Usa a imagem do produto da oferta em vez de uma imagem própria. backgroundColor: type: string nullable: true description: Cor de fundo da caixa, em hexadecimal. textColor: type: string nullable: true description: Cor do texto da caixa, em hexadecimal. borderColor: type: string nullable: true description: Cor da borda da caixa, em hexadecimal. checkboxColor: type: string nullable: true description: Cor da caixa de seleção, em hexadecimal. exibitionOrder: type: integer description: >- Posição da caixa quando o checkout mostra mais de um bump. active: type: boolean description: Bump exibido no checkout. createdAt: type: string format: date-time description: Momento de criação do order bump. updatedAt: type: string format: date-time description: Momento da última alteração. required: - id - offerId - productId - checkoutId - title - description - callToAction - displayImage - showProductImage - backgroundColor - textColor - borderColor - checkboxColor - exibitionOrder - active - createdAt - updatedAt additionalProperties: false pagination: type: object properties: page: type: integer description: Página devolvida. pageSize: type: integer description: Itens por página pedidos. total: type: integer description: Total de itens que satisfazem o filtro. totalPages: type: integer description: Total de páginas disponíveis. required: - page - pageSize - total - totalPages additionalProperties: false required: - success - data - pagination additionalProperties: false description: Página de order bumps da empresa. example: success: true data: - id: clx9c1m5t0002qz0a7h8j9k0l offerId: 4821 productId: clx8a2h4k0001qz0a1b2c3d4e checkoutId: null title: Leve também o Pack de Criativos description: 80 criativos prontos para anúncio, editáveis no Canva. callToAction: Sim, quero o pack por R$ 97 displayImage: https://images.ephra.io/order-bumps/pack-criativos.jpg showProductImage: false backgroundColor: '#F4F7FB' textColor: '#0B1B2B' borderColor: '#1B9E4B' checkboxColor: '#1B9E4B' exibitionOrder: 1 active: true createdAt: '2026-09-03T10:20:00.000Z' updatedAt: '2026-09-09T17:05:00.000Z' pagination: page: 1 pageSize: 10 total: 1 totalPages: 1 '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 ````