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.
Como funciona
Quem pode o quê
Uma loja pode ter promoções de três donos. Esta seção trata só do terceiro.
| Dono | Como se reconhece | Quando desconta |
|---|---|---|
| Loja (marketplace) | Sem vendor_id | Automático ou por cupom, no carrinho todo |
| Administrador em nome de um seller | Com vendor_id | Igual ao seller: só por cupom, só nos itens dele |
| O próprio seller | Com vendor_id do seller | Só por cupom, só nos itens dele |
Do cadastro ao desconto
- Crie a promoção
POST /api/v1/vendor/promotionscomname,type,discounte, obrigatoriamente para ter efeito,code. Veja Criar, alterar e excluir promoção. - Proteja o caixaCrie um orçamento com teto em centavos ou em usos. Quando o teto estoura, a promoção para de aplicar.
- AcompanheOs usos aparecem em
usage_countna promoção e emspentno 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ódigo | Cupom automático | |
|---|---|---|
| Quem cria o código | O seller, uma vez, igual para todos | A plataforma, um por cliente, depois de um pedido concluído |
| Rota | /vendor/promotions | /vendor/auto-coupons |
| Id | UUID | Número inteiro |
| Para que serve | Campanha 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étodo | Caminho | Para que serve | Autenticação |
|---|---|---|---|
| GET | /api/v1/vendor/promotions | Lista as promoções do seller. | seller |
| GET | /api/v1/vendor/promotions/{id} | Detalha uma promoção. | seller |
| POST | /api/v1/vendor/promotions | Cria 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-coupons | Lista as regras de cupom automático. | seller |
| GET | /api/v1/vendor/auto-coupons/{id} | Detalha uma regra. | seller |
| POST | /api/v1/vendor/auto-coupons | Cria 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-budgets | Lista os orçamentos com o consumo. | seller |
| GET | /api/v1/vendor/promotion-budgets/{id} | Detalha um orçamento. | seller |
| POST | /api/v1/vendor/promotion-budgets | Cria 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-groups | Lista os grupos de promoções. | seller |
| POST | /api/v1/vendor/promotion-groups | Cria um grupo. | seller |
| DELETE | /api/v1/vendor/promotion-groups/{id} | Remove um grupo. | seller |
| GET | /api/v1/vendor/abandoned-carts | Lista carrinhos abandonados com itens do seller. | seller |
| GET | /api/v1/vendor/abandoned-carts/stats | Totais 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
codee 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_idno corpo. É ignorado; a promoção sempre nasce do seller do token. - Usar o token de administrador. O prefixo
/api/v1/vendoraceita só usuário seller; o administrador recebe403 insufficient permissions. - Trocar as unidades.
discounté pontos-base empercentagee centavos emfixed.1000emfixedé R$ 10,00, não 10%. - Esperar remover o código de uma promoção pelo
PUT."code": nullnã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érico0ou negativo em qualquer caminho do seller leva400 invalid id parameter. - Criar orçamento com escopo
marketplace. É exclusivo da loja e leva403.