Árvore de páginas

Versões comparadas

Chave

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

...

Aviso

Para que a baixa do Produto criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo  12 = Produto

titleexpandtitleDefinição de requisição
Deck of Cards
idversções
Card
labelV3.1 (V2)

Requisição

Section
Column
width50%
Expandir

Exemplo de body da requisição

[
    {
        "

descricao

aliquotaIcms":

"string"

0,
        "

unidadeMedida

arredondaTrunca":

"string"

0,
        "

descontoMaximo

associacaoProdutosClassificacao":

"string",

[
       

"arredondaTrunca": 0,

    {
                "

codigoProduto

idRetaguarda": "string",
                "

codigoAlternativo

idRetaguardaClassificacaoProduto": "string",
                "

origemProduto

idRetaguardaProduto":

0,
        "situacao": 0

"string",
       

"imagem": "string",

        "

tipoProduto

ordem": 0,
       

"fracionado": true,

        "

cnpjFornecedor

situacao":

"string",

0
       

"escalaRelevante": true,

    }
       

"cstIcms": "string"

],
        "

percentualReducaoIcms

cest": "string",
        "

aliquotaIcms

cnpjFornecedor": "string",
        "

vlicmsret

codigoAlternativo": "string",
        "

cest

codigoProduto": "string",
        "

encomenda

codigosProduto":

true,

[
           

"pesoLiquido": 0,

{
       

"pesoBruto": 0,

        "

associacaoProdutosClassificacao

codigo":

[
            {

"string",
                "

idRetaguarda

dataAtualizacao": "

string

2024-03-28T13:13:11.127Z",
                "

idRetaguardaProduto

dataCadastro": "

string

2024-03-28T13:13:11.127Z",
                "

idRetaguardaClassificacaoProduto

descricao": "string",
                "

ordem

idRetaguarda":

0

"string",
                "situacao": 0
            }
        ],
        "

produtoEmbalagens

cstIcms":

[

"string",
       

    {

"descontoMaximo": "string",
       

       

"

codigoBarras

descricao": "string",
        "encomenda": true,
        "

descricao

escalaRelevante":

"string"

true,
        "fcps": [
       

"idProdutoRetaguarda": "string",

    {
                "

idRetaguarda

codigoBeneficioFiscal": "string",
                "

pesoBruto

descontaDesoneracaoNf":

0

true,
                "

pesoLiquido

idProprietario":

0

"string",
                "

quantidade

motivoDesoneracaoIcms": 0,
                "

situacao

percentualFcp":

0

"string",
                "

unidadeMedida

valorBaseFcp": "string"
            }
        ],
        "

produtoKits

fracionado":

[
            {

true,
       

       

"

idRetaguardaProduto

idInquilino": "string",

   

       

   

"

idRetaguardaProdutoKit

idProprietario": "string",

       

        "

descricao

idRetaguarda": "string",
       

       

"

quantidadeVendaKit

imagem":

0

"string",
       

       

"

tipoValorKit

impostos":

0,

[
           

    "situacao": 0,

{
                "

valorDesconto

idProprietario": "string",
                "

novoValorUnitario

idRetaguarda": "string"
            }
        ],
        "

produtosSimilares

loteOrigem":

[

"string",
       

 

"ncms": [
            {
                "

idRetaguardaProduto

idProprietario": "string",
                "

idRetaguardaSimilar

idRetaguarda": "string"

,


            }
        ],
        "

situacao

origemProduto": 0,
       

    }

"percentualReducaoIcms": "string",
        "pesoBruto": 0,
       

]

"pesoLiquido": 0,
        "

produtosSugestoes

pisCofins": [
            {
                "

idRetaguardaProduto

idProprietario": "string",
                "

idRetaguardaSugestao

idRetaguarda": "string"

,


            }
   

"situacao": 0

    ],
       

}
        ],
        "codigosProduto"

"produtoEmbalagens": [
            {
                "

codigo

codigoBarras": "string",
                "descricao": "string",
                "

idRetaguarda

idProdutoRetaguarda": "string",
                "

dataAtualizacao

idRetaguarda": "

2024-03-28T13:13:11.127Z

string",
                "

dataCadastro

pesoBruto":

"2024-03-28T13:13:11.127Z"

0,
                "

situacao

pesoLiquido": 0,
           

}

    "quantidade": 0,
       

],

        "

impostos

situacao":

[

0,
           

{
                "idRetaguarda": "string",
                "idProprietario

    "unidadeMedida": "string"
            }
        ],
        "

ncms

produtoKits": [
            {
                "

idRetaguarda

descricao": "string",
                "

idProprietario

idRetaguardaProduto": "string",
           

}

    "idRetaguardaProdutoKit": "string",
       

],

        "

pisCofins

novoValorUnitario":

[

"string",
           

{

    "quantidadeVendaKit": 0,
                "

idRetaguarda

situacao":

"string"

0,
                "

idProprietario

tipoValorKit": 0,
                "valorDesconto": "string"
            }
        ],
        "

fcps

produtosSimilares": [
            {
                "

valorBaseFcp

idRetaguardaProduto": "string",
                "

percentualFcp

idRetaguardaSimilar": "string",
                "

codigoBeneficioFiscal

situacao":

"string",

0
            }
        ],
        "

motivoDesoneracaoIcms

produtosSugestoes":

0,

[
            {
                "

descontaDesoneracaoNf

idRetaguardaProduto":

true

"string",
                "

idProprietario

idRetaguardaSugestao": "string",
           

}

    "situacao": 0
            }
        ],
        "quantidadeMovimentacao": 0,
        "

idInquilino

situacao":

"string"

0,
        "

idRetaguarda

tipoProduto":

"string"

0,
        "

idProprietario

unidadeMedida": "string",
        "

loteOrigem

vlicmsret": "string"
    }
]


