Skip to main content
GET
/
public_api
/
bumps
/
{id}
/
cURL
curl --request GET \
  --url https://api.cakto.com.br/public_api/bumps/{id}/ \
  --header 'Authorization: Bearer <token>'
{
  "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

    read products

Quando usar

  • Antes de atualizar um order bump, para conferir os dados atuais
  • Para comparar a configuração entre dois ou mais order bumps
  • Para verificar qual oferta está vinculada a um bump específico

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 Order Bump

Response

Corpo da resposta status 200

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