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

Cupons, vales, pagamentos e NF-e

Cupons, vales-presente, formas de pagamento próprias, NF-e e planos do seller.

Além de vender, o seller (lojista) precisa decidir como recebe, que incentivos oferece e como emite nota fiscal. Esta seção agrupa essas capacidades de autoatendimento, todas restritas ao próprio seller: cupons, vales-presente, formas de pagamento, NF-e e a lista de planos.

Pontos principais
  • Tudo vale só para os produtos do seller do token.
  • Cupom de porcentagem usa pontos-base: 15% é 1500.
  • Cupons usam id inteiro; vales e formas de pagamento usam UUID.
  • A NF-e exige o módulo focusnfe e devolve o token sem máscara.

Como funciona

Todas estas capacidades são do seller: ele as configura e elas valem só para os produtos dele. Nenhuma depende de aprovação do administrador (cupons, vales e formas de pagamento), exceto a escolha de plano, que é limitada pelos limites do plano.

  1. Defina como o seller recebe

    Crie as formas de pagamento que ele oferece (PIX, boleto faturado...).

  2. Crie incentivos

    Emita cupons (desconto por código) e vales-presente (crédito pré-pago).

  3. Prepare a nota fiscal

    Informe os dados de emitente em NF-e para as notas saírem em nome do seller.

Conceitos-chave

Escopo do seller

O seller é identificado pelo token. Qualquer vendor_id enviado no corpo é ignorado; o registro é sempre do seller do token. Ler ou alterar um registro de outro seller responde como se ele não existisse (404).

Privilégios das sub-contas

Cupons, vales-presente, formas de pagamento e a configuração da NF-e exigem um privilégio de configurações (vendor_settings ou um dos específicos). A lista de notas exige o privilégio financeiro. O dono da loja passa em tudo.

Dinheiro

Centavos inteiros. Percentuais de cupom e de acréscimo em pontos-base. Os vales-presente mostram também uma cópia decimal em texto (amount_str) só por compatibilidade.

Ids

Cupons usam id inteiro; vales-presente e formas de pagamento usam UUID. Um UUID malformado hoje devolve 500, não 400.

Endpoints

MétodoCaminhoPara que serveAutenticaçãoPágina
GET/api/v1/vendor/vouchersLista cupons.seller, configuraçõesCupons
POST/api/v1/vendor/vouchersCria cupom.seller, configuraçõesCupons
GET/api/v1/vendor/vouchers/{id}Detalhe do cupom.seller, configuraçõesCupons
PUT/api/v1/vendor/vouchers/{id}Altera o cupom.seller, configuraçõesCupons
DELETE/api/v1/vendor/vouchers/{id}Apaga o cupom.seller, configuraçõesCupons
GET/api/v1/vendor/gift-certificatesLista vales-presente.seller, configuraçõesVales-presente
POST/api/v1/vendor/gift-certificatesEmite vale-presente.seller, configuraçõesVales-presente
GET/api/v1/vendor/gift-certificates/{id}Detalhe do vale.seller, configuraçõesVales-presente
PUT/api/v1/vendor/gift-certificates/{id}Altera o vale.seller, configuraçõesVales-presente
DELETE/api/v1/vendor/gift-certificates/{id}Apaga o vale.seller, configuraçõesVales-presente
GET/api/v1/vendor/payment-methodsLista formas de pagamento.seller, configuraçõesFormas de pagamento
POST/api/v1/vendor/payment-methodsCria forma de pagamento.seller, configuraçõesFormas de pagamento
GET/api/v1/vendor/payment-methods/{id}Detalhe da forma.seller, configuraçõesFormas de pagamento
PUT/api/v1/vendor/payment-methods/{id}Altera a forma.seller, configuraçõesFormas de pagamento
DELETE/api/v1/vendor/payment-methods/{id}Apaga a forma.seller, configuraçõesFormas de pagamento
GET/api/v1/vendor/nfe/configLê a configuração fiscal.seller, configurações, focusnfeNF-e
PUT/api/v1/vendor/nfe/configGrava a configuração fiscal.seller, configurações, focusnfeNF-e
GET/api/v1/vendor/nfeLista notas emitidas.seller, financeiro, focusnfeNF-e
GET/api/v1/vendor/plans/availablePlanos que o seller pode escolher.seller, vendor-plansPlanos disponíveis

Erros comuns

  • Enviar value: 15 num cupom percentage esperando 15%. É 0,15%: use 1500.
  • Usar um código de cupom que outro seller já usa: 400 ... already exists (o código é único na loja).
  • Tentar corrigir o saldo de um vale-presente pelo PUT. Só situação, dados do presente e validade mudam.
  • Criar um vale com código repetido e esperar 400. Hoje volta 500.
  • Enviar status de forma de pagamento fora de active/inactive. O valor é gravado sem conferir e pode estourar em 500.
  • Salvar a configuração da NF-e sem active: true. Sem isso as notas continuam saindo pelos dados da loja.
  • Registrar a resposta de /nfe/config em log: ela contém o token da Focus NFe.

Próximos passos

Cupons
Desconto por código.
Vales-presente
Crédito pré-pago.
Formas de pagamento
Como o seller recebe.
NF-e
Nota fiscal do seller.
Anterior
Disputas com o comprador
Próxima
Cupons do seller
Nesta página
  • Como funciona
  • Conceitos-chave
  • Escopo do seller
  • Privilégios das sub-contas
  • Dinheiro
  • Ids
  • Endpoints
  • Erros comuns
  • Próximos passos