Column
width
50%

Definições dos campos

do body

Campo

Tipo

Descrição

Obrigatório

Observações

descricao

string

Descrição do produto

Obrigatório;

Sim


  • Tamanho máximo: 200
unidadeMedidastringUnidade de medida do produto

Obrigatório;

Tamanho máximo: 20

descontoMaximostring
  • Estes caracteres especiais: "\r","\n","\"",@"\" são removidos ao inserir no PDV, pois podem ocasionar erro na SEFAZ.


unidadeMedidastringUnidade de medida do produto

Sim


  • Tamanho máximo: 20
descontoMaximonuméricoDesconto máximo aplicado ao produto
Opcional
Não
arredondaTrunca

tipoArredondaTruncaint
Opcional

Não
codigoProdutostringCódigo do produto
Obrigatório;

Sim


  • Tamanho máximo:
600
  • 20
codigoAlternativostringCódigo alternativo do produto
Obrigatório;

Sim


  • Tamanho máximo: 40
origemProdutointOrigem do produto
ObrigatóriosituacaointSituação do produto (0 - Inativo, 1 - Ativo)

Obrigatório

imagemstringURL com a imagem do produtoOpcionaltipoProdutointTipo do produtoObrigatóriofracionadobooleanIndica se o produto é vendido fracionadoOpcionalcnpjFornecedorstringCNPJ do fornecedor do produtoOpcionalescalaRelevantebooleanEscala relevanteOpcionalcstIcmsstringCST ICMS do produtoOpcionalpercentualReducaoIcmsstringPercentual de redução ICMSOpcionalaliquotaIcmsstringAliquota ICMSOpcionalvlicmsretstringvlicmsretOpcionalceststringCestOpcionalencomendabooleanIndica se o produto é uma encomendaOpcionalpesoLiquidofloatPeso liquido do produtoOpcionalpesoBrutofloatPeso bruto do produtoOpcionalassociacaoProdutosClassificacaoLista de objetosLista de classificação do produtoOpcionalassociacaoProdutosClassificacao.idRetaguardastringIdentificador da classificação na retaguardaOpcionalassociacaoProdutosClassificacao.idRetaguardaProdutostringIdentificador do produto na retaguardaOpcionalassociacaoProdutosClassificacao.idRetaguardaClassificacaoProdutostringIdentificador da classificação na retaguardaOpcionalassociacaoProdutosClassificacao.ordemOpcionalintOrdem opcionalOpcionalassociacaoProdutosClassificacao.situacaointSituação da classificaçãoOpcionalprodutoEmbalagenslista de objetos

Lista de embalagens do produto

