Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Expandir
titleDefinição dos campos de requisição
SIMSIMSIM

Campo

Tipo

Descrição

Obrigatório

Observações

descricaostringDescrição do produtoSIM

Sim

  • Tamanho máximo: 200
  • Estes caracteres especiais: "\r","\n","\"",@"\" são removidos ao inserir no PDV, pois podem ocasionar erro na SEFAZ.
unidadeMedidastringUnidade de medida do produtoSIM

Sim


  • Tamanho máximo: 20
descontoMaximostringnuméricoDesconto máximo aplicado ao produtoNão
arredondaTruncatipoArredondaTruncaint
Não
codigoProdutostringCódigo do produtoSIM

Sim


  • Tamanho máximo: 60020
codigoAlternativostringCódigo alternativo do produtoSIM

Sim


  • Tamanho máximo: 40
origemProdutointOrigem do produtoSim0 – Nacional: exceto as indicadas nos códigos 3, 4, 5 e 8;
1 – Estrangeira: importação direta, exceto a indicada no código 6;
2 – Estrangeira: adquirida no mercado interno, exceto a indicada no código 7;
3 – Nacional: mercadoria ou bem com conteúdo de importação superior a 40% e inferior ou igual a 70%;
4 – Nacional: cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam o Decreto-Lei nº 288/1967, e as Leis nº 8.248/1991, 8.387/1991, 10.176/2001 e 11.484/2007;
5 – Nacional: mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%;
6 – Estrangeira: importação direta, sem similar nacional, constante em lista de Resolução Camex e gás natural;
7 – Estrangeira: adquirida no mercado interno, sem similar nacional, constante em lista de Resolução Camex e gás natural;
8 – Nacional: mercadoria ou bem com Conteúdo de Importação superior a 70%.
situacaointSituação do produto 

Sim

produto (

0 - Inativo, 1 - Ativo

)

SIM

imagemstringURL com a imagem do produtoNãoTamanho máximo: 200 caracteres
tipoProdutointTipo do produtoNãofracionado
Descrição
booleanIndica se o produto é vendido fracionado
Valor
Não definido0
Consumo1
Revenda2
Kit3
Matéria4
Produto acabado5
Serviço6
fracionadobooleanIndica se o produto é vendido fracionadoNão
cnpjFornecedorstringcnpjFornecedorstringCNPJ do fornecedor do produtoNãoTamanho máximo: 20 caracteres
escalaRelevantebooleanEscala relevanteNão
cstIcmsstringDEFASADONãoTamanho máximo: 4 caracteres
percentualReducaoIcmsnuméricoCST ICMS do produtopercentualReducaoIcmsstringPercentual de redução ICMSNão
aliquotaIcmsintnuméricoAliquota ICMSNãoPode ser enviado como string para atender ao legado, contudo, caso se enviado algo que não possa ser convertido para inteiro será devolvido um retorno de erro.
vlicmsretstringvlicmsretDEFASADONãoTamanho máximo: 7 caracteres
ceststringCestNão
encomendabooleanIndica se o produto é uma encomendaNão
pesoLiquidofloatnuméricoPeso liquido do produtoNão
pesoBrutofloatnuméricoPeso bruto do produtoNão
associacaoProdutosClassificacaoLista de objetosLista de classificação do produtoNão
associacaoProdutosClassificacao.idRetaguardastringIdentificador da classificação na retaguardaSimTamanho máximo: 100 caracteres
associacaoProdutosClassificacao.idRetaguardaProdutostringIdentificador do produto na retaguardaSim
associacaoProdutosClassificacao.idRetaguardaClassificacaoProdutostringIdentificador da classificação na retaguardaSim
associacaoProdutosClassificacao.ordemOpcionalordemintOrdem opcionalSim
associacaoProdutosClassificacao.situacaointSituação da classificaçãoSim
produtoEmbalagenslista de objetos

Lista de embalagens do produto

Não
produtoEmbalagens.codigoBarrasstringCódigo de barras da embalagemSimTamanho máximo: 20 caracteres
produtoEmbalagens.descricaostringDescrição da embalagemNão
  • Tamanho máxiom: 200 caracteres
  • Estes caracteres especiais: "\r","\n","\"",@"\" são removidos ao inserir no PDV, pois podem ocasionar erro na SEFAZ.
produtoEmbalagens.idProdutoRetaguardastringIdentificador do produto na retaguardaSimTamanho máximo: 100 caracteres
produtoEmbalagens.idRetaguardastringIdentificador da embalagem na retaguardaSimTamanho máximo: 100 caracteres
produtoEmbalagens.pesoBrutofloatintPeso bruto da embalagemNão
produtoEmbalagens.pesoLiquidofloatintPeso liquido da embalagemNão
produtoEmbalagens.quantidadeintQuantidade de produtos na embalagemNão
produtoEmbalagens.situacaointSituação da embalagemSim0 - Inativo 1 - Ativo
produtoEmbalagens.unidadeMedidastringUnidade de medida da embalagemSim
produtoKitsLista de objetosLista de kitsNão
produtoKits.idRetaguardastringRegisto único, responsável por identificar o item na tabela de produto_kit.Sim
  • Tamanho máximo: 100 caracteres
  • Registro único, não deve ser enviado mais de uma vez, em caso de criação de itens dentro do kit.
  • Caso seja enviado mais de uma vez, o mesmo código, o registro será alterado.
