Entidades (v1)
Descrição geral
Manipulação de cliente, fornecedor, transportadora, vendedor, técnico, fabricante
URL
/public-api/v1/entidades
Verbos suportados
POST,PUT,GET,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” –data “${json}” –request “PUT” “${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 | |||
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 | ||||
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 | |||
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) | |
usuario | Usuário | Caracter | 10 | |||
creditoRestrito | Informa se a entidade está bloqueada | Inteiro | 1 | 1=Sim e 0=Não |
Produtos (v1)
Descrição geral
Manipulação de produtos e serviços
URL
/public-api/v1/produtos
Verbos suportados
POST,PUT,GET,DELETE
Status HTTP
200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes
JSON Exemplo
{“produto”: {“codigo”: “999000”, “nome”:”PRODUTO TESTE”, “preco”: 10.23}}
Exemplos
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –data “${json}” –request “POST” “${endereco_do_servidor}/public-api/v1/produtos”
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –data “${json}” –request “PUT” “${endereco_do_servidor}/public-api/v1/produtos”
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/produtos/${codigo}”
OBS: Caso trabalhe com preço por filial, pode ser passado a filial como parâmetro , após o código, no método acima. ex: ${codigo}?filial=2
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/produtos”
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “DELETE” “${endereco_do_servidor}/public-api/v1/produtos/${codigo}”
Observação
Caso queira consultar os produtos incluídos e/ou alterados após uma data e hora, é possível usar um filtro especial pelo currentTimeMillis, conforme este exemplo
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/produtos?currentTimeMillis.ge=1616786400000”
Para mais informações sobre como converter data e hora para currentTimeMillis veja https://currentmillis.com
Lista dos campos do JSON
Identificador | Descrição | Obrigatório | Tipo | Tamanho | Decimais | Observações |
---|---|---|---|---|---|---|
aliquotaCofins | Alíquota Cofins saída | Decimal | 5 | 2 | ||
aliquotaCofinsEntrada | Alíquota Cofins Entrada | Decimal | 5 | 4 | ||
aliquotaICMS | Aliquota ICMS | Decimal | 5 | 2 | Caso for serviço informar a alíquota do ISS | |
aliquotaIPI | Aliquota IPI | Decimal | 5 | 2 | ||
aliquotaPis | Alíquota Pis saída | Decimal | 5 | 2 | ||
aliquotaPisEntrada | Alíquota Pis Entrada | Decimal | 5 | 4 | ||
alturaShop | Altura shop | Decimal | 12 | 1 | ||
caminhoImagem | Caminho da imagem | Caracter | 200 | Ex: c:\exporta\arquivo.jpg | ||
casasDecimais | Casas decimais | Inteiro | Número de casas decimais da unidade de medida | |||
cest | Código do CEST | Caracter | 10 | |||
codigo | Código | Sim | Caracter | 20 | Se deixar em branco o sistema gera um sequencial | |
codigoCfopEntrada | CFOP interna de entrada | Caracter | 6 | |||
codigoCfopEntradaDevolucaoExterna | CFOP externa de entrada devolução | Caracter | 6 | |||
codigoCfopEntradaDevolucaoInterna | CFOP interna de entrada devolucao | Caracter | 6 | |||
codigoCfopEntradaExterna | CFOP externa de entrada | Caracter | 6 | |||
codigoCfopEntradaTransfExterna | CFOP externa de entrada transferência | Caracter | 6 | |||
codigoCfopEntradaTransfInterna | CFOP interna de entrada transferência | Caracter | 6 | |||
codigoCfopSaida | CFOP interna de saida | Caracter | 6 | |||
codigoCfopSaidaDevolucaoExterna | CFOP externa de saida devolução | Caracter | 6 | |||
codigoCfopSaidaDevolucaoInterna | CFOP interna de saida devolucao | Caracter | 6 | |||
codigoCfopSaidaExterna | CFOP externa de saida | Caracter | 6 | |||
codigoCfopSaidaTransfExterna | CFOP externa de saida transferência | Caracter | 6 | |||
codigoCfopSaidaTransfInterna | CFOP interna de saida transferência | Caracter | 6 | |||
codigoFabricante | Código do fabricante | Caracter | 10 | |||
codigoFornecedor | Código do fornecedor | Caracter | 10 | |||
codigoGrupoProduto | Codigo do grupo de produto | Caracter | 30 | |||
codigoLeiComplementar | Código da Lei complementar | Caracter | 10 | |||
codigoReceitaSemContribuicao | Código da Receita sem contribuição | Caracter | 10 | |||
comprimentoShop | Comprimento shop | Decimal | 12 | 1 | ||
cstPisCofins | CST Pis/Cofins saída | Caracter | 2 | |||
cstPisCofinsEntrada | CST Pis/Cofins Entrada | Caracter | 2 | |||
currentTimeMillis | Controle de registro | Inteiro | ||||
custo | Custo | Decimal | 12 | 6 | ||
custoMedioInicial | Custo médio inicial | Decimal | 15 | 6 | ||
descricaoShop | Descrição Uniplus Shop | Caracter | 4096 | |||
ean | Código EAN | Caracter | 20 | |||
enviaECommerce | Enviar produto ao E-Commerce | 1=Sim 0=Não | ||||
exigibilidadeIss | Indicador da exigibilidade do ISS | Inteiro | 1 | |||
extra1 | extra1 | Caracter | 50 | |||
extra2 | extra2 | Caracter | 50 | |||
extra3 | extra3 | Caracter | 50 | |||
extra4 | extra4 | Caracter | 50 | |||
extra5 | extra5 | Caracter | 50 | |||
extra6 | extra6 | Caracter | 50 | |||
iat | IAT | Caracter | 1 | A=Arredondamento T=Truncamento | ||
imagens | Imagens do produto | Retorno das imagens cadastradas no produto | ||||
inativo | Inativo | Inteiro | 1=inativo 0=ativo | |||
infoShop | Informações no Uniplus Shop | Caracter | 4096 | |||
informacaoAdicional | Informação Adicional | Caracter | 500 | |||
informarDimensoes | Informar dimensões | Inteiro | 1 | 1=Sim 0=Não | ||
ippt | IPPT | Caracter | 1 | P=fabricação própria T=fabricação por terceiros | ||
larguraShop | Largura shop | Decimal | 12 | 1 | ||
lucroBruto | % Lucro | Decimal | 5 | 2 | ||
ncm | NCM | Caracter | 10 | |||
nome | Nome | Sim | Caracter | 120 | ||
nomeEcf | Nome ECF | Caracter | 120 | |||
nomeFornecedor | Nome do fornecedor | Caracter | 50 | |||
nomeGrupoProduto | Nome do grupo do produto | Caracter | 40 | Nome do grupo. Caso não informado será usado GERAL | ||
numeroSerie | Número de série | Inteiro | Controlar o produto por número de série 1=Sim 0=Não | |||
observacao | Observação | Caracter | 4096 | |||
origem | Origem | Inteiro | 0=Nacional 1=Importado | |||
pesavel | Pesável | Inteiro | 1=produto pesável 0=produto não pesável | |||
peso | Peso | Decimal | 12 | 3 | ||
pesoShop | Peso shop | Decimal | 12 | 3 | ||
preco | Preço | Sim | Decimal | 15 | 6 | Preço (Venda) |
precoPauta1 | Pauta preço 1 | Decimal | 15 | 6 | Preço na pauta 1 | |
precoPauta2 | Pauta preço 2 | Decimal | 15 | 6 | Preço na pauta 2 | |
precoPauta3 | Pauta preço 3 | Decimal | 15 | 6 | Preço na pauta 3 | |
precoPauta4 | Pauta preço 4 | Decimal | 15 | 6 | Preço na pauta 4 | |
precos | Preços por filiais | Lista de Produto preço, para filiais(Verificar documentação de Produto preço) | ||||
referencia | Referência | Caracter | 20 | |||
situacaoTributaria | Codigo da situação tributária | Caracter | 3 | |||
situacaoTributariaSN | Situação tributária Simples Nacional NF-e | Caracter | 3 | |||
tipoProduto | Tipo produto | Caracter | 2 | 00=Mercadoria p/ revenda 01=Mat.Prim 02=Embalagem 03=Prod. Em Processo 04=Prod. Acabado 05=SubProduto 06=Prod.Intermediario 07=Mat.Uso Consumo 08=Ativo Imobilizado 09=Serviços 10=Outros insumos 99=Outros | ||
tipoRegistro | Tipo do registro | Caracter | 1 | P=Produto S=Serviço | ||
tributacaoEspecial | Tributacao especial | Caracter | 10 | |||
tributacaoEspecialNfceSat | Situação tributária especial para NFC-e/SAT | Caracter | 3 | |||
tributacaoICMS | Tributacao ICMS | Caracter | 7 | Para produto: T=Tributado N=Não tributado I=Isento F=Substituição tributária.Para servico: S=Tributado, NS=Não tributado, IS=Isento, FS=substituição tributária | ||
tributacaoSN | Situação tributária Simples Nacional NFC-e e SAT | Caracter | 3 | |||
unidadeMedida | Unidade de medida | Sim | Caracter | 3 | Ex: UN,PC,CX | |
tipoVolume | Tipo de volume | Inteiro | 1 | 1=Volumes 2=Embalagem | ||
quantidadeVolume | Quantidade do volume | Inteiro | 2 | |||
possuiVariacao | Identifica se o produto possui variação | Inteiro | 1 | 1=Sim 0=Não | ||
enviarOutrosECommerce | Identifica se o produto será enviado para ecommerce integrado | Inteiro | 1 | 1=Sim 0=Não | ||
possuiLote | Identifica se o produto possui lote | Inteiro | 1 | 1=Sim 0=Não | ||
kit | Identifica se o produto é um kit | Inteiro | 1 | 1=Sim 0=Não |
Produto preço (v1)
Descrição geral
Manipulação de preço quando trabalhar com preços diferente por filial
JSON Exemplo
“precos”: [{“filial”: “1”, “preco”: 10.500000}]
Observação
Este objeto tem que ser enviado junto ao produto para cadastrar ou alterar o preço de um produto para uma determinada filial.
Lista dos campos do JSON
Identificador | Descrição | Obrigatório | Tipo | Tamanho | Decimais | Observações |
---|---|---|---|---|---|---|
filial | Filial | Sim | Caracter | 4 | Código da filial que vai receber a atualização do preço | |
preco | Preço | Sim | Decimal | 15 | 6 | Preço (Venda) |
Embalagens (v1)
Descrição geral
Manipulação de embalagens de produtos
URL
/public-api/v1/embalagens
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
{“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 |
EANs (v1)
Descrição geral
Manipulação de eans adicionais de produtos
URL
/public-api/v1/eans
Verbos suportados
POST,GET,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 |
Variações (v1)
Descrição geral
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” –data “${json}” –request “PUT” “${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 | Caracter | 100 | ||
descricao | Descrição do valor | Sim | Caracter | 30 | ||
ordem | Ordem | Sim | Caracter | 5 | Posição no desenho da grade | |
produto | Código do produto | Sim | Caracter | 14 | ||
tipoRegistro | Tipo do registro | Sim | Caracter | 1 | 0=Linha 1=Coluna | |
variacao | Código da variação | Não | Caracter | Código da variação montada |
Saldo em estoque (v1)
Descrição geral
Seta o saldo em estoque de produtos
URL
/public-api/v1/saldo-estoque
Verbos suportados
POST,GET
Status HTTP
200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes
JSON Exemplo
{“saldoEstoque”: {“produto”: “97”, “quantidade”:200}}
Exemplos
curl –verbose –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –data “${json}” –request “POST” “${endereco_do_servidor}/public-api/v1/saldo-estoque”
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/saldo-estoque?produto=${97}&filial=${1}”
Observação
Atenção: versão descontinuada. Verifique a versão mais nova do endpoint
Lista dos campos do JSON
Identificador | Descrição | Obrigatório | Tipo | Tamanho | Decimais | Observações |
---|---|---|---|---|---|---|
custo | Custo | Decimal | 15 | 6 | ||
custoMedio | Custo médio | Decimal | 15 | 6 | ||
filial | Filial | Caracter | 4 | Código da filial | ||
produto | Produto | Sim | Caracter | 14 | Código do produto | |
quantidade | Quantidade | Sim | Decimal | 12 | 6 | |
variacao | Variação | Caracter | 12 |
Saldo em estoque (v2)
Descrição geral
Seta o saldo em estoque de produtos
URL
/public-api/v2/saldo-estoque
Verbos suportados
POST,GET
Status HTTP
200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes
JSON Exemplo
{“saldoEstoque”: {“produto”: “97”, “quantidade”:200}}
Exemplos
Atualizando o saldo
curl –verbose –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –data “${json}” –request “POST” “${endereco_do_servidor}/public-api/v2/saldo-estoque”
Buscando saldo por produto e filial
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v2/saldo-estoque?produto=${97}&filial=${1}”
Buscando saldo por alteração maior ou igual ao current time millis
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v2/saldo-estoque?currenttimemillis=${1620308836208}”
Lista dos campos do JSON
Identificador | Descrição | Obrigatório | Tipo | Tamanho | Decimais | Observações |
---|---|---|---|---|---|---|
custo | Custo | Decimal | 15 | 6 | ||
custoMedio | Custo médio | Decimal | 15 | 6 | ||
filial | Filial | Caracter | 4 | Código da filial | ||
produto | Produto | Sim | Caracter | 14 | Código do produto | |
quantidade | Quantidade | Sim | Decimal | 12 | 6 | |
variacao | Variação | Caracter | 12 | |||
localEstoque | Local de estoque | Caracter | 5 | Código do local de estoque |
Saldo em estoque por variação (v2)
Descrição geral
Devolve uma lista de saldo em estoque do produto por variação
URL
/public-api/v2/saldo-estoque/variacao
Verbos suportados
GET
Status HTTP
200 = OK, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes
JSON Exemplo
[{“variacao”: “AMARELO/P”, “saldo”:200}]
Exemplos
Consultando o saldo por variação
curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v2/saldo-estoque/variacao?produto=${97}&filial=${1}”
Lista dos campos do JSON
Identificador | Descrição | Obrigatório | Tipo | Tamanho | Decimais | Observações |
---|---|---|---|---|---|---|
codigo | Código da variação | Inteiro | ||||
saldo | Saldo em estoque | Decimal | 12 | 6 | ||
variacao | Variação | Caracter |
DAVs (v1)
Manipulação de DAVS (orçamentos, pré-vendas, pedidos de venda, pedidos de faturamento)
URL
/public-api/v1/davs
Verbos suportados
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
Cabeçalho | ||||||
---|---|---|---|---|---|---|
Identificador | Descrição | Obrigatório | Tipo | Tamanho | Decimais | Observações |
bairroEntrega | Bairro da entrega | Caracter | 50 | |||
cepEntrega | CEP da entrega | Caracter | 9 | |||
cidadeEntrega | Cidade da entrega | Caracter | 100 | |||
cliente | Cliente | Caracter | 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 | Caracter | 20 | Associa outro código identificador no prév-vendas | ||
codigoPauta | Número da pauta de preços | Caracter | 1 | |||
codigoTipoFrete | Código do tipo de frete | Caracter | 1 | 0=Destinatário 1=Emitente 2=Sem frete 9=Terceiros | ||
codigoTransportadora | Código da transportadora | Caracter | 14 | Código da transportadora (entidade) | ||
complementoEntrega | Complemento da entrega | Caracter | 50 | |||
condicaoPagamento | Condição de pagamento | Caracter | 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 | Caracter | 50 | |||
estadoEntrega | Estado da entrega | Caracter | 2 | |||
extra1 | Campo extra 1 | Caracter | 512 | |||
extra2 | Campo extra 2 | Caracter | 512 | |||
filial | Filial | Caracter | 4 | Código da filial | ||
numeroEntrega | Número do endereço da entrega | Caracter | 6 | |||
observacao | Observação | Caracter | 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 | Caracter | 14 | Código do vendedor (entidade) | ||
codigoECommerce | Código do pedido do e-commerce | Caracter | 50 |
itens | ||||||
---|---|---|---|---|---|---|
Identificador | Descrição | Obrigatório | Tipo | Tamanho | Decimais | Observações |
codigoDAV | Codigo do DAV | Inteiro | ||||
codigoUnidadeMedida | Unidade de medida | Caracter | 3 | Código da unidade de medida | ||
desconto | Desconto | Decimal | 12 | 3 | ||
isBrinde | Brinde | Inteiro | 0=Não 1=Sim | |||
nrItem | Número do item | Inteiro | ||||
numeroSerie | Número de série | Caracter | 20 | |||
precoTotal | Preco total | Decimal | 12 | 2 | ||
precoUnitario | Preco unitário | Sim | Decimal | 12 | 3 | |
produto | Produto | Sim | Caracter | 14 | Código do produto | |
quantidade | Quantidade | Sim | Decimal | 12 | 3 | |
tipoDesconto | Tipo de desconto | Caracter | 1 | 0=Percentual 1=Valor |
variacoes | ||||||
---|---|---|---|---|---|---|
Identificador | Descrição | Obrigatório | Tipo | Tamanho | Decimais | Observações |
variacao | Código da Variação | Inteiro | ||||
quantidade | Quantidade da variação | Inteiro |