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

Brasil: preço por UF e destinos

Recursos específicos do mercado brasileiro: preço por estado, bloqueio ou liberação de entrega por destino e consultas de CNPJ, CNAE e UFs.

Vender no Brasil traz regras que não existem em outros mercados: o preço de um produto pode mudar conforme a UF do comprador, certos produtos só podem ser entregues em algumas regiões, e empresas são identificadas pelo CNPJ e classificadas por CNAE (a atividade econômica oficial). Esta área reúne essas ferramentas do painel.

Pontos principais
  • Todas as rotas exigem o privilégio manage_brazil ou manage_settings.
  • Preço por UF usa o id UUID do produto e valores em centavos inteiros (4990 = R$ 49,90).
  • Regras de destino usam o número display_id do produto/seller e o legacy_id da categoria, não o UUID.
  • Regra de destino só vale para pedidos novos: o checkout consulta a regra e recusa o pedido bloqueado.
  • UF é sempre a sigla de duas letras (SP); minúsculas são aceitas e viram maiúsculas.

Como funciona

Preço por UF

Cada regra diz: "para este produto, em SP, a partir de min_qty unidades, o preço é X". Na hora de calcular o preço (carrinho e checkout), a plataforma escolhe a regra ativa da UF cuja min_qty é a maior que não passa da quantidade pedida. Sem regra aplicável, vale o preço normal do produto (source: "default").

Destinos permitidos e bloqueados

Cada regra é allow (permitir) ou deny (bloquear) e se aplica a uma entidade: product, vendor, category ou global. Pode ser restrita por UF, cidade e faixa de CEP. Ao avaliar um destino a plataforma procura a regra mais específica: produto vence seller, que vence categoria, que vence global. Em empate de especificidade, deny vence allow. Sem nenhuma regra aplicável, a entrega é permitida.

Produto→Seller→Categoria→Global

Status das regras

A (ativa) e D (desativada). Nas entradas você pode enviar active/disabled ou a letra; nas respostas a letra sempre volta. Regras desativadas não entram no cálculo.

Endpoints

MétodoCaminhoPara quê
GET/api/v1/admin/brazil/state-pricing/{productID}Lista regras de um produto
POST/api/v1/admin/brazil/state-pricingCria uma regra
PUT/api/v1/admin/brazil/state-pricing/{id}Altera uma regra
DELETE/api/v1/admin/brazil/state-pricing/{id}Remove uma regra
POST/api/v1/admin/brazil/state-pricing/bulkGrava várias regras
POST/api/v1/admin/brazil/state-pricing/effectiveSimula o preço efetivo
GET/api/v1/admin/brazil/destination-permissionsLista regras de destino
POST/api/v1/admin/brazil/destination-permissionsCria regra de destino
POST/api/v1/admin/brazil/destination-permissions/checkVerifica um destino
PUT/api/v1/admin/brazil/destination-permissions/{id}Altera regra de destino
DELETE/api/v1/admin/brazil/destination-permissions/{id}Remove regra de destino
GET/api/v1/admin/brazil/cnpj/{cnpj}Consulta um CNPJ
GET/api/v1/admin/brazil/cnaeBusca códigos CNAE
GET/api/v1/admin/brazil/cnae/{code}Consulta um CNAE
GET/api/v1/admin/brazil/statesLista as 27 UFs

Erros comuns

  • Usar o UUID em regra de destino. entity_id é um número: o display_id do produto ou do seller, ou o legacy_id da categoria. Um UUID é recusado como corpo inválido.
  • Esperar que o bloqueio valha para o catálogo. A regra de destino é conferida na criação do pedido. A vitrine continua mostrando o produto.
  • Achar que deny global bloqueia tudo. Uma regra allow mais específica (por exemplo, para um produto) vence a regra global.
  • Criar a mesma regra de preço duas vezes. O par (produto, UF, min_qty) é único: a segunda criação volta 400. Use o endpoint de lote, que atualiza.
  • Confundir id de regra com id de produto. As rotas {id} de preço e destino usam o id numérico da regra.
  • Contar com a paginação padrão. A lista de destinos aceita page e per_page, mas os campos page e per_page da resposta vêm 0 quando você não os envia (a página real é 1 com 20 itens).

Próximos passos

Preço por UF
Crie e mantenha as regras de preço.
Destinos
Libere ou bloqueie entregas.
Consultas
CNPJ, CNAE e UFs.
Anterior
Autonomia do assistente fiscal
Próxima
Regras de preço por UF
Nesta página
  • Como funciona
  • Preço por UF
  • Destinos permitidos e bloqueados
  • Status das regras
  • Endpoints
  • Erros comuns
  • Próximos passos