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

Promoções do seller

Como o seller (lojista) cria promoções com cupom, cupons automáticos, orçamentos de desconto e acompanha carrinhos abandonados.

Um seller (lojista) é um vendedor que opera dentro do marketplace da loja, com catálogo e pedidos próprios. Esta seção reúne as ferramentas que ele tem para vender mais sem mexer nas regras da loja inteira: promoções com código de cupom, cupons automáticos entregues depois de uma compra, orçamentos que limitam quanto ele gasta em desconto e a leitura dos carrinhos abandonados que continham os produtos dele. Tudo vive sob /api/v1/vendor e só enxerga o que pertence ao próprio seller.

Pontos principais
  • O seller é identificado pelo token, nunca por um campo do corpo. Um vendor_id enviado no corpo é ignorado e o servidor grava o seu.
  • Uma promoção do seller só desconta quando o cliente digita o código. Sem code ela fica cadastrada e nunca é aplicada.
  • O desconto do seller incide somente sobre os itens dele no carrinho, e o valor mínimo do carrinho é medido sobre o subtotal desses itens.
  • Dinheiro é sempre inteiro em centavos e percentual em pontos-base (1000 = 10%, 10000 = 100%).
  • Estas rotas exigem um usuário do tipo seller com o privilégio de configurações (vendor_settings) ou, nos carrinhos abandonados, de pedidos. Um token de administrador recebe 403.

Como funciona

Quem pode o quê

Uma loja pode ter promoções de três donos. Esta seção trata só do terceiro.

DonoComo se reconheceQuando desconta
Loja (marketplace)Sem vendor_idAutomático ou por cupom, no carrinho todo
Administrador em nome de um sellerCom vendor_idIgual ao seller: só por cupom, só nos itens dele
O próprio sellerCom vendor_id do sellerSó por cupom, só nos itens dele

Do cadastro ao desconto

Cadastrar promoção com code→Cliente digita o código→Itens do seller recebem o desconto→Uso entra no orçamento
  1. Crie a promoção
    POST /api/v1/vendor/promotions com name, type, discount e, obrigatoriamente para ter efeito, code. Veja Criar, alterar e excluir promoção.
  2. Proteja o caixa
    Crie um orçamento com teto em centavos ou em usos. Quando o teto estoura, a promoção para de aplicar.
  3. Acompanhe
    Os usos aparecem em usage_count na promoção e em spent no orçamento.

Status e vigência

O status é gravado como letra: A ativa, D inativa (também usada ao excluir), E expirada. Uma promoção só desconta dentro de valid_from e valid_until, abaixo de usage_limit e de per_user_limit e enquanto nenhum orçamento ligado a ela estiver esgotado.

Conceitos importantes

Os dois tipos de cupom do seller

Promoção com códigoCupom automático
Quem cria o códigoO seller, uma vez, igual para todosA plataforma, um por cliente, depois de um pedido concluído
Rota/vendor/promotions/vendor/auto-coupons
IdUUIDNúmero inteiro
Para que serveCampanha aberta (BLACK10)Fidelizar (10% na segunda compra)

Ids

Promoções, orçamentos, grupos e carrinhos abandonados usam UUID. As regras de cupom automático usam número inteiro (/auto-coupons/3).

Seller em análise

Enquanto o cadastro de aprovação do seller não for aceito, todas as rotas desta seção respondem 403 com {"error":"vendor_pending_review"}. Só as rotas de cadastro ficam abertas.

Exclusão

Excluir uma promoção é lógico: ela some da lista e deixa de descontar. Excluir um orçamento ou um grupo remove o registro de verdade.

Endpoints

MétodoCaminhoPara que serveAutenticação
GET/api/v1/vendor/promotionsLista as promoções do seller.seller
GET/api/v1/vendor/promotions/{id}Detalha uma promoção.seller
POST/api/v1/vendor/promotionsCria uma promoção.seller
PUT/api/v1/vendor/promotions/{id}Altera uma promoção.seller
DELETE/api/v1/vendor/promotions/{id}Exclui uma promoção.seller
GET/api/v1/vendor/auto-couponsLista as regras de cupom automático.seller
GET/api/v1/vendor/auto-coupons/{id}Detalha uma regra.seller
POST/api/v1/vendor/auto-couponsCria uma regra.seller
PUT/api/v1/vendor/auto-coupons/{id}Altera uma regra.seller
DELETE/api/v1/vendor/auto-coupons/{id}Exclui uma regra.seller
GET/api/v1/vendor/promotion-budgetsLista os orçamentos com o consumo.seller
GET/api/v1/vendor/promotion-budgets/{id}Detalha um orçamento.seller
POST/api/v1/vendor/promotion-budgetsCria um orçamento.seller
PUT/api/v1/vendor/promotion-budgets/{id}Ajusta um orçamento.seller
DELETE/api/v1/vendor/promotion-budgets/{id}Remove um orçamento.seller
GET/api/v1/vendor/promotion-groupsLista os grupos de promoções.seller
POST/api/v1/vendor/promotion-groupsCria um grupo.seller
DELETE/api/v1/vendor/promotion-groups/{id}Remove um grupo.seller
GET/api/v1/vendor/abandoned-cartsLista carrinhos abandonados com itens do seller.seller
GET/api/v1/vendor/abandoned-carts/statsTotais e taxa de recuperação.seller
GET/api/v1/vendor/abandoned-carts/{id}Detalha um carrinho abandonado.seller

Erros comuns

  • Cadastrar a promoção sem code e esperar que ela apareça sozinha na vitrine. Promoção de seller é excluída do cálculo automático: sem código ela nunca desconta.
  • Mandar vendor_id no corpo. É ignorado; a promoção sempre nasce do seller do token.
  • Usar o token de administrador. O prefixo /api/v1/vendor aceita só usuário seller; o administrador recebe 403 insufficient permissions.
  • Trocar as unidades. discount é pontos-base em percentage e centavos em fixed. 1000 em fixed é R$ 10,00, não 10%.
  • Esperar remover o código de uma promoção pelo PUT. "code": null não remove o código nesta rota; exclua e recrie a promoção.
  • Passar um id de regra automática como UUID. Em /auto-coupons/{id} o id é inteiro, e um segmento numérico 0 ou negativo em qualquer caminho do seller leva 400 invalid id parameter.
  • Criar orçamento com escopo marketplace. É exclusivo da loja e leva 403.

Próximos passos

Criar uma promoção
Corpo completo, tipos e as recusas.
Orçamentos
Limite o gasto com desconto.
Cupons automáticos
Entregue um cupom depois da compra.
Carrinhos abandonados
Veja o que ficou no carrinho.
Anterior
Excluir faixa de preço
Próxima
Consultar promoções
Nesta página
  • Como funciona
  • Quem pode o quê
  • Do cadastro ao desconto
  • Status e vigência
  • Conceitos importantes
  • Os dois tipos de cupom do seller
  • Ids
  • Seller em análise
  • Exclusão
  • Endpoints
  • Erros comuns
  • Próximos passos