VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Preço e estoque

GETEscada de preços

Lista as faixas de quantidade e preço de um produto que se aplicam a quem consulta.

Devolve a tabela "a partir de N unidades, R$ X cada" do produto. Use para montar o quadro de preços por quantidade da página do produto. A lista junta as faixas cadastradas no produto e as regras de atacado B2B que valem para quem chama, ordenadas da menor para a maior quantidade.

A resposta não é guardada em cache. Um produto sem faixa devolve tiers vazio e base_price com o preço normal.

GET/api/v1/storefront/products/{id}/price-tiersPública

Lista as faixas de preço por quantidade de um produto

O token é opcional e muda o resultado: visitantes veem as faixas universais e as marcadas para visitante; clientes logados veem também as faixas para "logados" e as dos grupos a que pertencem.

Parâmetros de caminho

iduuidobrigatório
Id do produto (UUID completo).

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/storefront/products/5e833a7f-1a77-402c-835a-32594350d7a7/price-tiers"

Resposta

200Faixas retornadas
json
{
  "tiers": [
    {"id": "b2b-rule-5-9", "product_id": "5e833a7f-1a77-402c-835a-32594350d7a7", "lower_limit": 5, "price": 4800, "percentage_discount": 9.3, "usergroup_id": null, "created_at": ""},
    {"id": "b2b-rule-10-0", "product_id": "5e833a7f-1a77-402c-835a-32594350d7a7", "lower_limit": 10, "price": 4500, "percentage_discount": 14.9, "usergroup_id": null, "created_at": ""}
  ],
  "base_price": 5290,
  "product_id": "5e833a7f-1a77-402c-835a-32594350d7a7"
}

Produto sem faixas (resposta real da loja de teste):

200Sem faixas
json
{"tiers":[],"base_price":5290,"product_id":"5e833a7f-1a77-402c-835a-32594350d7a7"}

Visitante em loja que esconde preços:

200Preço escondido
json
{"tiers":[],"base_price":0,"product_id":"5e833a7f-1a77-402c-835a-32594350d7a7","price_redacted":true}

Campos da resposta

product_iduuid
Id do produto.
base_priceinteger
Preço normal do produto, em centavos. A coluna de desconto é medida contra ele. Zero quando o preço está escondido.
tiersarray
Faixas aplicáveis, da menor para a maior quantidade.
tiers[].idstring
Id da faixa. Faixas vindas de regra B2B têm id sintético, no formato b2b-rule-<mínimo>-<máximo>.
tiers[].lower_limitinteger
Quantidade mínima para a faixa valer.
tiers[].priceinteger
Preço unitário na faixa, em centavos.
tiers[].percentage_discountnumber
Desconto em porcentagem contra base_price, para exibir na tabela.
tiers[].usergroup_idstring
A quem a faixa se aplica: null (todos), guest, registered ou o UUID de um grupo de clientes.
tiers[].value_per_kginteger
Opcional. Preço de referência por kg, em centavos, só para exibição.
tiers[].value_per_unitinteger
Opcional. Preço de referência por unidade, em centavos, só para exibição.
price_redactedboolean
true quando a loja esconde preço de visitante. tiers vem vazio.

Erros

StatusQuandoCorpo de exemplo
404O produto não existe.{"error":"product not found"}
401A loja exige login para navegar.{"error":"shopping_requires_login","message":"this storefront requires login to browse"}
500O id não é um UUID válido.{"error":"failed to get price tiers","detail":"o valor \"abc\" não é um uuid válido. Envie o identificador completo, com os 36 caracteres e os hífens. Corrija o campo e reenvie."}
A tabela já vem calculada

O preço de cada linha é o que o comprador pagaria naquele patamar, segundo a regra de faixa da loja. Não recalcule no cliente: some a quantidade e use Preço por quantidade para o total.

Veja também

  • Preço por quantidade
  • Preço B2B do cliente
Anterior
Preço por quantidade
Próxima
Histórico de preço
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também