Skip to main content
GET
Visualizar oferta

Authorizations

X-Api-Client-Token
string
header
required

Token de autenticação do cliente obtido via endpoint /auth

Path Parameters

product_hash
string
required

Hash do produto

offer_code
string
required

Código da oferta

Response

Dados da oferta retornados com sucesso. Para produtos físicos, o objeto freight será incluído.

Objeto de retorno com os dados da oferta.

code
string
required

Código único da oferta.

name
string
required

Nome da oferta.

type_of_charge
enum<string>
required

Tipo de cobrança.

Available options:
one-time,
recurring
price
integer
required

Preço da oferta em centavos.

allow_credit_card
boolean
required

Indica se aceita cartão de crédito.

credit_card_installments_options
integer[]
required

Opções de parcelamento no cartão de crédito.

Required range: 1 <= x <= 36
allow_pix
boolean
required

Indica se aceita PIX.

allow_bank_slip
boolean
required

Indica se aceita boleto bancário.

created_at
string
required

Data de criação (formato YYYY-MM-DD HH:mm:ss)

Example:

"2026-01-15 14:30:00"

updated_at
string
required

Data de atualização (formato YYYY-MM-DD HH:mm:ss)

Example:

"2026-01-15 14:30:00"

fake_initial_price
integer | null

Preço "de" para exibição de desconto (em centavos).

quantity_items
integer

Quantidade de itens em estoque (para produtos físicos).

Required range: 1 <= x <= 100
allow_bank_slip_installments
boolean

Se permite parcelamento no boleto.

bank_slip_days_due
integer

Número de dias para vencimento do boleto.

Required range: 1 <= x <= 7
bank_slip_installments_limit
integer

Limite máximo de parcelas no boleto.

Required range: 1 <= x <= 12
allow_affiliates
boolean

Se permite afiliação para esta oferta.

affiliates_percentage
number | null

Percentual de comissão do afiliado.

Required range: 1 <= x <= 80
affiliates_subscription_percentage
number | null

Percentual de comissão do afiliado para cobranças recorrentes.

Required range: 1 <= x <= 80
commission_only_first_installment
boolean | null

Se a comissão é calculada apenas sobre a primeira parcela.

producer_pays_interest
boolean | null

Se o produtor paga os juros do parcelamento.

is_free
boolean | null

Se a oferta é gratuita (price = 0).

transfer_fixed_fee_to_buyer
boolean

Indica se a taxa fixa da transação (R$2,49) é repassada ao comprador.

  • true — comprador paga a taxa fixa
  • false — produtor absorve a taxa fixa
subscription
object

Configurações de assinatura (quando type_of_charge = recurring).

freight
object

Informações de frete retornadas para produtos físicos.