Campanha de Vendedores - Versão 1.2.2

A api deverá ser atualizada anualmente até dia 1º de abril.

O que é o Vendedor Show?

É uma campanha de incentivo a vendas de alguns medicamentos com premiação para os melhores vendedores.

Como funciona?

Todo ano no perído de 01 de maio à 30 de dezembro, disponibilizamos uma lista de medicamento, os balconistas que mais venderem estes medicamentos são premiados.

URL

Rede Associativa Cidade / UF URL CNPJ Teste
Rede Soma Drogarias Raul Soares / MG http://soma.vendedorshow.com.br 18.092.664/0001-93
Grupo Multifarma Muriaé / MG http://multifarma.vendedorshow.com.br 03.672.470/0001-90

Vendedor Total

Nome CPF Pontos [quantidade]
Paulo Barros 044.847.026-81 70
Ramirez 484.446.857-04 65
Total Drogaria 135

Vendedor Total Produtos

EAN Produto Quant
Nome: Paulo Barros, CPF: 044.847.026-81
7898994588641 OLISOMA ÔMEGA3 C/60 CAPS. – REDE SOMA 1
7896714210018 DORALGINA C/20 COMP. – NEO QUÍMICA 2
Subtotal 3
Nome: Joana Dark, CPF: 044.847.026-81
7898994588641 OLISOMA ÔMEGA3 C/60 CAPS. – REDE SOMA 10
7896714210018 DORALGINA C/20 COMP. – NEO QUÍMICA 20
Subtotal 30
Total 33

Vendedor Extrato

EAN Produto Dt. Ocorrência Quant
Nome: Paulo Barros, CPF: 044.847.026-81
7898994588641 OLISOMA ÔMEGA3 C/60 CAPS. – REDE SOMA 2017-11-13 17:15:00 1
7896714210018 DORALGINA C/20 COMP. – NEO QUÍMICA 2017-11-13 17:15:00 2
Subtotal 3
Nome: Joana Dark, CPF: 044.847.026-81
7898994588641 OLISOMA ÔMEGA3 C/60 CAPS. – REDE SOMA 2017-11-13 17:15:00 10
7896714210018 DORALGINA C/20 COMP. – NEO QUÍMICA 2017-11-13 17:15:00 20
Subtotal 30
Total 33

Produtos Nota Fiscal de Entrada

EAN: 7898994588641 Produto: POLISOMA ÔMEGA3 C/60 CAPS. – REDE SOMA
Nº Nota Chave Nota Dt Compra Quant
006935897 5666 4478 9544 4474 5555 6544 4478 9544 4474 5555 6544 01/04/2017 15
006935111 5666 4478 9544 4474 5555 6544 4478 9544 4474 5555 6544 10/05/2017 10
Subtotal 15

HEAD Será usado em todos os URI

Nome Valor [Exemplo] Descriçao
Authorization Bearer [Solicitar Token] Envia o token de acesso.
Content-Type application/json Envie o tipo de retorno.
User-Agente Software Envia o nome do software.
Versao 1.0.4.191 Enviar o número da versão do software.

Status Code Tabela geral usada em todos os URI

Código Descriçao Schema
200 Sucesso GET – Irá exibir conteúdo
201 Criado/Atualizado
202 Aceito/Autorizado
203 Não autorizado
204 Não existe conteúdo GET – Item não existe. Ex.: Produto não encontrado
301 Movido {"uri": "string"}
400 Parâmetros Inválidos {"key": ["string"]}
401 Acesso não autorizado
402 Pagamento necessário
403 Proibido
404 Não encontrado, verifique a URL
405 Método não permitido
406 Não aceitável
408 Tempo esgotado [Timeout]
409 Conflito de regras
410 Url Obsoleta
412 Falha na pré-condição
500 Erro interno do servidor
501 Recurso não implementado
502 Gateway Inválido
503 Serviço indisponível

GET /v2/produtos

Método para buscar a lista de produtos da campanha para monitorar nas vendas.

Parâmetros Sempre enviar em caixa baixa (minúsculas).

Nome Requerido Descrição Schema
api_token Sim Token poderá também ser envio pelo cabeçalho da requisição String
cnpj Sim CNPJ da drogaria. String

Retorno

Código Descrição Schema
200 Sucesso [ { “ean”:”string”, “produto”:”string” } ]
401 Acesso não autorizado { “error”:”string” }
405 Método não permitido
500 Erro interno do servidor

POST /v1/lancador

Método para envio das vendas dos produtos topsoma

Parâmetros Sempre enviar em caixa baixa (minúsculas).

Nome Requerido Descrição Schema
api_token Sim Token poderá também ser envio pelo cabeçalho da requisição String
cnpj Sim Informe o cnpj da drogaria. String
cpf Sim CPF do Vendedor. String
legado Sim Identificação da Venda ou Devolução. Integer
ean Sim Código Ean do produto. Integer
quantidade Sim Informe a quantidade vendida do produto. Integer
dtocorrencia Sim Informe a data da ocorrência da venda ou devolução.. DateTime yyyy-mm-dd hh:nn:ss
tipo Sim 0.Venda, 2.Devolução. Integer

Retorno

Código Descrição Schema
200 Sucesso
400 Parâmetros inválidos { "campo":["mensagem"], "campo":["mensagem"] }
401 Acesso não autorizado
500 Erro interno do servidor

POST /v2/nota

Envio

Parâmetros Sempre enviar em caixa baixa (minúsculas).

Nome Requerido Descrição Schema
cnpj_clie Sim CNPJ da Drogaria. String
cnpj_forn Sim CNPJ do Fornecedor. String
nota Sim Número da Nota Fiscal String
cfop Sim Número do CFOP Integer
chave Não Chave da Nota Fiscal String
dtcompra Sim Data da Compra DateTime yyyy-mm-dd hh:nn:ss
ean Sim EAN do produto. String
quant Sim Quantidade. Integer
preco Sim Preço Unitário do Produto comprado Double com separador decimal[.]

Retorno

Código Descrição Schema
202 Aceito
400 Parâmetros inválidos { "campo":["mensagem"], "campo":["mensagem"] }
401 Acesso não autorizado
500 Erro interno do servidor

GET /v1/reset

Quanto houver divergência, o WebService pode solicitar uma nova varredura no sistema da softhouse. Sempre antes de enviar uma nova tentativa de transmissão, verificar este método, ser for retornado vazio prosseguir, se caso for retornado uri e data no formato yyyy-mm-dd. Retransmitir os dados a partir daquela data. Seguindo a regra, como se os dados não estivem sido transmitidos.

Parâmetros Sempre enviar em caixa baixa (minúsculas).

Nome Requerido Descrição Schema
cnpj Sim CNPJ da drogaria. String

Retorno

Código Descrição Schema
200 Sucesso [ { "uri": "lancador", "data": "2017-12-06" } ]

Post /v1/reset

Confirmação do Reset

Parâmetros Sempre enviar em caixa baixa (minúsculas).

Nome Requerido Descrição Schema
cnpj Sim CNPJ da drogaria. String
uri Sim Uri String
dtproximo Não DateTime yyyy-mm-dd hh:nn:ss, Serve para envio parcial String

Retorno

Código Descrição Schema
202 Sucesso

Software já Integrados

Digifarma
ProSystem
Trier
Automatiza
Hos

Sortee
Infor Prática