Endpoints Individuais - API

Última atualização: 2 dias atrás Tempo de leitura: 11 minutos

ferramentas Web Desktop API APIRest Endpoints Basico

O que é?

O endpoint individual é um endpoint padrão que permite realizar alterações no sistema.

Como Funciona no Uniplus?

1. Endpoint Categoria de e-commerce (V1)

Categorias cadastradas para os e-commerce

URL: “/public-api/v1/grupo-shop”
Verbos suportados: GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

[{"id": 7,"codigo": "4.2","nome": "Teste04b","idPai": 5}]

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/grupo-shop”

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código da categoria de e-commerce		Caractere	30
nome	Nome		Caractere	40
idpai	Id da categoria pai		Inteiro

2. Endpoint Consulta de ordens de serviço (v1)

Listagem de ordens de serviços.

URL: “/public-api/v1/ordem-servico“
Verbos suportados: GET

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

[

{

"identificacao": "OS",

"tabela": "ordemservico",

"descricaoLayout": "Ordem de serviço",

"id": 11,

"codigo": 10,

"idCliente": 2583,

"codigoCliente": "139",

"nomeCliente": "10 - LUCAS MARTINS MENDES",

"cnpjCpfCliente": "077.977.281-43",

"dataOrdemServico": "2023-05-31",

"data": "2023-05-31T16:28:00",

"idFilial": 1,

"codigoFilial": "1",

"descricaoItem": "Teste",

"problemaDescrito": "Teste",

"idAtendente": 76,

"nomeAtendente": "Técnico 01",

"status": 1,

"valor": "185.00",

"valorProdutos": "0.00",

"valorServicos": "185.00",

"descricaoTipoUltimoEvento": "",

"descricaoUltomEvento": "",

"extra1": "",

"extra2": "",

"extra3": "",

"extra4": "",

"extra5": "",

"extra6": "",

"extra7": "",

"extra8": "",

"extra9": "",

"extra10": "",

"extra11": "",

"extra12": "",

"extra13": "",

"extra14": "",

"extra15": "",

"extra16": "",

"currentTimeMillis": 1685562145678,

"itens": [

{

"identificacao": "OSI",

"tabela": "ordemservicoitem",

"descricaoLayout": "Ordem de serviço - itens",

"id": 21,

"idOrdemServico": 11,

"contador": 2,

"idProduto": 60,

"codigoProduto": "1021",

"nomeProduto": "Serviço não tributado",

"unidadeMedida": "HR",

"quantidade": "1.000000",

"preco": "50.000000",

"desconto": "0.00",

"total": "50.000",

"observacao": "sim",

"idTecnico": 76,

"nomeTecnico": "Técnico 01",

"numeroSerie": ""

{

"identificacao": "OSI",

"tabela": "ordemservicoitem",

"descricaoLayout": "Ordem de serviço - itens",

"id": 20,

"idOrdemServico": 11,

"contador": 1,

"idProduto": 59,

"codigoProduto": "1020",

"nomeProduto": "Serviço substituição tributaria",

"unidadeMedida": "UN",

"quantidade": "3.000000",

"preco": "50.000000",

"desconto": "15.00",

"total": "135.000",

"observacao": "tem",

"idTecnico": 76,

"nomeTecnico": "Técnico 01",

"numeroSerie": ""

}

]

}

]

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/ordem-servico/${codigo}”

Lista dos campos do JSON da ordem de serviço

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caractere	20
idCliente	ID do cliente		Inteiro
codigoCliente	Código Cliente		Caractere	14
nomeCliente	Nome Cliente		Caractere	60
cnpjCpfCliente	CNPJ ou CPF do Cliente		Caractere	18
dataOrdemServico	Data da Ordem de Serviço		Data
data	Data/Hora		Data/Hora	19
idFilial	ID da Filial		Inteiro
codigoFilial	Código da Filial		Caractere	4
descricaoItem	Descrição do Item		Caractere	200
problemaDescrito	Problema Descrito		Caractere	200
idAtendente	ID do Atendente		Inteiro
nomeAtendente	Nome do Atendente		Caractere	60
status	Status		Inteiro			1 – Aberta; 2 – Em execução; 3 – Finalizada; 4 – Cancelada; 5 – Faturada; 6 – Agendada; 7 – Pausada; 8 – Passou pelo PDV; 9 – Faturada por DAV OS; 10 – Mesclado; 11 – Duplicado; 12 – Serviço não executado; 13 – Orçamento; 14 – Faturado parcialmente; 15 – Retirada;
valor	Valor		Numérico	12	2
valorProdutos	Valor dos Produtos		Numérico	12	2
valorServicos	Valor dos Serviços		Numérico	12	2
descricaoTipoUltimoEvento	Descrição Tipo “Último Evento”		Caractere	200
descricaoUltomEvento			Caractere	200
extra1	Extra 1		Caractere	200
extra2	Extra 2		Caractere	200
extra3	Extra 3		Caractere	200
extra4	Extra 4		Caractere	200
extra5	Extra 5		Caractere	200
extra6	Extra 6		Caractere	200
extra7	Extra 7		Caractere	200
extra8	Extra 8		Caractere	200
extra9	Extra 9		Caractere	200
extra10	Extra 10		Caractere	200
extra11	Extra 11		Caractere	200
extra12	Extra 12		Caractere	200
extra13	Extra 13		Caractere	200
extra14	Extra 14		Caractere	200
extra15	Extra 15		Caractere	200
extra16	Extra 16		Caractere	200
currentTimeMillis			Inteiro
itens			Lista de itens

Lista dos campos do JSON dos itens da Ordem de Serviço

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
idOrdemServico	ID da Ordem de Serviço		Inteiro
contador	Contador		Inteiro
idProduto	ID do Produto		Inteiro
codigoProduto	Código do Produto		Caractere	20
nomeProduto	Nome do Produto		Caractere	120
unidadeMedida	Unidade de Medida		Caractere	6
quantidade	Quantidade		Numérico	15	6
preco	Preço		Numérico	15	6
desconto	Desconto		Numérico	12
total	Total		Numérico	12	3
observacao	Observação		Caractere	200
idTecnico	ID do Técnico		Inteiro
nomeTecnico	Nome do Técnico		Caractere	60
numeroSerie	Número de Série		Caractere	40

3. Endpoint DAVs (v1)

Manipulação de DAVS (orçamentos, pré-vendas, pedidos de venda, pedidos de faturamento)

URL: “/public-api/v1/davs“
Verbos suportados: PUT, POST, GET, DELETE

Status HTTP

200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{“dav”: {“codigo”: “101”, “tipoDocumento”: 1,”data”:”2020-08-01″,”itens”:[{“produto”:”97″,”quantidade”:1,”precoUnitario”:12.34}]}}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –data “${json}” –request “POST” “${endereco_do_servidor}/public-api/v1/davs”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/davs/${codigo}”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/davs”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “DELETE” “${endereco_do_servidor}/public-api/v1/davs/${codigo}”

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
bairroEntrega	Bairro da entrega		Caractere	50
cepEntrega	CEP da entrega		Caractere	9
cidadeEntrega	Cidade da entrega		Caractere	100
cliente	Cliente		Caractere	14		Código do cliente (entidade)
codigo	Código	Sim	Inteiro			Código do documento ou se deixar em branco o sistema gera um sequencial
codigoIdentificacao	Código alternativo de identificação		Caractere	20		Associa outro código identificador no prév-vendas
codigoPauta	Número da pauta de preços		Caractere	1
codigoTipoFrete	Código do tipo de frete		Caractere	1		0=Destinatário 1=Emitente 2=Sem frete 9=Terceiros
codigoTransportadora	Código da transportadora		Caractere	14		Código da transportadora (entidade)
complementoEntrega	Complemento da entrega		Caractere	50
condicaoPagamento	Condição de pagamento		Caractere	6		Código da condição de pagamento
data	Data	Sim	Data
desconto	Desconto no sub-total		Decimal	12	2
enderecoEntrega	Endereço da entrega		Caractere	50
estadoEntrega	Estado da entrega		Caractere	2
extra1	Campo extra 1		Caractere	512
extra2	Campo extra 2		Caractere	512
filial	Filial		Caractere	4		Código da filial
numeroEntrega	Número do endereço da entrega		Caractere	6
observacao	Observação		Caractere	4096
percentualDescontoSubtotal	Percentual Desconto Subtotal		Decimal	12	2
status	Status da DAV		Inteiro			1=Fechado 2=PDV 3=Cancelado 4=Nota fiscal gerada 5=Pré-venda gerada 6=Duplicado 7=Faturado parcialmente 8=Pedido gerado 9=Incluído por cliente 10=Mesclado
tipoDocumento	Tipo do DAV	Sim	Inteiro			1=Pré-vendas 2=Orçamento 4=Pedido de venda 6=Pedido de faturamento
tipoDocumentoFinanceiro	Tipo de documento financeiro		Inteiro
valor	Valor		Decimal	12	3	Valor total do DAV, sendo igual ao valor total dos itens manos o desconto de sub-total.Caso não for informado, será calculado pelo valor total de todos os itens
valorDescontoItens	Valor do desconto dos itens		Decimal	12	2
valorFrete	Valor do frete		Decimal	12	2
vendedor	Vendedor		Caractere	14		Código do vendedor (entidade)
codigoECommerce	Código do pedido do e-commerce		Caractere	50

Itens

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
codigoDAV	Codigo do DAV		Inteiro
codigoUnidadeMedida	Unidade de medida		Caractere	3		Código da unidade de medida
desconto	Desconto		Decimal
isBrinde	Brinde		Inteiro			0=Não 1=Sim
nrItem	Número do item		Inteiro
numeroSerie	Número de série		Caractere	20
precoTotal	Preco total		Decimal	12
precoUnitario	Preco unitário		Decimal	12
produto	Produto	Sim	Caractere	14		Código do produto
quantidade	Quantidade	Sim	Decimal	12
tipoDesconto	Tipo de desconto	Sim	Caractere	1		0=Percentual 1=Valor
informacaoAdicional	Informações adicionais		Caractere	500

Variações

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
variacao	Código da variação		Inteiro
quantidade	Quantidade da variação		Inteiro

Lotes

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Numérico
idLote	ID do lote		Numérico
quantidade	Quantidade		Numérico	15
emissao	Data de Emissão		Data
vencimento	Data de Vencimento		Data
idDavItem	ID da DAV do Item		Numérico

Número Série

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
numeroSerie	Número de Série		Caractere	40

4. Endpoint EANs (v1)

Manipulação de eans adicionais de produtos

URL: “/public-api/v1/eans“
Verbos suportados: POST, GET, e DELETE

Status HTTP

200 = OK
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{“ean”: {“produto”: “97”, “ean”:”7898935898075″}}

Exemplos

curl –verbose –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –data “${json}” –request “POST” “${endereco_do_servidor}/public-api/v1/eans”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/eans/${codigo_barras}”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/eans”

curl –verbose –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “DELETE” “${endereco_do_servidor}/public-api/v1/eans/${codigo_barras}”

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
ean	Código de barras	Sim	Caracter	14
descricaoVariacao	Descrição da variação		Caracter
produto	Código do produto	Sim	Caracter	14
variacao	Variação do código de barras		Caracter	5

5. Endpoint Embalagens (v1)

Manipulação de embalagens de produtos

URL: “/public-api/v1/embalagens“
Verbos suportados: POST, PUT e GET

Status HTTP

200 = OK
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{“embalagem”: {“produto”: “97”, “unidadeMedida”:”CX”,”fatorConversao”:10,”preco”:123.40,”ean”:”7891000315507″}}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –data “${json}” –request “POST” “${endereco_do_servidor}/public-api/v1/embalagens”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –data “${json}” –request “PUT” “${endereco_do_servidor}/public-api/v1/embalagens”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/embalagens”

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
ean	Código de barras		Caracter	20		Código de barras da embalagem
fatorConversao	Fator de conversão		Decimal	15	6	Multiplicador aplicado na quantidade movimentada
preco	Preço		Decimal	15	6	Preço do produto nesta embalagem
produto	Código do produto		Caracter	20
tipoEmbalagem	Tipo de embalagem		Inteiro	1		0 = Compra e venda 1 = Somente compra 2 = Somente venda
unidadeMedida	Unidade de medida		Caracter	3
casasDecimais	Casas decimais da unidade de medida		Inteiro	2

6. Endpoint Entidades (v1)

Manipulação de cliente, fornecedor, transportadora, vendedor, técnico, fabricante

URL: “/public-api/v1/entidades“
Verbos suportados: POST, PUT, GET e DELETE

Status HTTP

200 = OK
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{“entidade”: {“codigo”: “200005”, “nome”:”Cliente teste”, “tipo”: 1}}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –data “${json}” –request “POST” “${endereco_do_servidor}/public-api/v1/entidades”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/entidades/${codigo}”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/entidades”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “DELETE” “${endereco_do_servidor}/public-api/v1/entidades/${codigo}”

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
bairro	Bairro		Caracter	50
bairroCobranca	Bairro de cobrança		Caracter	50
bairroEntrega	Bairro de entrega		Caracter	50
celular	Celular		Caracter	40
celularCobranca	Celular de cobrança		Caracter	40
celularEntrega	Celular de entrega		Caracter	40
cep	Cep		Caracter	10
cepCobranca	Cep de cobrança		Caracter	10
cepEntrega	CEP de entrega		Caracter	9
cidade	Cidade		Caracter	100
cidadeCobranca	Cidade de cobrança		Caracter	100
cidadeEntrega	Cidade de entrega		Caracter	100
cnpjCpf	CNPJ/CPF		Caracter	18
codigo	Código	Sim	Caracter	10		Se deixar em branco o sistema gera um sequencial
complemento	Complemento		Caracter	50
complementoCobranca	Complemento de cobrança		Caracter	50
complementoEntrega	Complemento do endereço de entrega		Caracter	50
conjuge	Cônjuge		Caracter	50
contatoCobranca	Nome do contato de cobrança		Caracter	50
contatoEntrega	Contato de entrega		Caracter	50
dataNascimento	Data de nascimento		Data
email	Email		Caracter	50
emailCobranca	Email de cobrança		Caracter	50
emailEntrega	Email de entrega		Caracter	50
endereco	Endereço		Caracter	50		Endereço sem o número
enderecoCobranca	Endereco de cobrança		Caracter	50
enderecoEntrega	Endereço de entrega		Caracter	50
estado	Estado		Caracter	2
estadoCivil	Estado civil		Inteiro			0=Casado 1=Solteiro 2=Divorciado 3=Desquitado 4=Viúvo 5=Amasiado 6=Não identificado
estadoCobranca	Estado de cobrança		Caracter	2
estadoEntrega	Estado de entrega		Caracter	2		UF Ex: SC,SP,PE
extra1	extra1		Caracter	512
extra2	extra2		Caracter	512
extra3	extra3		Caracter	512
extra4	extra4		Caracter	512
extra5	extra5		Caracter	512
extra6	extra6		Caracter	512
fax	Fax		Caracter	40
faxEntrega	Fax de entrega		Caracter	40
inativo	Inativo		Inteiro	1		0=Ativo 1=Inativo
inscricaoEstadual	Inscrição Estadual		Caracter	50
limiteCredito	Limite de crédito		Decimal	12	2
mae	Mãe		Caracter	50
nome	Nome	Sim	Caracter	50
nomeContato	Nome do contato		Caracter	50
numeroCobranca	Numero do endereço de cobrança		Caracter	6
numeroEndereco	Número do endereço		Caracter	6
numeroEntrega	Número do endereço de entrega		Caracter	6
observacao	Observação		Caracter	4096
pai	Pai		Caracter	50
profissao	Profissão		Caracter	50
razaoSocial	Razao Social		Caracter	50
renda	Renda		Decimal	12	2
rg	RG		Caracter	20
telefone	Telefone		Caracter	40
telefoneCobranca	Telefone de cobrança		Caracter	40
telefoneEntrega	Telefone de entrega		Caracter	40
tipo	Tipo da entidade	Sim	Caracter	20		1=Cliente 2=Fornecedor 3=Transportadora 4=Vendedor 5=Técnico 6-Fabricante Pode informar uma lista separada por vírgula Ex: (1,2,3)
tipoPessoa	Tipo de pessoa		Caracter	1		0 = Física 1 = Jurídica
usuario	Usuário		Caracter	10
creditoRestrito	Informa se a entidade está bloqueada		Inteiro	1		1=Sim e 0=Não
codigoVendedor	Vendedor		Caracter	50
codigoVendedor2	Vendedor 2		Caracter	50
codigoVendedor3	Vendedor3		Caracter	50

7. Endpoint Registro de Produção (v1)

Manipular registro de produção

URL: “/public-api/v1/registro-producao“
Verbos suportados: POST e GET

Status HTTP

200 = OK;
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes.

JSON Exemplo

{"registroProducao":{"descricao" : "Teste de importacao","itens":[{"idProduto": 132,"quantidade": "1" }]}}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –data “${json}” –request “POST” “${endereco_do_servidor}/public-api/v1/registro-producao”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/registro-producao”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/registro-producao/${codigo}”

Lista dos campos do JSON

Registro de produção:

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
IdRegistroProducao			Numérico
codigo	Código do registro de produção		Caractere	20
descricao	Descrição do registro de produção		Caractere	255
dataHora	Data e hora do registro de produção
dataHoraProducao	Data e hora da produção
idFilial	Id da filial		Caractere
codigoFilial	Código da filial		Caractere	4
NomeFilial	Nome da filial		Caractere	60
idUsuario	Id do usuário		Numérico
nomeUsuario	Nome do usuário		Caractere	60
idNotaFiscalOrigem	Id da nota fiscal que gerou o registro de produção		Numérico
idOperacaoOrigem	Id da operação origem que gerou o registro de produção		Numérico
idPedidoDavOrigem	id do pedido origem que gerou o registro de produção		Numérico
idLocalEstoque	Id do local de estoque		Numérico
codigoLocalEstoque	Código do local de estoque		Caractere	5
nomeLocalEstoque	Nome do loca de estoque		Caractere	50
idLocalEstoqueInsumo	Id do local de estoque do insumo		Numérico
codigoLocalEstoqueInsumo	Código do local de estoque do insumo		Caractere	5
nomeLocalEstoqueInsumo	Nome do local de estoque dos insumo		Caractere	50
extra1:	Campo extra		Caractere	512
extra2	Campo extra		Caractere	512
extra3	Campo extra		Caractere	512
extra4	Campo extra		Caractere	512
extra5	Campo extra		Caractere	512
extra6	Campo extra		Caractere	512
itens	Lista de objetos de itens do registro de produção. Consulte a tabela abaixo.

Registro de produção – Itens:

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
idRegistroProducaoItem	Id do item do registro de produção		Numérico
idRegistroProducao	Id do registro de produção
codigoProduto	Código do produto		Caractere	20
idProduto	Id do produto
quantidade	Quantidade produzida		Numérico	15	6
quantidadeFator	Fator da quantidade		Numérico	15	6
quantidadeEmbalagem	Quantidade embalagem		Numérico	16	6
relacaoMistura	Relação da mistura		Caractere	40
ordemVariacao	Ordenação da variação		Numérico
lote	Lote do item do registro de produção		Caractere	30
emissaoLote	Data de emissão do lote
vencimentoLote	Data de vencimento do lote
variacoes	Variações		Caractere	4096
idNotaFiscalItemOrigem	Id da nota fiscal que gerou o registro de produção		Numérico
idItemOperacaoOriginal	Id da operação origem que gerou o registro de produção		Numérico
quantidadeSolicitada	Quantidade produzida do item do registro de produção		Numérico	15	6
quantidadePadrao	Quantidade padrão do item do registro de produção		Numérico	15	6
tipoQuantidade	Tipo de quantidade produzida		Numérico	1		0 – Rendimento; 1 – Unidade do produto.
insumos	Lista de objetos dos insumos do item. Consulte a tabela abaixo.

Registro de produção – Insumos:

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
currentTimeMillis	Millissegundos		Numérico
id	ID do insumo		Numérico
idRegistroProducao	ID do resgistro de produção		Numérico
idRegistroProducaoItem	Id do item do rendimento de produção		Numérico
idProduto	Id do produto insumo		Numérico
idProdutoItem	Id do produto na tabela item
variacao	Código da variação		Numérico
quantidadeNecessaria	Quantidade necessária do insumo		Numérico	15,	6;
idProdutoSubstituido	Id do produto que foi substituído		Numérico
quantidadeSubstituida	Quantidade substituída do insumo		Numérico	15	,6
tipoSubstituicao						0 – Sem substituição; 1- Insumo substituído; 2 – Insumo com quantidade alterada.
idNovoProdutoSubstituto	Id do novo produto que substituiu o insumo		Numérico
codigoNovoProdutoSubstituto	Código do novo produto que substituiu o insumo		Caractere	– 20;
descricaoNovoProdutoSubstituto	Descrição do novo produto que substituiu o insumo		Caractere	120 ,
descricaoVariacao	Descrição da variação		Caractere	– 60;
codigoProduto	Código do produto		Caractere	20;
descricaoProduto	Descrição do produto		Caractere	120;
unidadeMedida	Código da unidade de medida		Caractere	– 6,
casasDecimais	Casas decimais da unidade de medida		Numérico
quantidadeDisponivel	Quantidade disponível		Numérico
saldoEstoque	Estoque disponível		Numérico
codigoProdutoSubstituido	Código do produto substituído		Caractere	– 20;
descricaoProdutoSubstituido	Descrição do produto substituído		Caractere	120;
possuiLote	Insumo possui lote		Boolean
situacaoLote	Situação do lote					0 – Sem lote; 1 – Lote não informado; 2 – Lote informado.
idLocalEstoque	ID do local de estoque do insumo		Numérico

8. Endpoint Variações (v1)

Manipulação de variações de produtos como grade de cor, tamanho, etc

URL: “/public-api/v1/variacoes“
Verbos suportados: POST, PUT, GET

Status HTTP

200 = OK

422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{“variacao”: {“produto”: “97”, “codigoGrade”:”12″, “descricao”:”ROXO”, “ordem”: “4”}}

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –data “${json}” –request “POST” “${endereco_do_servidor}/public-api/v1/variacoes”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/variacoes”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/variacoes?produto=1003”

Neste exemplo acima o resultado será a carga das variações montadas para o produto informado.

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
codigoGrade	Código do cadastro de grade	Sim	Caractere	100
descricao	Descrição do valor	Sim	Caractere	30
ordem	Ordem	Sim	Caractere	5		Posição no desenho da grade
produto	Código do produto	Sim	Caractere	14
tipoRegistro	Tipo do registro	Sim	Caractere	1		0=Linha 1=Coluna
variacao	Código da variação	Não	Caractere			Código da variação montada

9. Endpoint Itens de Notas Fiscais de Entrada

Esse Endpoint serve para consultar os itens das Notas Fiscais de Entrada que, no campo “cfopItemConsideraCompra“, tem o valor “1”. Notas Canceladas não serão retornadas. Para considerar a Nota Fiscal de Devolução:

Se for utilizada a configuração de Operações Fiscais:
- Em Cadastro → Outros → Nota Fiscal → Operações Fiscais, o campo “Finalidade” deve estar definido como “Devolução de Venda” ou “Devolução de Compra“;
Se for utilizada a configuração de Naturezas de Operação e Tributações Especiais:
- Em Cadastro → Outros → Nota Fiscal → Naturezas de Operação e Tributações Especiais, o campo “Finalidade” deve estar como “Devolução de Venda” ou “Devolução de Compra“.

Primeiro, será levada em conta a configuração de “Operações Fiscais”. Caso não exista, será considerada a configuração de “Naturezas de Operação e Tributações Especiais” para identificar a nota de devolução. O campo “notafiscaldevolucao” retornará o valor “S“.

URL: “/public-api/v1/item-nota-entrada/compra“
Verbos suportados: GET

Status HTTP

200 = OK
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"identificacao": "ENFI",

"tabela": "entrada_itens_view",

"descricaoLayout": "Itens da nota fiscal de entrada/compra",

"idItem": 131,

"produtoCodigo": "1037",

"produtoDescricao": "Pauta 01",

"tipoItem": "P",

"cfopItem": "1102",

"cfopItemDescricao": "Compra mercadorias comercialização",

"cfopItemConsideraCompra": "1",

"embalagem": "1.000000",

"codigoUnidadeMedida": "UN",

"decimaisQuantidade": 2,

"decimaisPreco": 2,

"quantiadade": "100.00",

"precoUnitario": "1.00",

"desconto": "0.00",

"total": "100.00",

"pis": "0.00",

"cofins": "0.00",

"ipi": "0.00"

"icms": "17.00",

"icmsSt": "0.00",

"iss": "0.00",

"frete": "0.00",

"seguro": "0.00",

"outrasDespesas": "0.00",

"tributacao": "",

"icmsfcp": "0",

"acrescimo": "0.00",

"icmsstfcp": "0",

"idNotaFiscal": 3,

"numeroNotaFiscal": "1001",

"serie": "1",

"modelo": "55",

"chaveNfe": "00000000000000000000000000000000000000000000",

"tipoEmissao": "T",

"status": 0,

"dataEntrada": "2018-01-24",

"dataHoraEntrada": "2018-01-24T13:44:00",

"valorProdutos": "500.00",

"valorTotal": "500.00",

"fornecedorCodigo": "1",

"fornecedorNome": "Fornecedor ABC",

"cfopNota": "1102",

"cfopNotaDescricao": "Compra mercadorias comercialização",

"finalidadeEmissaoNfe": "0",

"notaFiscalDevolucao": "N",

"filialCodigo": "1",

"filialNome": "Testes AUTO"}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
idItem	Id do Item		Numérico
produtoCodigo	Código do produto		Caractere	120
tipoItem	Tipo do item		Caractere	1		P – Produto; S – Serviço.
cfopItem	Código da CFOP do item		Caractere	20
cfopItemDescricao	Descrição da CFOP do item		Caractere	1024
cfopItemConsideraCompra	A CFOP do item considerada para compra		Caractere	1		0 – Não; 1 – Sim.
embalagem	Fator da embalagem		Numérico	15.6
codigoUnidadeMedida	Código da unidade de medida		Caractere	6
decimaisQuantidade	Decimais da quantidade do produto		Numérico
decimaisPreco	Decimais do preço do produto		Numérico
quantidade	Quantidade do produto		Numérico	15.6
precoUnitario	Preço unitário do produto		Numérico	15.6
desconto	Desconto do item		Numérico	12.2
total	Total do item		Numérico	12.2
pis	Valor de PIS do item		Numérico	12.2
cofins	Valor de COFINS do item		Numérico	12.2
ipi	Valor de IPI do item		Numérico	12.2
icms	Valor de ICMS do item		Numérico	12.2
icmsSt	Valos de ICMS ST do item		Numérico	12.2
iss	Valor de ISS do item		Numérico	12.2
frete	Valor do frete do item		Numérico	12.2
seguro	Valor do seguro do item		Numérico	12.2
outrasDespesas	Valor de outras despesas do item		Numérico	12.2
tributacao	Tributação do produto/item		Caractere	7		T – Tributado; I – Isento; N – Não tributado; F – Substituição tributária.
icmsfcp	Valor do ICMS do FCP		Numérico	12.2
acrescimo	Valor do acréscimo		Numérico	12.2
icmsstfcp	Valor do ICMS ST da CFP		Numérico	12.2
idNotaFiscal	Id da nota fiscal		Numérico
numeroNotaFiscal	Número da nota fiscal		Caractere	11
serie	Série da nota fiscal		Caractere	4
modelo	Modelo da nota fiscal		Caractere	6
chaveNfe	Chave da nota fiscal		Caractere	50
tipoEmissao	Tipo de emissão da nota fiscal		Caractere	1		P – Próprio; T – Terceiro.
status	Status da nota fiscal		Numérico			0 – Normal; 3 – NF-e autorizada; 4 – NF-e Rejeitada; 5 – NF-e Negada; 6 – NFS-e autorizada; 7 – NFS-e Rejeitada; 8 – NF-e emitida em contingência; 9 – Aguardando processamento; 10 – Problema no processamento; 11 – Problema no envio do lote; 14 – Aguardando retorno; 16 – NF-e emitida em contingência via EPEC; 17 – NF-e pendente de estorno (Negada na SEFAZ);
dataEntrada	Data da entrada/Emissão		Data
dataHoraEntrada	Data e hora da entrada/emissã		Datatime
valorProdutos	Valor total dos produtos na nota fiscal		Numérico	12.2
valorTotal	Valor total da nota fiscal		Numérico	12.2
fornecedorCodigo	Código do fornecedor		Caractere	14
fornecedorNome	Nome do fornecedor		Caractere	60
cfopNota	Código da CFOP da nota		Caractere	20
cfopNotaDescricao	Descrição da CFOP da nota fiscal		Caractere	1024
finalidadeEmissaoNfe	Finalidade da nota CFOP		Numérico			0 – Normal; 1 – Complementar; 2 – Ajuste; 3 – Ajuste com itens; 4 – Devolução de venda; 5 – Devolução de compra; 6 – Importação do PDV; 7 – Transferência de crédito de ICMS; 8 – Crédito de ICMS.
notaFiscalDevolucao	Informa se é ou não uma Nota Fiscal de Devolução		Caractere	1		S – Sim; N – Não.
filialCodigo	Código da filial		Caractere	4
filialNome	Nome da filial		Caractere	60

