Skip to main content
POST
cURL

Escopo

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

A oferta informada no campo offer deve existir e estar vinculada ao mesmo produto. Caso contrário, a API retornará erro 400.
Uma mesma oferta não pode ser adicionada duas vezes como order bump do mesmo produto — a segunda tentativa retorna 400 com { "detail": "Oferta já cadastrada como order bump deste produto." }.

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

Body

product
string
required

Produto que será oferecido como order bump

id
string

Identificador único do order bump no sistema

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

Oferta que será oferecida como order bump

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

Required range: -2147483648 <= x <= 2147483647
showImage
boolean

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

Response

product
string
required

Produto que será oferecido como order bump

id
string

Identificador único do order bump no sistema

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

Oferta que será oferecida como order bump

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

Required range: -2147483648 <= x <= 2147483647
showImage
boolean

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