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

Pedido mínimo do seller

Lê e define o valor mínimo em centavos que o cliente precisa atingir para comprar os produtos do seller.

O pedido mínimo é o menor subtotal de itens do seller que o checkout aceita. Um atacadista que não quer despachar pedidos de R$ 20 define, por exemplo, 15000 (R$ 150,00). No carrinho, a plataforma soma só os itens daquele seller e compara com esse valor, usando a hierarquia descrita na visão geral: o mínimo da região de entrega vence o do seller, que vence o da loja. 0 quer dizer "sem mínimo".

O mesmo valor é lido pelo carrinho, pelo cálculo de frete e pelo atendimento no WhatsApp. A alteração vale no próximo cálculo, sem reprocessar carrinhos já abertos.

Ler o pedido mínimo

GET/api/v1/vendor/min-order-amountSeller

Lê o pedido mínimo do seller

Não tem parâmetros. Exige o privilégio de configurações (vendor_settings ou vendor_view_settings).

Exemplo de requisição: ler

bash
curl "$BASE_URL/api/v1/vendor/min-order-amount" \
  -H "Authorization: Bearer $TOKEN"

Resposta: ler

200Pedido mínimo atual
json
{ "min_order_amount": 15000 }

Campos da resposta

min_order_amountinteger
Pedido mínimo do seller em centavos. 0 = sem mínimo.

Definir o pedido mínimo

PUT/api/v1/vendor/min-order-amountSeller

Define o pedido mínimo do seller

Substitui o valor atual. Exige o privilégio vendor_settings (só leitura de configurações não basta).

Corpo da requisição

min_order_amountintegerobrigatório
Novo mínimo em centavos. Zero ou positivo. 0 remove o mínimo. Se o campo faltar no corpo, o valor gravado é 0.

Exemplo de requisição: definir

bash
curl -X PUT "$BASE_URL/api/v1/vendor/min-order-amount" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "min_order_amount": 15000 }'

Resposta: definir

200Pedido mínimo gravado
json
{ "min_order_amount": 15000 }

A resposta repete o valor enviado.

Erros

StatusQuandoCorpo de exemplo
401Token ausente ou inválido.{"error":"missing authorization header"}
403O token não é de um usuário seller, ou o seller não tem o privilégio de configurações.{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings"]}
400Corpo que não é JSON.{"error":"INVALID_REQUEST_BODY","detail":"..."}
400Valor negativo.{"error":"INVALID_MIN_ORDER_AMOUNT","detail":"min_order_amount must be zero or positive"}
404O usuário não está ligado a nenhum seller.{"error":"VENDOR_NOT_FOUND"}
500Falha ao ler ou gravar.{"error":"MIN_ORDER_SAVE_FAILED","detail":"..."}
Corpo sem o campo apaga o mínimo

O PUT não distingue "campo ausente" de 0. Um corpo {} ou com outro nome de campo grava 0 e remove o pedido mínimo, respondendo 200. Confira o valor devolvido.

Códigos de erro em maiúsculas

Estas duas rotas devolvem o código curto em maiúsculas em error (VENDOR_NOT_FOUND, INVALID_MIN_ORDER_AMOUNT), diferente da maioria das rotas do seller, que devolvem uma frase em inglês.

O cliente vê a regra no checkout

Quando o carrinho não alcança o mínimo, o checkout recusa o pedido com vendor_min_order_not_met e uma mensagem com o nome do seller e os dois valores. Informe o mínimo na página do seu produto para evitar a surpresa.

Veja também

  • Visão geral das regras de preço
  • Regras do repricer
  • Remover faixa de preço
Anterior
Regras de preço do seller
Próxima
Remover faixa de preço
Nesta página
  • Ler o pedido mínimo
  • Exemplo de requisição: ler
  • Resposta: ler
  • Definir o pedido mínimo
  • Exemplo de requisição: definir
  • Resposta: definir
  • Erros
  • Veja também