Endpoint Produtos (v1)
Descrição geral
Manipulação de produtos e serviços
URL
“/public-api/v1/produtos“
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
{“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}”
Observação: 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, acesse esse link.
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:exportaarquivo.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 | |||
codigoCfopSaidaExternaNaoContribuinte | CFOP Externa de saída para não contribuinte | 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 | ||
| codigoEmpresa | Informação de código das empresas, para quando o sistema estiver trabalhando com “Produto por empresa” | Inteiro | 10 | |||
| codigoBeneficioFiscalPDV | Código do Benefício Fiscal do PDV | Caractere | 10 | |||
| descricaoBeneficioFiscalPDV | Descrição do beneficio fiscal do PDV | Caractere | 512 | |||
| motivoDesoneracaoIcmsPDV | Código do motivo da desoneração | Numérico | 1 – Táxi; 3 – Uso na agropecuária/Produtor Agropecuário; 4 – Frotista/Locadora; 5 – Diplomático/Consular; 6 – Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 – CONTRAN e suas alterações); 7 – SUFRAMA; 8 – Venda a Órgão Público; 9 – Outros,; 10 – Deficiente Condutor (Convênio ICMS 38/12); 11 – Deficiente Não Condutor (Convênio ICMS 38/12); 12 – Órgão de fomento e desenvolvimento agropecuário; 90 – Solicitado pelo fisco. | |||
| codigoBeneficioFiscalNF | Código do benefício fiscal da NF-e | Caractere | 10 | |||
| descricaoBeneficioFiscalNF | Descrição do benefício fiscal da NF-e | Caractere | 512 | |||
| motivoDesoneracaoNf | Código do motivo da desoneração | Numérico | 1 – Táxi; 3 – Uso na agropecuária/Produtor Agropecuário; 4 – Frotista/Locadora; 5 – Diplomático/Consular; 6 – Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 – CONTRAN e suas alterações); 7 – SUFRAMA; 8 – Venda a Órgão Público; 9 – Outros; 10 – Deficiente Condutor (Convênio ICMS 38/12); 11 – Deficiente Não Condutor (Convênio ICMS 38/12); 12 – Órgão de fomento e desenvolvimento agropecuário; 90 – Solicitado pelo fisco. |
Conteúdo Relacionado
Os artigos listados abaixo estão relacionados ao que você acabou de ler:
• API Rest (WEB)
• Antes de Falar com o Suporte Técnico
• Obtendo suporte técnico e ajuda