produtoKits.idRetaguardaProdutostringIdentificador do produto KIT criado na tabela de produto.Não
  • Todo kit é um produto, devido a isso sempre haverá um registro descrito como kit na tabela de produto.
produtoKits.idRetaguardaProdutoKitstringIdentificador do item do kit na tabela de produtoNão
  • Referencia os itens da tabela de produto que compõe o kit.
produtoKits.descricaostringDescrição do kitproduto que compõe o KITSimTamanho máximo: 100 caracteres
produtoKits.quantidadeVendaKitint

Quantidade de venda do kit daquele determinado item dentro do KIT.

Sim
produtoKits.tipoValorKitintTipo valor kitSim
TipoValorDescrição
Não tem desconto0O valor da tabela vigente será considerado para o item
Valor fixo1O valor do campo novoValorUnitario será o valor do item no KIT
Percentual desconto2O valor do campo valorDesconto será aplicado no item percentualmente. Por exemplo: Se o valor da valorDesconto for 10.00, será aplicado 10% de desconto no item
Tipo valor kit
produtoKits.situacaointSituação do kitSim0 - Inativo 1 - Ativo
produtoKits.valorDescontostringnuméricoValor percentual que será aplicado de desconto no item da composição do KITNão
produtoKits.novoValorUnitariostringnuméricoValor real que será aplicado de desconto no item da composição do KIT, desconsiderando o valor da tabela de preço atualNãoNovo valor unitário
produtosSimilaresLista de objetosLista de produtos similaresNão
produtosSimilares.idRetaguardaProdutostringIdentificador do produto na retaguardaSimTamanho máximo: 100 caracteres
produtosSimilares.idRetaguardaSimilarstringIdentificador do produto similar na retaguardaSimTamanho máximo: 100 caracteres
produtosSimilares.situacaointSituação do produto similarSim0 - Inativo 1 - Ativo
produtosSugestoesLista de objetosLista de sugestôesNão
produtosSugestoes.idRetaguardaProdutostringIdentificador do produto na retaguardaSim
produtosSugestoes.idRetaguardaSugestaostringIdentificador da sugestão na retaguardaSim
produtosSugestoes.situacaointSituação da sugestãoSim
codigosProdutoLista de objetosLista de códigos do produtoNão
codigosProduto.codigostringCódigo do produtoNão
codigosProduto.descricaostringDescrição do códigoNão
codigosProduto.idRetaguardastringIdentificador do código na retaguardaNão
codigosProduto.dataAtualizacaostringData atualização do códigoNão
codigosProduto.dataCadastrostringData cadastro do códigoNão
codigosProduto.situacaointSituação do produtoNão
impostosLista de objetosLista de impostos do produtoSim
impostos.idRetaguardastringIdentificador do imposto na retaguardaretaguardaSim
impostos.idProprietariostringIdentificador do proprietárioSim
ncmsLista de objetosLista de NCMsSim
ncms.idRetaguardastringIdentificador do NCM na retaguardaSim
ncms.idProprietariostringIdentificador do proprietárioSim
pisCofinsLista de objetosLista de PisCofinsSim
pisCofins.idRetaguardastringIdentificador do PisCofin na retaguardaSim
pisCofins.idProprietariostringIdentificador do proprietárioSim
fcpsLista de objetosLista de FCPsNão
fcps.valorBaseFcpstringDEFASADONãoValor base do FCP
fcps.percentualFcpstringnuméricoPercentual do FCPNão
fcps.codigoBeneficioFiscalstringCódigo de benefício fiscalNãoTamanho máximo: 20 caracteres
fcps.motivoDesoneracaoIcmsintMotivo desoneraçãoNão
fcps.descontaDesoneracaoNfbooleanDEFASADODesconto desoneraçaoNão
fcps.idProprietariostringIdentificador do proprietárioNão
quantidadeMovimentacaofloatnuméricoQuanitdade de movimentaçãoNão
idInquilinostringIdentificador do inquilinoSim
idRetaguardastringIdentificador do produto na retaguardaSIM

Sim


  • Tamanho máximo: 100
idProprietariostringIdentificador do proprietárioSim
loteOrigemstringIdentificador do lote que os dados serão enviadosSim
Expandir
titleDefinição dos campos de retorno
Expandir
title200 - Ok

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos
Expandir
titleBody de retorno

{
    "success": true,
    "message": "",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Expandir
title400 - Bad Request

Campo

Tipo

Descrição

codestringCódigo de erro
messagestringMensagem do erro
detailedMessagestringDetalhamento do erro
helpUrlstringurl de ajuda
TotalTimestringTempo total de busca
detailslista de objetoLista de objeto de erros
details.guidstringIdentificador do erro
details.codestringCódigo do erro
details.messagestringMensagem do erro 
details.detailedMessagestringDetalhamento do erro