OpcionalprodutoEmbalagens.codigoBarrasstringCódigo de barras da embalagemOpcionalprodutoEmbalagens.descricaostringDescrição da embalagemOpcionalprodutoEmbalagens.idProdutoRetaguardastringIdentificador do produto na retaguardaOpcionalprodutoEmbalagens.idRetaguardastringIdentificador da embalagem na retaguardaOpcionalprodutoEmbalagens.pesoBrutofloatPeso bruto da embalagemOpcionalprodutoEmbalagens.pesoLiquidofloatPeso liquido da embalagemOpcionalprodutoEmbalagens.quantidadeintQuantidade de produtos na embalagemOpcionalprodutoEmbalagens.situacaointSituação da embalagemOpcionalprodutoEmbalagens.unidadeMedidastringUnidade de medida da embalagemOpcionalprodutoKitsLista de objetosLista de kitsOpcionalprodutoKits.idRetaguardaProdutostringIdentificador do produto na retaguardaOpcionalprodutoKits.idRetaguardaProdutoKitstringIdentificador do kit na retaguardaOpcionalprodutoKits.descricaostringDescrição do kitOpcionalprodutoKits.quantidadeVendaKitint

Quantidade de venda do kit 

OpcionalprodutoKits.tipoValorKitintTipo valor kitOpcional
Sim0 – 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

0 - Inativo, 1 - Ativo

imagemstringURL com a imagem do produtoNãoTamanho máximo: 200 caracteres
tipoProdutointTipo do produtoNão

Descrição

Valor

Não definido0
Consumo1
Revenda2
Kit3
Matéria4
Produto acabado5
Serviço6
fracionadobooleanIndica se o produto é vendido fracionadoNão
cnpjFornecedorstringCNPJ do fornecedor do produtoNãoTamanho máximo: 20 caracteres
escalaRelevantebooleanEscala relevanteNão
cstIcmsstringDEFASADONãoTamanho máximo: 4 caracteres
percentualReducaoIcmsnuméricoPercentual de redução ICMSNão
aliquotaIcmsnumé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.
vlicmsretstringDEFASADONãoTamanho máximo: 7 caracteres
ceststringCestNão
encomendabooleanIndica se o produto é uma encomendaNão
pesoLiquidonuméricoPeso liquido do produtoNão
pesoBrutonumé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.ordemintOrdemSim
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 embalagemSim
  • Tamanho máximo: 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.pesoBrutointPeso bruto da embalagemNão
produtoEmbalagens.pesoLiquidointPeso 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 produto que compõe o KITSimTamanho máximo: 100 caracteres
produtoKits.quantidadeVendaKitint

Quantidade daquele determinado item dentro do KIT.

Sim
produtoKits.tipoValorKitintTipo valor kitSim

Tipo

Valor

Descriçã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
produtoKits.situacaointSituação do kitSim0 - Inativo 1 - Ativo
produtoKits.valorDescontonuméricoValor percentual que será aplicado de desconto no item da composição do KITNão
produtoKits.novoValorUnitarionuméricoValor real que será aplicado de desconto no item da composição do KIT, desconsiderando o valor da tabela de preço atualNão
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 retaguardaSim
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ão
fcps.percentualFcpnuméricoPercentual do FCPNão
fcps.codigoBeneficioFiscalstringCódigo de benefício fiscalNãoTamanho máximo: 20 caracteres
fcps.motivoDesoneracaoIcmsintMotivo desoneraçãoNão
fcps.descontaDesoneracaoNfbooleanDEFASADONão
fcps.idProprietariostringIdentificador do proprietárioNão
quantidadeMovimentacaonuméricoQuanitdade de movimentaçãoNão
idInquilinostringIdentificador do inquilinoSim
idRetaguardastringIdentificador do produto na retaguarda

Sim


  • Tamanho máximo: 100
idProprietariostringIdentificador do proprietárioSim
loteOrigemstringIdentificador do lote que os dados serão enviadosSim

Retorno

Deck of Cards
idretornos
Card
label200 - Ok
Column
width50%

Exemplo de body de retorno

