Skip to main content
POST
/
public_api
/
products
/
{id}
/
bumps
/
{
  "id": "5Hrb526",
  "product": "fb3fda61-e88f-43b5-982a-32d50f112414",
  "installments": 12,
  "referencePrice": 97,
  "offer": {
    "id": "77BcHrY",
    "name": "Oferta Principal",
    "image": null,
    "price": 47,
    "units": 1,
    "default": true,
    "product": "fb3fda61-e88f-43b5-982a-32d50f112414",
    "status": "active",
    "type": "unique",
    "intervalType": "month",
    "interval": 1,
    "recurrence_period": 30,
    "quantity_recurrences": -1,
    "trial_days": 0,
    "max_retries": 3,
    "retry_interval": 1
  },
  "cta": "Quero aproveitar!",
  "title": "Oferta especial",
  "description": "Leve também por um preço especial",
  "position": 1,
  "image": "https://example.com/bump-image.png",
  "showImage": true
}

​
Escopo

    write products

​
Quando usar

Use este endpoint quando quiser:
  • Adicionar um produto complementar ao checkout
  • Criar uma nova oferta de upgrade ou adicional
  • Incluir uma segunda opção de compra para quem já está na página de pagamento

​
Campos importantes

CampoDescriçãoDica
offerId da oferta que será exibidaA oferta deve estar ativa e pertencer ao mesmo produto
referencePricePreço de referência exibidoUse para mostrar desconto ou valor original riscado
ctaTexto do botãoEx: “Sim, quero adicionar!”
titleTítulo do order bumpEx: “Workbook exclusivo”
descriptionDescrição curtaUma linha com o benefício principal
positionOrdem de exibiçãoMenor valor aparece primeiro no checkout
showImageExibe imagem da ofertaRecomendado para produtos visuais
A oferta informada no campo offer deve existir e estar vinculada ao mesmo produto. Caso contrário, a API retornará erro 400.

Authorizations

​
Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Path Parameters

​
id
string
required

Id do Produto

Body

The body is of type any.

Response

Corpo da resposta status 201

​
product
string
required
read-only

Produto que será oferecido como order bump

​
installments
integer
required
read-only

Número de parcelas do produto associado à oferta

​
offer
object
required

Oferta associada ao orderbump

​
image
string | null
required
read-only

URL da imagem do orderbump

​
id
string

Identificador único do order bump no sistema

Maximum string length: 40
​
referencePrice
number<double> | null

Preço de referência exibido no orderbump

​
cta
string | null

Texto do botão de call to action do order bump

Maximum string length: 255
​
title
string | null

Título do order bump

Maximum string length: 255
​
description
string | null

Descrição do order bump

​
position
integer

Posição na qual o order bump será exibido no checkout

​
showImage
boolean

Indica se a imagem do order bump será exibida no checkout