Obter Ofertas

get https://partnerhub-sdx-external-api.stone.com.br/pricing/offers

Lista as ofertas disponíveis para o lojista

Estrutura Principal do Response

Campo	Tipo	Descrição
`success`	`boolean`	Indica o sucesso da requisição HTTP principal.
`data`	`object`	Objeto que encapsula todos os dados da resposta, incluindo diferentes formatos de ofertas.

Estrutura do Objeto `data`

Campo	Tipo	Descrição
`success`	`boolean`	Um segundo indicador de sucesso, possivelmente relacionado à lógica de negócio da busca por ofertas.
`formattedOffers`	`array`	Uma lista de ofertas formatadas de maneira hierárquica, ideal para exibição estruturada.
`offers`	`array`	Uma lista "plana" de ofertas, mais direta para processamento ou para apresentar um resumo.

1. Estrutura de `formattedOffers`

Esta seção detalha a estrutura hierárquica das ofertas.

1.1. Objeto Principal (dentro de `formattedOffers`)

Campo	Tipo	Descrição
`id`	`string`	ID do agrupamento principal de ofertas.
`name`	`string`	Nome do agrupamento principal de ofertas.
`plans`	`array`	Uma lista de planos disponíveis dentro deste grupo.

1.2. Objeto `plans`

Campo	Tipo	Descrição
`id`	`string`	ID do plano.
`name`	`string`	Nome do plano.
`offers`	`object`	Um objeto que contém as ofertas divididas por tipo: assinatura e aquisição.

1.3. Objeto `offers` (dentro de `plans`)

Campo	Tipo	Descrição
`subscription`	`array`	Lista de ofertas relacionadas a uma assinatura ou mensalidade recorrente.
`subscription_offers_amount`	`number`	Quantidade de ofertas do tipo assinatura.
`acquisition`	`array`	Lista de ofertas relacionadas à aquisição inicial de produtos ou serviços.
`acquisition_offers_amount`	`number`	Quantidade de ofertas do tipo aquisição.

1.4. Estrutura do Objeto em `subscription`

Campo	Tipo	Descrição
`condition`	`string`	Descrição da condição para esta oferta de assinatura.
`best_offer`	`boolean`	Indica se esta é a melhor oferta disponível.
`campaign`	`boolean`	Indica se a oferta faz parte de uma campanha.
`promo_stone`	`boolean`	Indica se é uma promoção da Stone.
`promo_stone_group`	`number`	ID do grupo de promoção da Stone.
`automatic_anticipation`	`boolean`	Indica se a antecipação automática está inclusa/requerida.
`volume_exemption`	`boolean`	Indica se há isenção por volume de vendas.
`stone_account`	`boolean`	Indica se a Conta Stone está inclusa/requerida.

1.5. Estrutura do Objeto em `acquisition`

Campo	Tipo	Descrição
`condition`	`string`	Condição para a oferta de aquisição.
`promo_stone`	`boolean`	Indica se é uma promoção da Stone.
`automatic_anticipation`	`boolean`	Indica se a antecipação automática está inclusa.
`volume_exemption`	`boolean`	Indica se há isenção por volume de vendas.
`stone_account`	`boolean`	Indica se a Conta Stone está inclusa.
`daily_payment`	`boolean`	Indica se o pagamento diário está disponível.
`daily_payment_type`	`number`	Código que identifica o tipo de pagamento diário.
`daily_payments_fees`	`object`	Objeto com as taxas para pagamento em D+0 e D+1.
`products`	`array`	Lista de produtos associados a esta oferta de aquisição.

1.6. Estrutura do Objeto `products`

Campo	Tipo	Descrição
`name`	`string`	Nome do produto.
`category`	`string`	Categoria do produto.
`priceType`	`string`	Tipo de preço (ex: "UNITARIO").
`quantityMin`	`number`	Quantidade mínima do produto.
`quantityMax`	`number`	Quantidade máxima do produto.
`quantity`	`number`	Quantidade padrão.
`priceModel`	`string`	Modelo de precificação.
`price`	`number`	Preço do produto.
`prices`	`array`	Lista de diferentes faixas de preço.
`discounts`	`array`	Lista de descontos aplicáveis.

2. Estrutura de `offers` (Lista "Plana")

Esta seção detalha a estrutura da lista de ofertas diretas.

Campo	Tipo	Descrição
`planId`	`string`	ID do plano ao qual a oferta pertence.
`planName`	`string`	Nome do plano.
`offerId`	`string`	ID da oferta.
`offerName`	`string`	Nome da oferta.
`offerDescription`	`string`	Descrição detalhada da oferta.
`value`	`number`	Valor principal da oferta.
`total`	`number`	Valor total (pode incluir taxas).
`discount`	`number`	Valor do desconto aplicado.
`installments`	`object`	Detalhes do preço parcelado.
`installments.value`	`number`	Valor de cada parcela.
`installments.total`	`number`	Valor total parcelado.
`installments.discount`	`number`	Desconto no parcelamento.
`installments.quantity`	`number`	Número de parcelas.
`discounts`	`array`	Lista de objetos de desconto (`name`, `ref`).
`conditions`	`array`	Lista de condições da oferta (`name`, `value`).
`products`	`array`	Lista de produtos, seguindo a mesma estrutura da Seção 1.6.

Language

Credentials

Header

Click Try It! to start a request and see the response here!