Central do Uniplus

Índice
< Todo o conteúdo
Imprimir

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

IdentificadorDescriçãoObrigatórioTipoTamanhoDecimaisObservações
aliquotaCofinsAlíquota Cofins saídaDecimal52
aliquotaCofinsEntradaAlíquota Cofins EntradaDecimal54
aliquotaICMSAliquota ICMSDecimal52Caso for serviço informar a alíquota do ISS
aliquotaIPIAliquota IPIDecimal52
aliquotaPisAlíquota Pis saídaDecimal52
aliquotaPisEntradaAlíquota Pis EntradaDecimal54
alturaShopAltura shopDecimal121
caminhoImagemCaminho da imagemCaracter200Ex: c:exportaarquivo.jpg
casasDecimaisCasas decimaisInteiroNúmero de casas decimais da unidade de medida
cestCódigo do CESTCaracter10
codigoCódigoSimCaracter20Se deixar em branco o sistema gera um sequencial
codigoCfopEntradaCFOP interna de entradaCaracter6
codigoCfopEntradaDevolucaoExternaCFOP externa de entrada devoluçãoCaracter6
codigoCfopEntradaDevolucaoInternaCFOP interna de entrada devolucaoCaracter6
codigoCfopEntradaExternaCFOP externa de entradaCaracter6
codigoCfopEntradaTransfExternaCFOP externa de entrada transferênciaCaracter6
codigoCfopEntradaTransfInternaCFOP interna de entrada transferênciaCaracter6
codigoCfopSaidaCFOP interna de saidaCaracter6
codigoCfopSaidaDevolucaoExternaCFOP externa de saida devoluçãoCaracter6
codigoCfopSaidaDevolucaoInternaCFOP interna de saida devolucaoCaracter6
codigoCfopSaidaExternaCFOP externa de saidaCaracter6

codigoCfopSaidaExternaNaoContribuinte
CFOP Externa de saída para não contribuinte Caracter6
codigoCfopSaidaTransfExternaCFOP externa de saida transferênciaCaracter6
codigoCfopSaidaTransfInternaCFOP interna de saida transferênciaCaracter6
codigoFabricanteCódigo do fabricanteCaracter10
codigoFornecedorCódigo do fornecedorCaracter10
codigoGrupoProdutoCodigo do grupo de produtoCaracter30
codigoLeiComplementarCódigo da Lei complementarCaracter10
codigoReceitaSemContribuicaoCódigo da Receita sem contribuiçãoCaracter10
comprimentoShopComprimento shopDecimal121
cstPisCofinsCST Pis/Cofins saídaCaracter2
cstPisCofinsEntradaCST Pis/Cofins EntradaCaracter2
currentTimeMillisControle de registroInteiro
custoCustoDecimal126
custoMedioInicialCusto médio inicialDecimal156
descricaoShopDescrição Uniplus ShopCaracter4096
eanCódigo EANCaracter20
enviaECommerceEnviar produto ao E-Commerce1=Sim 0=Não
exigibilidadeIssIndicador da exigibilidade do ISSInteiro1
extra1extra1Caracter50
extra2extra2Caracter50
extra3extra3Caracter50
extra4extra4Caracter50
extra5extra5Caracter50
extra6extra6Caracter50
iatIATCaracter1A=Arredondamento T=Truncamento
imagensImagens do produtoRetorno das imagens cadastradas no produto
inativoInativoInteiro1=inativo 0=ativo
infoShopInformações no Uniplus ShopCaracter4096
informacaoAdicionalInformação AdicionalCaracter500
informarDimensoesInformar dimensõesInteiro11=Sim 0=Não
ipptIPPTCaracter1P=fabricação própria T=fabricação por terceiros
larguraShopLargura shopDecimal121
lucroBruto% LucroDecimal52
ncmNCMCaracter10
nomeNomeSimCaracter120
nomeEcfNome ECFCaracter120
nomeFornecedorNome do fornecedorCaracter50
nomeGrupoProdutoNome do grupo do produtoCaracter40Nome do grupo. Caso não informado será usado GERAL
numeroSerieNúmero de sérieInteiroControlar o produto por número de série 1=Sim 0=Não
observacaoObservaçãoCaracter4096
origemOrigemInteiro0=Nacional 1=Importado
pesavelPesávelInteiro1=produto pesável 0=produto não pesável
pesoPesoDecimal123
pesoShopPeso shopDecimal123
precoPreçoSimDecimal156Preço (Venda)
precoPauta1Pauta preço 1Decimal156Preço na pauta 1
precoPauta2Pauta preço 2Decimal156Preço na pauta 2
precoPauta3Pauta preço 3Decimal156Preço na pauta 3
precoPauta4Pauta preço 4Decimal156Preço na pauta 4
precosPreços por filiaisLista de Produto preço, para filiais(Verificar documentação de Produto preço)
referenciaReferênciaCaracter20
situacaoTributariaCodigo da situação tributáriaCaracter3
situacaoTributariaSNSituação tributária Simples Nacional NF-eCaracter3
tipoProdutoTipo produtoCaracter200=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
tipoRegistroTipo do registroCaracter1P=Produto S=Serviço
tributacaoEspecialTributacao especialCaracter10
tributacaoEspecialNfceSatSituação tributária especial para NFC-e/SATCaracter3
tributacaoICMSTributacao ICMSCaracter7Para 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
tributacaoSNSituação tributária Simples Nacional NFC-e e SATCaracter3
unidadeMedidaUnidade de medidaSimCaracter3Ex: UN,PC,CX
tipoVolumeTipo de volumeInteiro11=Volumes 2=Embalagem
quantidadeVolumeQuantidade do volumeInteiro2
possuiVariacaoIdentifica se o produto possui variaçãoInteiro11=Sim 0=Não
enviarOutrosECommerceIdentifica se o produto será enviado para ecommerce integradoInteiro11=Sim 0=Não
possuiLoteIdentifica se o produto possui loteInteiro11=Sim 0=Não
kitIdentifica se o produto é um kitInteiro11=Sim 0=Não
codigoEmpresaInformação de código das empresas, para quando o sistema estiver trabalhando com “Produto por empresa”Inteiro10
codigoBeneficioFiscalPDVCódigo do Benefício Fiscal do PDVCaractere10
descricaoBeneficioFiscalPDVDescrição do beneficio fiscal do PDVCaractere512
motivoDesoneracaoIcmsPDVCódigo do motivo da desoneraçãoNumérico1 – 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.
codigoBeneficioFiscalNFCódigo do benefício fiscal da NF-eCaractere10
descricaoBeneficioFiscalNFDescrição do benefício fiscal da NF-eCaractere512
motivoDesoneracaoNfCódigo do motivo da desoneraçãoNumérico1 – 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.
Lista de Objetos opcionais


 Estrutura de Opcionais do Uniplus Gourmet

IdentificadorDescriçãoObrigatórioTipoTamanhoDecimaisObservações
codigoCódigo do produto opcionalCaractere20
descricaoDescrição do produto opcionalCaractere120
precoPreço adicionalNumérico123

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

15 Artigos recentes

Ver os últimos 100