Á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

Campo

Tipo

Descrição

Obrigatório

Observações

descricaostringDescrição do produto
Obrigatório;

X


Tamanho máximo: 200

unidadeMedidastringUnidade de medida do produto
Obrigatório;

X


Tamanho máximo: 20

descontoMaximostringDesconto máximo aplicado ao produto
Opcional


arredondaTruncaint
Opcional



codigoProdutostringCódigo do produto
Obrigatório;

X


Tamanho máximo: 600

codigoAlternativostringCódigo alternativo do produto
Obrigatório;

X


Tamanho máximo: 40

origemProdutointOrigem do produto
Obrigatório
X
situacaointSituação do produto (0 - Inativo, 1 - Ativo)
Obrigatório

X


imagemstringURL com a imagem do produto
Opcional


tipoProdutointTipo do produto
Obrigatório
X
fracionadobooleanIndica se o produto é vendido fracionado
Opcional


cnpjFornecedorstringCNPJ do fornecedor do produto
Opcional


escalaRelevantebooleanEscala relevante
Opcional


cstIcmsstringCST ICMS do produto
Opcional


percentualReducaoIcmsstringPercentual de redução ICMS
Opcional


aliquotaIcmsstringAliquota ICMS
Opcional


vlicmsretstringvlicmsret
Opcional


ceststringCest
Opcional


encomendabooleanIndica se o produto é uma encomenda
Opcional


pesoLiquidofloatPeso liquido do produto
Opcional


pesoBrutofloatPeso bruto do produto
Opcional


associacaoProdutosClassificacaoLista de objetosLista de classificação do produto
Opcional


associacaoProdutosClassificacao.idRetaguardastringIdentificador da classificação na retaguarda
Opcional


associacaoProdutosClassificacao.idRetaguardaProdutostringIdentificador do produto na retaguarda
Opcional


associacaoProdutosClassificacao.idRetaguardaClassificacaoProdutostringIdentificador da classificação na retaguarda
Opcional


associacaoProdutosClassificacao.ordemOpcionalintOrdem opcional
Opcional


associacaoProdutosClassificacao.situacaointSituação da classificação
Opcional


produtoEmbalagenslista de objetos

Lista de embalagens do produto

Opcional


produtoEmbalagens.codigoBarrasstringCódigo de barras da embalagem
Opcional


produtoEmbalagens.descricaostringDescrição da embalagem
Opcional


produtoEmbalagens.idProdutoRetaguardastringIdentificador do produto na retaguarda
Opcional


produtoEmbalagens.idRetaguardastringIdentificador da embalagem na retaguarda
Opcional


produtoEmbalagens.pesoBrutofloatPeso bruto da embalagem
Opcional


produtoEmbalagens.pesoLiquidofloatPeso liquido da embalagem
Opcional


produtoEmbalagens.quantidadeintQuantidade de produtos na embalagem
Opcional


produtoEmbalagens.situacaointSituação da embalagem
Opcional


produtoEmbalagens.unidadeMedidastringUnidade de medida da embalagem
Opcional


produtoKitsLista de objetosLista de kits
Opcional


produtoKits.idRetaguardaProdutostringIdentificador do produto na retaguarda
Opcional


produtoKits.idRetaguardaProdutoKitstringIdentificador do kit na retaguarda
Opcional


produtoKits.descricaostringDescrição do kit
Opcional


produtoKits.quantidadeVendaKitint

Quantidade de venda do kit 

Opcional



produtoKits.tipoValorKitintTipo valor kit
Opcional


produtoKits.situacaointSituação do kit
Opcional


produtoKits.valorDescontostringValor de desconto
Opcional


produtoKits.novoValorUnitariostringNovo valor unitário
Opcional


produtosSimilaresLista de objetosLista de produtos similares
Opcional


produtosSimilares.idRetaguardaProdutostringIdentificador do produto na retaguarda
Opcional


produtosSimilares.idRetaguardaSimilarstringIdentificador do produto similar na retaguarda
Opcional


produtosSimilares.situacaointSituação do produto similar
Opcional


produtosSugestoesLista de objetosLista de sugestôes
Opcional


produtosSugestoes.idRetaguardaProdutostringIdentificador do produto na retaguarda
Opcional


produtosSugestoes.idRetaguardaSugestaostringIdentificador da sugestão na retaguarda
Opcional


produtosSugestoes.situacaointSituação da sugestão
Opcional


codigosProdutoLista de objetosLista de códigos do produto
Opcional


codigosProduto.codigostringCódigo do produto
Opcional


codigosProduto.descricaostringDescrição do código
Opcional


codigosProduto.idRetaguardastringIdentificador do código na retaguarda
Opcional


codigosProduto.dataAtualizacaostringData atualização do código
Opcional


codigosProduto.dataCadastrostringData cadastro do código
Opcional


codigosProduto.situacaointSituação do produto
Opcional


impostosLista de objetosLista de impostos do produto
Obrigatório


impostos.idRetaguardastringIdentificador do imposto na retaguarda
Opcional


impostos.idProprietariostringIdentificador do proprietário
Opcional


ncmsLista de objetosLista de NCMs
Opcional


ncms.idRetaguardastringIdentificador do NCM na retaguarda
Opcional


ncms.idProprietariostringIdentificador do proprietário
Opcional


pisCofinsLista de objetosLista de PisCofins
Opcional


pisCofins.idRetaguardastringIdentificador do PisCofin na retaguarda
Opcional


pisCofins.idProprietariostringIdentificador do proprietário
Opcional


fcpsLista de objetosLista de FCPs
Opcional


fcps.valorBaseFcpstringValor base do FCP
Opcional


fcps.percentualFcpstringPercentual do FCP
Opcional


fcps.codigoBeneficioFiscalstringCódigo de benefício fiscal
Opcional


fcps.motivoDesoneracaoIcmsintMotivo desoneração
Opcional


fcps.descontaDesoneracaoNfbooleanDesconto desoneraçao
Opcional


fcps.idProprietariostringIdentificador do proprietário
Opcional


quantidadeMovimentacaofloatQuanitdade de movimentação
Opcional


idInquilinostringIdentificador do inquilino
Obrigatório
X
idRetaguardastringIdentificador do produto na retaguarda
Obrigatório;

X


Tamanho máximo: 100

idProprietariostringIdentificador do proprietário
Obrigatório


loteOrigemstringIdentificador do lote que os dados serão enviados
Opcional


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