10. Endpoint Itens de Notas Fiscais de Entrada (Compra)

Esse Endpoint serve para consultar os itens das Notas Fiscais de Entrada. Notas Canceladas não serão retornadas. Para considerar a Nota Fiscal de Devolução:

Se for utilizada a configuração de Operações Fiscais:
- Em Cadastro → Outros → Nota Fiscal → Operações Fiscais, o campo “Finalidade” deve estar definido como “Devolução de Venda” ou “Devolução de Compra“;
Se for utilizada a configuração de Naturezas de Operação e Tributações Especiais:
- Em Cadastro → Outros → Nota Fiscal → Naturezas de Operação e Tributações Especiais, o campo “Finalidade” deve estar como “Devolução de Venda” ou “Devolução de Compra“.

URL: “/public-api/v1/item-nota-entrada“
Verbos suportados: GET

Status HTTP

200 = OK
422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON Exemplo

{"identificacao": "ENFI",

"tabela": "entrada_itens_view",

"descricaoLayout": "Itens da nota fiscal de entrada/compra",

"idItem": 131,

"produtoCodigo": "1037",

"produtoDescricao": "Pauta 01",

"tipoItem": "P",

"cfopItem": "1102",

"cfopItemDescricao": "Compra mercadorias comercialização",

"cfopItemConsideraCompra": "1",

"embalagem": "1.000000",

"codigoUnidadeMedida": "UN",

"decimaisQuantidade": 2,

"decimaisPreco": 2,

"quantiadade": "100.00",

"precoUnitario": "1.00",

"desconto": "0.00",

"total": "100.00",

"pis": "0.00",

"cofins": "0.00",

"ipi": "0.00"

"icms": "17.00",

"icmsSt": "0.00",

"iss": "0.00",

"frete": "0.00",

"seguro": "0.00",

"outrasDespesas": "0.00",

"tributacao": "",

"icmsfcp": "0",

"acrescimo": "0.00",

"icmsstfcp": "0",

"idNotaFiscal": 3,

"numeroNotaFiscal": "1001",

"serie": "1",

"modelo": "55",

"chaveNfe": "00000000000000000000000000000000000000000000",

"tipoEmissao": "T",

"status": 0,

"dataEntrada": "2018-01-24",

"dataHoraEntrada": "2018-01-24T13:44:00",

"valorProdutos": "500.00",

"valorTotal": "500.00",

"fornecedorCodigo": "1",

"fornecedorNome": "Fornecedor ABC",

"cfopNota": "1102",

"cfopNotaDescricao": "Compra mercadorias comercialização",

"finalidadeEmissaoNfe": "0",

"notaFiscalDevolucao": "N",

"filialCodigo": "1",

"filialNome": "Testes AUTO"}

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
idItem	Id do Item		Numérico
produtoCodigo	Código do produto		Caractere	120
tipoItem	Tipo do item		Caractere	1		P – Produto; S – Serviço.
cfopItem	Código da CFOP do item		Caractere	20
cfopItemDescricao	Descrição da CFOP do item		Caractere	1024
cfopItemConsideraCompra	A CFOP do item considerada para compra		Caractere	1		0 – Não; 1 – Sim.
embalagem	Fator da embalagem		Numérico	15.6
codigoUnidadeMedida	Código da unidade de medida		Caractere	6
decimaisQuantidade	Decimais da quantidade do produto		Numérico
decimaisPreco	Decimais do preço do produto		Numérico
quantidade	Quantidade do produto		Numérico	15.6
precoUnitario	Preço unitário do produto		Numérico	15.6
desconto	Desconto do item		Numérico	12.2
total	Total do item		Numérico	12.2
pis	Valor de PIS do item		Numérico	12.2
cofins	Valor de COFINS do item		Numérico	12.2
ipi	Valor de IPI do item		Numérico	12.2
icms	Valor de ICMS do item		Numérico	12.2
icmsSt	Valos de ICMS ST do item		Numérico	12.2
iss	Valor de ISS do item		Numérico	12.2
frete	Valor do frete do item		Numérico	12.2
seguro	Valor do seguro do item		Numérico	12.2
outrasDespesas	Valor de outras despesas do item		Numérico	12.2
tributacao	Tributação do produto/item		Caractere	7		T – Tributado; I – Isento; N – Não tributado; F – Substituição tributária.
icmsfcp	Valor do ICMS do FCP		Numérico	12.2
acrescimo	Valor do acréscimo		Numérico	12.2
icmsstfcp	Valor do ICMS ST da CFP		Numérico	12.2
idNotaFiscal	Id da nota fiscal		Numérico
numeroNotaFiscal	Número da nota fiscal		Caractere	11
serie	Série da nota fiscal		Caractere	4
modelo	Modelo da nota fiscal		Caractere	6
chaveNfe	Chave da nota fiscal		Caractere	50
tipoEmissao	Tipo de emissão da nota fiscal		Caractere	1		P – Próprio; T – Terceiro.
status	Status da nota fiscal		Numérico			0 – Normal; 3 – NF-e autorizada; 4 – NF-e Rejeitada; 5 – NF-e Negada; 6 – NFS-e autorizada; 7 – NFS-e Rejeitada; 8 – NF-e emitida em contingência; 9 – Aguardando processamento; 10 – Problema no processamento; 11 – Problema no envio do lote; 14 – Aguardando retorno; 16 – NF-e emitida em contingência via EPEC; 17 – NF-e pendente de estorno (Negada na SEFAZ);
dataEntrada	Data da entrada/Emissão		Data
dataHoraEntrada	Data e hora da entrada/emissã		Datatime
valorProdutos	Valor total dos produtos na nota fiscal		Numérico	12.2
valorTotal	Valor total da nota fiscal		Numérico	12.2
fornecedorCodigo	Código do fornecedor		Caractere	14
fornecedorNome	Nome do fornecedor		Caractere	60
cfopNota	Código da CFOP da nota		Caractere	20
cfopNotaDescricao	Descrição da CFOP da nota fiscal		Caractere	1024
finalidadeEmissaoNfe	Finalidade da nota CFOP		Numérico			0 – Normal; 1 – Complementar; 2 – Ajuste; 3 – Ajuste com itens; 4 – Devolução de venda; 5 – Devolução de compra; 6 – Importação do PDV; 7 – Transferência de crédito de ICMS; 8 – Crédito de ICMS.
notaFiscalDevolucao	Informa se é ou não uma Nota Fiscal de Devolução		Caractere	1		S – Sim; N – Não.
filialCodigo	Código da filial		Caractere	4
filialNome	Nome da filial		Caractere	60