{
    "success": true,
    "message": "Requisição inserida com sucesso!",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Column
width50%

Definições dos campos do retorno

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
Card
label400 - Bad Request
Column
width50%

Exemplo de body de retorno

{
    "code": "string",
    "message": "string",
    "detailedMessage": "string",
    "helpUrl": "string",
    "details": [
        {
            "guid": "string",
            "code": "string",
            "message": "string",
            "detailedMessage": "string"
        }
    ]
}

Column
width50%

Definições dos campos do retorno

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
Card
labelV3.2
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
width50%

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"
            }
        ],
        "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"
    }
]

Column
width50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observações

descricaostringDescriçã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.
unidadeMedidastringUnidade de medida do produto

Sim


  • Tamanho máximo: 20
descontoMaximonuméricoDesconto máximo aplicado ao produtoNão
tipoArredondaTruncaintDEFASADONão
codigoProdutostringCódigo do produto

Sim


  • Tamanho máximo: 20
codigoAlternativostringCódigo alternativo do produto

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

0 - Inativo, 1 - Ativo

imagemstringURL com a imagem do produtoNãoTamanho máximo: 200 caracteres
tipoProdutointTipo do produtoNão
DescriçãoValor
Não definido0
Consumo1
Revenda2
Kit3
Matéria4
Produto acabado5
Serviço6
fracionadobooleanIndica se o produto é vendido fracionadoNão
cnpjFornecedorstringCNPJ do fornecedor do produtoNãoTamanho máximo: 20 caracteres
escalaRelevantebooleanEscala relevanteNão
cstIcmsstringDEFASADONãoTamanho máximo: 4 caracteres
percentualReducaoIcmsnuméricoPercentual de redução ICMSNão
aliquotaIcmsnumé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.
vlicmsretnuméricoDEFASADONão
ceststringCestNãoTamanho máximo: 7 caracteres
encomendabooleanIndica se o produto é uma encomendaNão
pesoLiquidonuméricoPeso liquido do produtoNão
pesoBrutonumé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 retaguardaSimTamanho máximo: 100 caracteres
associacaoProdutosClassificacao.idRetaguardaClassificacaoProdutostringIdentificador da classificação na retaguardaSimTamanho máximo: 100 caracteres
associacaoProdutosClassificacao.ordemintOrdemSim
associacaoProdutosClassificacao.situacaointSituação da classificaçãoSim0 - Inativo, 1 - Ativo
produtoEmbalagenslista de objetos

Lista de embalagens do produto

Não
produtoEmbalagens.Codigostring

Identificação do produto raiz, que ao ser consultado irá apresentar quais itens são sugeridos ao compra-lo

SimTamanho máximo: 200 caracteres
produtoEmbalagens.codigoBarrasstringCódigo de barras da embalagemSimTamanho máximo: 20 caracteres
produtoEmbalagens.codigoExternoStringIdentificação dos itens sugeridos para o item consultadoNãoTamanho máximo: 200 caracteres
produtoEmbalagens.descricaostringDescrição da embalagemSim
  • Tamanho máximo: 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 retaguardaNãoTamanho máximo: 100 caracteres
produtoEmbalagens.idRetaguardastringIdentificador da embalagem na retaguardaSimTamanho máximo: 100 caracteres
produtoEmbalagens.pesoBrutointPeso bruto da embalagemNão
produtoEmbalagens.pesoLiquidointPeso 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
  • Tamanho máximo: 100 caracteres
  • 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
  • Tamanho máximo: 100 caracteres
  • Referencia os itens da tabela de produto que compõe o kit.
produtoKits.descricaostringDescrição do produto que compõe o KITSimTamanho máximo: 100 caracteres
produtoKits.quantidadeVendaKitint

Quantidade 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
produtoKits.situacaointSituação do kit
Opcional
Sim0 - Inativo 1 - Ativo
produtoKits.valorDesconto
string
numéricoValor percentual que será aplicado de desconto
no item da composição do KITNão
Opcional

produtoKits.novoValorUnitario
stringNovo valor unitário
numéricoValor real que será aplicado de desconto no item da composição do KIT, desconsiderando o valor da tabela de preço atualNão
Opcional

