Card |
---|
id | card2 |
---|
label | Como integrar |
---|
|
Para maiores informações de como integrar o Produto, clique aqui. |
Card |
---|
id | card2 |
---|
label | Como integrar |
---|
|
Este método é responsável pela criação ou alteração de produtos que devem ser enviados para o PDV - Endpoint: /api/retaguarda/v2/produtos
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Este endpoint recebe uma lista de Produtos para que possam ser enviados vários na mesma requisição Aviso |
---|
Para que a baixa do Produto criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 12 = Produto |
Deck of Cards |
---|
|
|
Card |
---|
|
Requisição
Section |
---|
Column |
---|
|
Exemplo de body da requisição
[
{
"aliquotaIcms": 0,
"arredondaTrunca": 0,
"associacaoProdutosClassificacao": [
{
"idRetaguarda": "string",
"idRetaguardaClassificacaoProduto": "string",
"idRetaguardaProduto": "string",
"ordem": 0,
"situacao": 0
}
],
"cest": "string",
"cnpjFornecedor": "string",
"codigoAlternativo": "string",
"codigoProduto": "string",
"codigosProduto": [
{
"codigo": "string",
"dataAtualizacao": "2024-03-28T13:13:11.127Z",
"dataCadastro": "2024-03-28T13:13:11.127Z",
"descricao": "string",
"idRetaguarda": "string",
"situacao": 0
}
],
"cstIcms": "string",
"descontoMaximo": "string",
"descricao": "string",
"encomenda": true,
"escalaRelevante": true,
"fcps": [
{
"codigoBeneficioFiscal": "string",
"descontaDesoneracaoNf": true,
"idProprietario": "string",
"motivoDesoneracaoIcms": 0,
"percentualFcp": "string",
"valorBaseFcp": "string"
}
],
"fracionado": true,
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"imagem": "string",
"impostos": [
{
"idProprietario": "string",
"idRetaguarda": "string"
}
],
"loteOrigem": "string",
"ncms": [
{
"idProprietario": "string",
"idRetaguarda": "string"
}
],
"origemProduto": 0,
"percentualReducaoIcms": "string",
"pesoBruto": 0,
"pesoLiquido": 0,
"pisCofins": [
{
"idProprietario": "string",
"idRetaguarda": "string"
}
],
"produtoEmbalagens": [
{
"codigoBarras": "string",
"descricao": "string",
"idProdutoRetaguarda": "string",
"idRetaguarda": "string",
"pesoBruto": 0,
"pesoLiquido": 0,
"quantidade": 0,
"situacao": 0,
"unidadeMedida": "string",
"quantidadeValorAtacado": 0
}
],
"produtoKits": [
{
"descricao": "string",
"idRetaguardaProduto": "string",
"idRetaguardaProdutoKit": "string",
"novoValorUnitario": "string",
"quantidadeVendaKit": 0,
"situacao": 0,
"tipoValorKit": 0,
"valorDesconto": "string"
}
],
"produtosSimilares": [
{
"idRetaguardaProduto": "string",
"idRetaguardaSimilar": "string",
"situacao": 0
}
],
"produtosSugestoes": [
{
"idRetaguardaProduto": "string",
"idRetaguardaSugestao": "string",
"situacao": 0
}
],
"quantidadeMovimentacao": 0,
"situacao": 0,
"tipoProduto": 0,
"unidadeMedida": "string",
"vlicmsret": "string",
"idProdutoPrincipal": 0,
"quantidadeValorAtacado": 0
}
]
Column |
---|
|
Definições dos campos do body
Campo | Tipo | Descrição | Obrigatório | Observações |
---|
descricao | string | Descrição do produto | Sim | - Tamanho máximo: 200
- Estes caracteres especiais: "\r","\n","\"",@"\" são removidos ao inserir no PDV, pois podem ocasionar erro na SEFAZ.
unidadeMedida | string | Unidade de medida do produto | Sim
| descontoMaximo | numérico | Desconto máximo aplicado ao produto | Não | tipoArredondaTrunca | int | Não | codigoProduto | string | Código do produto | Sim
| codigoAlternativo | string | Código alternativo do produto | Sim
| origemProduto | int | Origem do produto | Sim | 0 – 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%. |
situacao | int | Situação do produto | Sim | 0 - Inativo, 1 - Ativo |
imagem | string | URL com a imagem do produto | Não | Tamanho máximo: 200 caracteres |
tipoProduto | int | Tipo do produto | Não | Descrição | Valor |
---|
Não definido | 0 |
Consumo | 1 |
Revenda | 2 |
Kit | 3 |
Matéria | 4 |
Produto acabado | 5 |
Serviço | 6 |
fracionado | boolean | Indica se o produto é vendido fracionado | Não | cnpjFornecedor | string | CNPJ do fornecedor do produto | Não | Tamanho máximo: 20 caracteres |
escalaRelevante | boolean | Escala relevante | Não | cstIcms | string | DEFASADO | Não | Tamanho máximo: 4 caracteres |
percentualReducaoIcms | numérico | Percentual de redução ICMS | Não | aliquotaIcms | numérico | Aliquota ICMS | Não | Pode 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. |
vlicmsret | string | DEFASADO | Não | Tamanho máximo: 7 caracteres |
cest | string | Cest | Não | encomenda | boolean | Indica se o produto é uma encomenda | Não | pesoLiquido | numérico | Peso liquido do produto | Não | pesoBruto | numérico | Peso bruto do produto | Não | associacaoProdutosClassificacao | Lista de objetos | Lista de classificação do produto | Não | associacaoProdutosClassificacao.idRetaguarda | string | Identificador da classificação na retaguarda | Sim | Tamanho máximo: 100 caracteres |
associacaoProdutosClassificacao.idRetaguardaProduto | string | Identificador do produto na retaguarda | Sim | associacaoProdutosClassificacao.idRetaguardaClassificacaoProduto | string | Identificador da classificação na retaguarda | Sim | associacaoProdutosClassificacao.ordem | int | Ordem | Sim | associacaoProdutosClassificacao.situacao | int | Situação da classificação | Sim | produtoEmbalagens | lista de objetos | Lista de embalagens do produto | Não | produtoEmbalagens.codigoBarras | string | Código de barras da embalagem | Sim | Tamanho máximo: 20 caracteres |
produtoEmbalagens.descricao | string | Descrição da embalagem | Sim | - Tamanho máximo: 200 caracteres
- Estes caracteres especiais: "\r","\n","\"",@"\" são removidos ao inserir no PDV, pois podem ocasionar erro na SEFAZ.
|
produtoEmbalagens.idProdutoRetaguarda | string | Identificador do produto na retaguarda | Sim | Tamanho máximo: 100 caracteres |
produtoEmbalagens.idRetaguarda | string | Identificador da embalagem na retaguarda | Sim | Tamanho máximo: 100 caracteres |
produtoEmbalagens.pesoBruto | int | Peso bruto da embalagem | Não | produtoEmbalagens.pesoLiquido | int | Peso liquido da embalagem | Não | produtoEmbalagens.quantidade | int | Quantidade de produtos na embalagem | Não | produtoEmbalagens.situacao | int | Situação da embalagem | Sim | 0 - Inativo 1 - Ativo |
produtoEmbalagens.unidadeMedida | string | Unidade de medida da embalagem | Sim | produtoEmbalagens.quantidadeValorAtacado | Numérico | Valor da auantidade no atacado | Não | produtoKits | Lista de objetos | Lista de kits | Não | produtoKits.idRetaguarda | string | Registo ú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.idRetaguardaProduto | string | Identificador 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.idRetaguardaProdutoKit | string | Identificador do item do kit na tabela de produto | Não | - Referencia os itens da tabela de produto que compõe o kit.
|
produtoKits.descricao | string | Descrição do produto que compõe o KIT | Sim | Tamanho máximo: 100 caracteres |
produtoKits.quantidadeVendaKit | int | Quantidade daquele determinado item dentro do KIT. | Sim | produtoKits.tipoValorKit | int | Tipo valor kit | Sim | Tipo | Valor | Descrição |
---|
Não tem desconto | 0 | O valor da tabela vigente será considerado para o item |
Valor fixo | 1 | O valor do campo novoValorUnitario será o valor do item no KIT |
Percentual desconto | 2 | O 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 |
produtoKits.situacao | int | Situação do kit | Sim | 0 - Inativo 1 - Ativo |
produtoKits.valorDesconto | numérico | Valor percentual que será aplicado de desconto no item da composição do KIT | Não | produtoKits.novoValorUnitario | numérico | Valor real que será aplicado de desconto no item da composição do KIT, desconsiderando o valor da tabela de preço atual | Não | produtosSimilares | Lista de objetos | Lista de produtos similares | Não | produtosSimilares.idRetaguardaProduto | string | Identificador do produto na retaguarda | Sim | Tamanho máximo: 100 caracteres |
produtosSimilares.idRetaguardaSimilar | string | Identificador do produto similar na retaguarda | Sim | Tamanho máximo: 100 caracteres |
produtosSimilares.situacao | int | Situação do produto similar | Sim | 0 - Inativo 1 - Ativo |
produtosSugestoes | Lista de objetos | Lista de sugestôes | Não | produtosSugestoes.idRetaguardaProduto | string | Identificador do produto na retaguarda | Sim | produtosSugestoes.idRetaguardaSugestao | string | Identificador da sugestão na retaguarda | Sim | produtosSugestoes.situacao | int | Situação da sugestão | Sim | codigosProduto | Lista de objetos | Lista de códigos do produto | Não | codigosProduto.codigo | string | Código do produto | Não | codigosProduto.descricao | string | Descrição do código | Não | codigosProduto.idRetaguarda | string | Identificador do código na retaguarda | Não | codigosProduto.dataAtualizacao | string | Data atualização do código | Não | codigosProduto.dataCadastro | string | Data cadastro do código | Não | codigosProduto.situacao | int | Situação do produto | Não | impostos | Lista de objetos | Lista de impostos do produto | Sim | impostos.idRetaguarda | string | Identificador do imposto na retaguarda | Sim | impostos.idProprietario | string | Identificador do proprietário | Sim | ncms | Lista de objetos | Lista de NCMs | Sim | ncms.idRetaguarda | string | Identificador do NCM na retaguarda | Sim | ncms.idProprietario | string | Identificador do proprietário | Sim | pisCofins | Lista de objetos | Lista de PisCofins | Sim | pisCofins.idRetaguarda | string | Identificador do PisCofin na retaguarda | Sim | pisCofins.idProprietario | string | Identificador do proprietário | Sim | fcps | Lista de objetos | Lista de FCPs | Não | fcps.valorBaseFcp | string | DEFASADO | Não | fcps.percentualFcp | numérico | Percentual do FCP | Não | fcps.codigoBeneficioFiscal | string | Código de benefício fiscal | Não | Tamanho máximo: 20 caracteres |
fcps.motivoDesoneracaoIcms | int | Motivo desoneração | Não | fcps.descontaDesoneracaoNf | boolean | DEFASADO | Não | fcps.idProprietario | string | Identificador do proprietário | Não | quantidadeMovimentacao | numérico | Quanitdade de movimentação | Não | idInquilino | string | Identificador do inquilino | Sim | idRetaguarda | string | Identificador do produto na retaguarda | Sim
| idProprietario | string | Identificador do proprietário | Sim | loteOrigem | string | Identificador do lote que os dados serão enviados | Sim | idProdutoPrincipal | Inteiro | Identificação do Produto Principal | Não | quantidadeValorAtacado | Numérico | Valor da quantidade no atacado | Não | Retorno
Deck of Cards |
---|
|
Card |
---|
|
Column |
---|
|
Exemplo de body de retorno{ "success": true, "message": "Requisição inserida com sucesso!", "data": null, "errors": null, "totalTime": 0, "numberOfRecords": 0 } |
Column |
---|
|
Definições dos campos do retorno
Campo | Tipo | Descrição |
---|
Success | bool | Indica se a criação do compartilhamento foi feita com sucesso |
Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo |
Data | objeto | Objeto compartilhamento criado |
Errors | Lista | Listas com os erros encontrados no processo |
TotalTime | int | tempo da requisição |
NumberOfRecords | int | número de dados inseridos |
Card |
---|
|
Column |
---|
|
Exemplo de body de retorno{ "code": "string", "message": "string", "detailedMessage": "string", "helpUrl": "string", "details": [ { "guid": "string", "code": "string", "message": "string", "detailedMessage": "string" } ] } |
Column |
---|
|
Definições dos campos do retorno
Campo | Tipo | Descrição |
---|
code | string | Código de erro |
message | string | Mensagem do erro |
detailedMessage | string | Detalhamento do erro |
helpUrl | string | url de ajuda |
TotalTime | string | Tempo total de busca |
details | lista de objeto | Lista de objeto de erros |
details.guid | string | Identificador do erro |
details.code | string | Código do erro |
details.message | string | Mensagem do erro |
details.detailedMessage | string | Detalhamento do erro |
Card |
---|
|
Informações |
---|
Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição. |
Requisição
Section |
---|
Column |
---|
|
Exemplo de body da requisição[ { "descricao": "string", "unidadeMedida": "string", "descontoMaximo": "string", "arredondaTrunca": 0, "codigoProduto": "string", "codigoAlternativo": "string", "origemProduto": 0, "situacao": 0, "imagem": "string", "tipoProduto": 0, "fracionado": true, "cnpjFornecedor": "string", "escalaRelevante": true, "cstIcms": "string", "percentualReducaoIcms": "string", "aliquotaIcms": 0, "vlicmsret": "string", "cest": "string", "encomenda": true, "pesoLiquido": 0, "pesoBruto": 0, "associacaoProdutosClassificacao": [ { "idRetaguarda": "string", "idRetaguardaProduto": "string", "idRetaguardaClassificacaoProduto": "string", "ordem": 0, "situacao": 0 } ], "produtoEmbalagens": [ { "codigoBarras": "string", "descricao": "string", "idProdutoRetaguarda": "string", "idRetaguarda": "string", "pesoBruto": 0, "pesoLiquido": 0, "quantidade": 0, "situacao": 0, "unidadeMedida": "string", "quantidadeValorAtacado": 0 } ], "produtoKits": [ { "idRetaguardaProduto": "string", "idRetaguardaProdutoKit": "string", "descricao": "string", "quantidadeVendaKit": 0, "tipoValorKit": 0, "situacao": 0, "valorDesconto": "string", "novoValorUnitario": "string" } ], "produtosSimilares": [ { "idRetaguardaProduto": "string", "idRetaguardaSimilar": "string", "situacao": 0 } ], "produtosSugestoes": [ { "idRetaguardaProduto": "string", "idRetaguardaSugestao": "string", "situacao": 0 } ], "codigosProduto": [ { "codigo": "string", "descricao": "string", "idRetaguarda": "string", "dataAtualizacao": "2024-03-28T13:13:11.127Z", "dataCadastro": "2024-03-28T13:13:11.127Z", "situacao": 0 } ], "impostos": [ { "idRetaguarda": "string", "idProprietario": "string" } ], "ncms": [ { "idRetaguarda": "string", "idProprietario": "string" } ], "pisCofins": [ { "idRetaguarda": "string", "idProprietario": "string" } ], "fcps": [ { "valorBaseFcp": "string", "percentualFcp": "string", "codigoBeneficioFiscal": "string", "motivoDesoneracaoIcms": 0, "descontaDesoneracaoNf": true, "idProprietario": "string" } ], "quantidadeMovimentacao": 0, "idInquilino": "string", "idRetaguarda": "string", "idProprietario": "string", "loteOrigem": "string", "idProdutoPrincipal": 0, "quantidadeValorAtacado": 0 } ] |
Column |
---|
|
Definições dos campos do body
Campo | Tipo | Descrição | Obrigatório | Observações |
---|
descricao | string | Descrição do produto | Sim | - Tamanho máximo: 200
- Estes caracteres especiais: "\r","\n","\"",@"\" são removidos ao inserir no PDV, pois podem ocasionar erro na SEFAZ.
|
unidadeMedida | string | Unidade de medida do produto | Sim
| descontoMaximo | numérico | Desconto máximo aplicado ao produto | Não | tipoArredondaTrunca | int | DEFASADO | Não | codigoProduto | string | Código do produto | Sim
| codigoAlternativo | string | Código alternativo do produto | Sim
| origemProduto | int | Origem do produto | Sim | 0 – 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%. |
situacao | int | Situação do produto | Sim | 0 - Inativo, 1 - Ativo |
imagem | string | URL com a imagem do produto | Não | Tamanho máximo: 200 caracteres |
tipoProduto | int | Tipo do produto | Não | Descrição | Valor |
---|
Não definido | 0 |
Consumo | 1 |
Revenda | 2 |
Kit | 3 |
Matéria | 4 |
Produto acabado | 5 |
Serviço | 6 |
fracionado | boolean | Indica se o produto é vendido fracionado | Não | cnpjFornecedor | string | CNPJ do fornecedor do produto | Não | Tamanho máximo: 20 caracteres |
escalaRelevante | boolean | Escala relevante | Não | cstIcms | string | DEFASADO | Não | Tamanho máximo: 4 caracteres |
percentualReducaoIcms | numérico | Percentual de redução ICMS | Não | aliquotaIcms | numérico | Aliquota ICMS | Não | Pode 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. |
vlicmsret | numérico | DEFASADO | Não | cest | string | Cest | Não | Tamanho máximo: 7 caracteres |
encomenda | boolean | Indica se o produto é uma encomenda | Não | pesoLiquido | numérico | Peso liquido do produto | Não | pesoBruto | numérico | Peso bruto do produto | Não | associacaoProdutosClassificacao | Lista de objetos | Lista de classificação do produto | Não | associacaoProdutosClassificacao.idRetaguarda | string | Identificador da classificação na retaguarda | Sim | Tamanho máximo: 100 caracteres |
associacaoProdutosClassificacao.idRetaguardaProduto | string | Identificador do produto na retaguarda | Sim | Tamanho máximo: 100 caracteres |
associacaoProdutosClassificacao.idRetaguardaClassificacaoProduto | string | Identificador da classificação na retaguarda | Sim | Tamanho máximo: 100 caracteres |
associacaoProdutosClassificacao.ordem | int | Ordem | Sim | associacaoProdutosClassificacao.situacao | int | Situação da classificação | Sim | 0 - Inativo, 1 - Ativo |
produtoEmbalagens | lista de objetos | Lista de embalagens do produto | Não | produtoEmbalagens.Codigo | string | Identificação do produto raiz, que ao ser consultado irá apresentar quais itens são sugeridos ao compra-lo | Sim | Tamanho máximo: 200 caracteres |
produtoEmbalagens.codigoBarras | string | Código de barras da embalagem | Sim | Tamanho máximo: 20 caracteres |
produtoEmbalagens.codigoExterno | String | Identificação dos itens sugeridos para o item consultado | Não | Tamanho máximo: 200 caracteres |
produtoEmbalagens.descricao | string | Descrição da embalagem | Sim | - Tamanho máximo: 200 caracteres
- Estes caracteres especiais: "\r","\n","\"",@"\" são removidos ao inserir no PDV, pois podem ocasionar erro na SEFAZ.
|
produtoEmbalagens.idProdutoRetaguarda | string | Identificador do produto na retaguarda | Não | Tamanho máximo: 100 caracteres |
produtoEmbalagens.idRetaguarda | string | Identificador da embalagem na retaguarda | Sim | Tamanho máximo: 100 caracteres |
produtoEmbalagens.pesoBruto | int | Peso bruto da embalagem | Não | produtoEmbalagens.pesoLiquido | int | Peso liquido da embalagem | Não | produtoEmbalagens.quantidade | int | Quantidade de produtos na embalagem | Não | produtoEmbalagens.situacao | int | Situação da embalagem | Sim | 0 - Inativo 1 - Ativo |
produtoEmbalagens.unidadeMedida | string | Unidade de medida da embalagem | Sim | produtoEmbalagens.quantidadeValorAtacado | Numérico | Valor da quantidade no atacado | Não | produtoKits | Lista de objetos | Lista de kits | Não | produtoKits.idRetaguarda | string | Registo ú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.idRetaguardaProduto | string | Identificador do produto KIT criado na tabela de produto. | Não | - Tamanho máximo: 100 caracteres
- Todo kit é um produto, devido a isso sempre haverá um registro descrito como kit na tabela de produto.
|
produtoKits.idRetaguardaProdutoKit | string | Identificador do item do kit na tabela de produto | Não | - Tamanho máximo: 100 caracteres
- Referencia os itens da tabela de produto que compõe o kit.
|
produtoKits.descricao | string | Descrição do produto que compõe o KIT | Sim | Tamanho máximo: 100 caracteres |
produtoKits.quantidadeVendaKit | int | Quantidade daquele determinado item dentro do KIT. | Sim | produtoKits.tipoValorKit | int | Tipo valor kit | Sim | Tipo | Valor | Descrição |
---|
Não tem desconto | 0 | O valor da tabela vigente será considerado para o item |
Valor fixo | 1 | O valor do campo novoValorUnitario será o valor do item no KIT |
Percentual desconto | 2 | O 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 |
produtoKits.situacao | int | Situação do kit | Sim | 0 - Inativo 1 - Ativo |
produtoKits.valorDesconto | numérico | Valor percentual que será aplicado de desconto no item da composição do KIT | Não | produtoKits.novoValorUnitario | numérico | Valor real que será aplicado de desconto no item da composição do KIT, desconsiderando o valor da tabela de preço atual | Não | produtosSimilares | Lista de objetos | Lista de produtos similares | Não | produtosSimilares.idRetaguardaProduto | string | Identificador do produto na retaguarda | Sim | Tamanho máximo: 100 caracteres |
produtosSimilares.idRetaguardaSimilar | string | Identificador do produto similar na retaguarda | Sim | Tamanho máximo: 100 caracteres |
produtosSimilares.situacao | int | Situação do produto similar | Sim | 0 - Inativo 1 - Ativo |
produtosSugestoes | Lista de objetos | Lista de sugestôes | Não | produtosSugestoes.idRetaguardaProduto | string | Identificador do produto na retaguarda | Sim | produtosSugestoes.idRetaguardaSugestao | string | Identificador da sugestão na retaguarda | Sim | produtosSugestoes.situacao | int | Situação da sugestão | Sim | codigosProduto | Lista de objetos | Lista de códigos do produto | Não | codigosProduto.codigo | string | Código do produto | Sim | Tamanho máximo: 200 caracteres |
codigosProduto.codigoExterno | string | Identificação dos itens sugeridos para o item consultas | Não | Tamanho máximo: 200 caracteres |
codigosProduto.descricao | string | Descrição do código | Não | Tamanho máximo: 200 caracteres |
codigosProduto.idRetaguarda | string | Identificador do código na retaguarda | Não | Tamanho máximo: 100 caracteres |
codigosProduto.situacao | int | Situação do código | Sim | 0 - Inativo, 1 - Ativo |
impostos | Lista de objetos | Lista de impostos do produto | Sim | impostos.idRetaguarda | string | Identificador do imposto na retaguarda | Sim | impostos.idProprietario | string | Identificador do proprietário | Sim | ncms | Lista de objetos | Lista de NCMs | Sim | ncms.idRetaguarda | string | Identificador do NCM na retaguarda | Sim | ncms.idProprietario | string | Identificador do proprietário | Sim | pisCofins | Lista de objetos | Lista de PisCofins | Sim | pisCofins.idRetaguarda | string | Identificador do PisCofin na retaguarda | Sim | pisCofins.idProprietario | string | Identificador do proprietário | Sim | fcps | Lista de objetos | Lista de FCPs | Não | fcps.valorBaseFcp | string | DEFASADO | Não | fcps.percentualFcp | numérico | Percentual do FCP | Não | fcps.codigoBeneficioFiscal | string | Código de benefício fiscal | Não | Tamanho máximo: 20 caracteres |
fcps.motivoDesoneracaoIcms | int | Motivo desoneração | Não | fcps.descontaDesoneracaoNf | boolean | DEFASADO | Não | fcps.idProprietario | string | Identificador do proprietário | Não | quantidadeMovimentacao | numérico | Quanitdade de movimentação | Não | idInquilino | string | Identificador do inquilino | Sim | idRetaguarda | string | Identificador do produto na retaguarda | Sim
| idProprietario | string | Identificador do proprietário | Sim | loteOrigem | string | Identificador do lote que os dados serão enviados | Sim | idProdutoPrincipal | Inteiro | Identificação do Produto Principal | Não | quantidadeValorAtacado | Numérico | Valor da quantidade no atacado | Não | Retornos
Deck of Cards |
---|
|
Card |
---|
|
Column |
---|
|
Exemplo de body de retorno{ "success": true, "message": "Requisição inserida com sucesso!", "data": null, "errors": null, "totalTime": 0, "numberOfRecords": 0 } |
Column |
---|
|
Definições dos campos do retorno
Campo | Tipo | Descrição |
---|
Success | bool | Indica se a criação do compartilhamento foi feita com sucesso |
Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo |
Data | objeto | Objeto compartilhamento criado |
Errors | Lista | Listas com os erros encontrados no processo |
TotalTime | int | tempo da requisição |
NumberOfRecords | int | número de dados inseridos |
Card |
---|
|
Column |
---|
|
Exemplo de body de retorno{ "code": "string", "message": "string", "detailedMessage": "string", "helpUrl": "string", "details": [ { "guid": "string", "code": "string", "message": "string", "detailedMessage": "string" } ] } |
Column |
---|
|
Definições dos campos do retorno
Campo | Tipo | Descrição |
---|
code | string | Código de erro |
message | string | Mensagem do erro |
detailedMessage | string | Detalhamento do erro |
helpUrl | string | url de ajuda |
TotalTime | string | Tempo total de busca |
details | lista de objeto | Lista de objeto de erros |
details.guid | string | Identificador do erro |
details.code | string | Código do erro |
details.message | string | Mensagem do erro |
details.detailedMessage | string | Detalhamento do erro