produtosSimilaresLista de objetosLista de produtos similares
Opcional
Não
produtosSimilares.idRetaguardaProdutostringIdentificador do produto na retaguarda
Opcional
SimTamanho máximo: 100 caracteres
produtosSimilares.idRetaguardaSimilarstringIdentificador do produto similar na retaguarda
Opcional
SimTamanho máximo: 100 caracteres
produtosSimilares.situacaointSituação do produto similar
Sim0 - Inativo 1 - Ativo
Opcional
produtosSugestoesLista de objetosLista de sugestôes
Opcional
Não
produtosSugestoes.idRetaguardaProdutostringIdentificador do produto na retaguarda
Opcional
Sim
produtosSugestoes.idRetaguardaSugestaostringIdentificador da sugestão na retaguarda
Opcional
Sim
produtosSugestoes.situacaointSituação da sugestão
Opcional
Sim
codigosProdutoLista de objetosLista de códigos do produto
Opcional
Não
codigosProduto.codigostringCódigo do produto
Opcional
SimTamanho máximo: 200 caracteres
codigosProduto.
descricao
codigoExternostring
Descrição do código
Identificação dos itens sugeridos para o item consultasNãoTamanho máximo: 200 caracteres
Opcional
codigosProduto.
idRetaguarda
descricaostring
Identificador
Descrição do código
na retaguarda
OpcionalcodigosProduto.dataAtualizacaostringData atualização do código
NãoTamanho máximo: 200 caracteres
Opcional
codigosProduto.
dataCadastro
idRetaguardastring
Data cadastro
Identificador do código
na retaguardaNãoTamanho máximo: 100 caracteres
Opcional
codigosProduto.situacaointSituação do
produto
códigoSim0 - Inativo, 1 - Ativo
Opcional
impostosLista de objetosLista de impostos do produto
Obrigatório
Sim
impostos.idRetaguardastringIdentificador do imposto na retaguarda
Opcional
Sim
impostos.idProprietariostringIdentificador do proprietário
Opcional
Sim
ncmsLista de objetosLista de NCMs
Opcional
Sim
ncms.idRetaguardastringIdentificador do NCM na retaguarda
Opcional
Sim
ncms.idProprietariostringIdentificador do proprietário
Opcional
Sim
pisCofinsLista de objetosLista de PisCofins
Opcional
Sim
pisCofins.idRetaguardastringIdentificador do PisCofin na retaguarda
Opcional
Sim
pisCofins.idProprietariostringIdentificador do proprietário
Opcional
Sim
fcpsLista de objetosLista de FCPs
Opcional
Não
fcps.valorBaseFcpstring
Valor base do FCP
DEFASADONão
Opcional

fcps.percentualFcp
string
numéricoPercentual do FCP
Opcional
Não
fcps.codigoBeneficioFiscalstringCódigo de benefício fiscal
NãoTamanho máximo: 20 caracteres
Opcional
fcps.motivoDesoneracaoIcmsintMotivo desoneração
Opcional
Não
fcps.descontaDesoneracaoNfboolean
Desconto desoneraçao
DEFASADO
Opcional
Não
fcps.idProprietariostringIdentificador do proprietário
Opcional
Não
quantidadeMovimentacao
float
numéricoQuanitdade de movimentação
Opcional
Expandir
title200 - Ok
Não
idInquilinostringIdentificador do inquilinoSim
idRetaguardastringIdentificador do
inquilinoObrigatórioidRetaguardastringIdentificador do produto na retaguarda

Obrigatório;

Tamanho máximo: 100

idProprietariostringIdentificador do proprietárioObrigatórioloteOrigemstringIdentificador do lote que os dados serão enviadosOpcional Expandir
titleDefinição dos campos de retorno
produto na retaguarda

Sim


  • Tamanho máximo: 100
idProprietariostringIdentificador do proprietárioSim
loteOrigemstringIdentificador do lote que os dados serão enviadosSim

Retornos

Deck of Cards
idretornos
Card
label200 - Ok
Column
width50%

Exemplo de body de retorno

{
    "success": true,
    "message": "Requisição inserida com sucesso!",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Column
width50%

Definições dos campos do retorno

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
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos
Card
label400 - Bad Request
Column
width50%

Exemplo de body de retorno

{
    "code": "string",
    "message": "string",
    "detailedMessage": "string",
    "helpUrl": "string",
    "details": [
        {
            "guid": "string",
            "code": "string",
            "message": "string",
            "detailedMessage": "string"
        }
    ]
}

Column
width50%

Definições dos campos do retorno

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