Árvore de páginas

O cadastro de produtos desempenha um papel crucial na execução das operações de venda, sendo essencial para o funcionamento eficiente do TOTVS PDV Omni. Além de ser fundamental para as operações de venda, o cadastro também é utilizado na consulta de produtos, oferecendo aos usuários a capacidade de verificar detalhes do produto, posição do estoque e até mesmo sugestões e itens similares.

O produto poderá ter as seguintes informações:


    Informação Coluna Obrigatório Tipo Tamanho Descrição
    Descrição

    descricao

    Sim

    Texto

    200

    Cada produto requer uma descrição, que será utilizada nas operações de consultas, no carrinho de venda e documentos fiscais. 

    Imposto

    id_imposto

    Não

    Inteiro


    Para que a operação de venda seja realizada todo produto deverá estar associado a um imposto, onde irá determinar a alíquota ICMS que o PDV Omni deverá utilizar na emissão de XML.

    Consulte mais detalhes em Imposto

    Código NCM

    id_ncm

    Não

    Inteiro


    Para que a operação de venda seja realizada todo produto deverá estar associado a um NCM, onde irá determinar a alíquota nacional, importada, estadual e municipal e também o código CEST que o PDV Omni deverá utilizar na emissão de XML.

    Consulte mais detalhes em NCM

    Unidade de medida

    unidade_medida

    Sim

    Texto

    20

    Para que a operação de venda seja realizada todo produto deverá possuir a identificação da unidade de medida do produto. Como os listados abaixo entre outros:

    • UN (Unidade)
    • PC (Pacote)
    • KG (Kilo)

    No campo, normalmente é utilizada a abreviação da medida, por exemplo "UN", "PC".

    Desconto máximo

    desconto_maximo

    Não

    Numérico


    Configuração do desconto máximo que aquele item poderá receber.

    Esse desconto pode ser ultrapassado caso seja realizada a identificação de um supervisor autorizando o desconto acima do configurado.

    Arredonda ou trunca

    tipo_arredonda_trunca

    Sim

    Texto

    1

    Informação obsoleta, sendo:

    0 - Arredonda

    1- Trunca

    Código

    codigo_produto

    Sim

    Texto

    20

    O produto deve ter pelo menos um código alfanumérico, embora seja possível associá-lo a múltiplos códigos, se necessário. 

    Código alternativo

    codigo_alternativo

    Sim

    Texto

    40


    Origem do produto

    origem_produto

    Sim

    Texto

    20


    Pis/Cofins

    id_pis_cofins

    Não

    Inteiro


    Para que a operação de venda seja realizada todo produto deverá estar associado a um PIS e COFINS, onde irá determinar o CST e alíquota PIS e CST e alíquota COFINS que o PDV Omni deverá utilizar na emissão de XML.

    Consulte mais detalhes em PIS/COFINS

    Situação

    situacao

    Sim

    Inteiro


    Define se o produto em questão está ativo ou inativo.

    • 0 - Inativo
    • 1 - Ativo
    Data de cadastro

    data_cadastro

    Sim

    Data


    Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.

    Data de atualização

    data_atualizacao

    Sim

    Data


    Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.

    Identificação no retaguarda

    id_retaguarda

    Não

    Texto

    100


    Imagem

    imagem

    Não

    Imagem

    200

    ***Caminho da imagem do produto para apresentação em tela

    Identificação do seu tipo 

    tipo_produto

    Não

    Inteiro


    Identificação do tipo de produto informado, para que o PDV saiba qual comportamento deve ter conforme o tipo de produto. Por exemplo, se o item é produto do tipo serviço, a tela do PDV para uma venda serviço possui uma diferença quando comparada a tela de item de revenda.

    • 0 - Não definido
    • 1 - Consumo
    • 2 - Revenda
    • 3 - KIT
    • 4 - Matéria prima
    • 5 - Produto acabado
    • 6 - Serviço
    Identificação de o produto é fracionado

    fracionado

    Não

    Inteiro


    Para que o PDV libera a pesagem do item e também aumente a quantidade de casa decimais na quantidade do produto, o mesmo deve estar cadastrado como fracionado.

    • 0 - False
    • 1 - True
    CNPJ do fornecedor

    cnpj_fornecedor

    Não

    Texto

    20

    Para emissão da XML da venda, caso a coluna escala_relevante esteja definida com o valor "True", a SEFAZ exisge que seja informado também na XML o CNPJ do fabricante do produto. Para o preenchimento dessa TAG n XML, é utilizado o dado do CNPJ do fornecedor.

    Produzido em escala relevante

    escala_relevante

    Não

    Boleano


    Para emissão da XML da venda, é necessário que no cadastro do item seja informado se trata-se de um item fabricado em escala relevante ou não.

    • False - Produto sujeito a substituição tributária.
    • True - Produto não sujeito a substituição tributária (conforme Convênio ICMS 51/2017)
    Valor base do fundo de combate a probreza (FCP)

    valor_base_fcp

    Não

    Numérico


    Defasado

    Código de benefício fiscal (CBNEF)

    codigo_beneficio_fiscal

    Não

    Texto

    20

    Para emissão da XML da venda, quando o item possui um benefício fiscal, seja ele com relação a carga tributária ou isenção de imposto, é necessário informar o código desse benefício. Os estados de DF, GO, PR, RS, RJ e SC obrigam o preenchimento dessa TAG, ou seja, para esses estados é obrigatório o cadastro do código. Para a geração dessa TAG na XML é utilizado o valor integrado no campo codigo_beneficio_fiscal. 

    Percentual do fundo de combate a pobreza (FCP)

    percentual_fcp

    Não

    Numérico


    Para emissão da XML da venda, caso o produto comercializado estiver determinado na legislação do estado para recolhimento do FCP a TAG com o valor a ser recolhido deve ser preenchida. O valor é calculado com base ao percentual, também definido pelo estado, de recolhimento. Para o calculo do valor e preenchimento da TAG vFCP é necessário informar o percentual definido pelo estado no campo percentual_fcp. 

    CST do ICMS

    cst_icms

    Não

    Texto

    4

    Defasado

    Percentual de redução de ICMS

    percentual_reducao_icms

    Não

    Numérico


    Para emissão da XML da venda, quando o item possui esse campo e o campo aliquota_icms preenchidos, esses campos são utilizados para o preenchimento das TAGs com relação ao ICMS efetivo. Esse campo realizar o preenchimento da TAG pRedBCEfet.

    Alíquota ICMS

    aliquota_icms

    Não

    Numérico


    Para emissão da XML da venda, quando o item possui esse campo e o campo percentual_reducao_icms preenchidos, esses campos são utilizados para o preenchimento das TAGs com relação ao ICMS efetivo. Esse campo é utilizado para o cálculo do pICMSEfet e vICMSEfet

    Valor de ICMS retido

    vlicmsret

    Não

    Numérico


    Defasado

    Motivo da desoneração de ICMS

    motivo_desoneracao_icms

    Não

    Inteiro


    Para emissão da XML da venda, o preenchimento desse campo com valor diferente de 0 "habilita" o cálculo de desoneração na nota. Esse campo é utilizado para o preenchimento da TAG motDesICMS. A TAG vICMSDeson é preenchida após o cálculo. Para CSTs 30, 40, 41 e 50 são utilizados os campos aliquota_icms e percentual_fcp para cálculo, já para os CSTs 20, 70 e 90 é utilizado o percentual_fcp e a alíquota da tabela Imposto.

    Desconta desoneração na NF

    desconta_desoneracao_nf

    Não

    Boleano


    Defasado

    CEST

    cest

    Não

    Texto

    7

    Para emissão da XML da venda, produtos com substituição tributária devem conter a informação do CEST. Essa informação possui dois locais para o cadastro, diretamente no produto e no NCM. Caso o produto não tenha essa informação, será usado o valor presente na tabela no NCM, mas caso exista o valor cest na tabela produto, era será a presente na XML

    Valor de pauta ICMS

    valor_pauta_icms

    Não

    Numérico


    Defasado

    MD5 PAF

    md5_paf

    Não

    Texto

    64

    Campo utilizado para armazenar o MD5 calculado de acordo com a informação do produto quando utilizado o modelo fiscal NFCe com PAF ativo

    Encomenda

    encomenda

    Não

    Boleano


    Controle se o item pode ou não ser encomendado pela loja

    Quantidade em movimentação

    quantidade_movimentacao

    Não

    Numérico


    Quantidade de movimentação é a configuração de valor mínimo de compra.

    Por exemplo, pode ser configurado para que determinado item seja vendido somente de 5 em 5. Ou seja, se o cliente tentar informar somente um item, o PDV irá informar que a quantidade mínima de movimentação é 5 ou múltiplo de 5

    Peso bruto do produto

    peso_bruto

    Não

    Numérico


    Peso bruto do produto

    Peso líquido do produto

    peso_liquido

    Não

    Numérico


    Peso líquido do produto

    Controle de lote

    controla_lote

    Não

    Boleano


    Controle de lote é a configuração para controlar lote por produto nas vendas de pisos e cerâmicas.

    Identificação do Produto Principal

    Id_produto_principal

    Não

    Inteiro


    Produto principal é a configuração para indicar um produto principal de um produto.

    Exemplo: Na venda do produto (id_produto) que tenha um produto principal cadastrado, será utilizado o mesmo preço promocional do produto principal.

    Quantidade do Valor no Atacado

    quantidade_valor_atacado

    Não

    Numérico


    Quantidade do Valor no Atacado é a configuração da quantidade mínima para utilizar o preço de atacado.

    Por exemplo, pode ser configurado para que determinado item seja vendido no valor de atacado a partir de 5.

    Identificação do fornecedor

    id_retaguarda_fornecedor

    Não

    Texto

    100

    Identificação do fornecedor no erp

    Identificação do departamento

    id_retaguarda_departamento

    Não

    Texto

    100

    Identificação do departamento no erp

    Identificação da seção

    id_retaguarda_secao

    Não

    Texto

    100

    Identificação da seção no erp

    Identificação da categoria

    id_retaguarda_categoria

    Não

    Texto

    100

    Identificação da categoria no erp

    Identificação da subcategoria

    id_retaguarda_sub_categoria

    Não

    Texto

    100

    Identificação da subcategoria no erp

    Identificação da marca

    id_retaguarda_marca

    Não

    Texto

    100

    Identificação da marca no erp


    Produto_similar

    Produto_Similar

    No PDV, quando é acessada a tela de detalhes do produto é possível encontrar a informação de produtos similares a ele mesmo. Para isso é necessário fazer o vinculo do produto com seu similar através da tabela produto_similar.

    Informação Coluna Obrigatório Tipo Tamanho Descrição
    Identificação no retaguarda id_retaguarda Não Texto 100
    ID da tabela produto do item "raiz" id_produto Não Inteiro
    Identificação do produto raiz, que ao ser consultado irá apresentar quais seu similares
    ID da tabela produto do item similar ao "raiz" id_similar Não Inteiro
    Identificação do item similar ao consultado
    Situação situacao Sim Inteiro

    Define se o o vinculo em questão está ativo ou inativo.

    • 0 - Inativo
    • 1 - Ativo
    Data de cadastro data_cadastro Sim Data
    Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
    Data de atualização data_atualizacao Sim Data
    Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.


    Produto_Sugestao

    Produto_Sugestao

    No PDV, quando é acessada a tela de detalhes do produto é possível encontrar a informação de produtos sugeridos para serem vendidos junto a ele. Para isso é necessário fazer o vinculo do produto com seus sugeridos através da tabela produto_sugestao.

    Informação Coluna Obrigatório Tipo Tamanho Descrição
    Identificação no retaguarda id_retaguarda Não Texto 100
    ID da tabela produto do item "raiz" id_produto Não Inteiro
    Identificação do produto raiz, que ao ser consultado irá apresentar quais itens são sugeridos ao compra-lo
    ID da tabela produto do item sugestão ao "raiz" id_sugestao Não Inteiro
    Identificação dos itens sugeridos para o item consultado
    Situação situacao Sim Inteiro

    Define se o o vinculo em questão está ativo ou inativo.

    • 0 - Inativo
    • 1 - Ativo
    Data de cadastro data_cadastro Sim Data
    Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
    Data de atualização data_atualizacao Sim Data
    Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.


    Codigo_identificacao_produto

    Quando o produto possui mais de um código de identificação pode adicionar essa identificação na tabela de codigo_identificacao_produto. Atualmente o cliente que mais usa essa tabela é a Technos.

    Esses códigos também podem ser informados no PDV para adicionar o item ao carrinho.

    Informação Coluna Obrigatório Tipo Tamanho Descrição
    ID do produto id_produto Não Inteiro
    ID do item na tabela produto. Vinculo entre a produto e codigo_identificacao_produto
    Código codigo Sim Texto 200 Identificação do produto raiz, que ao ser consultado irá apresentar quais itens são sugeridos ao compra-lo
    Código externo codigo_externo Não Texto 200 Identificação dos itens sugeridos para o item consultado
    Descrição do código descricao Não Texto 200 Descrição do tipo de código, por padrão "Código Referência"
    Situação situacao Sim Inteiro

    Define se o o vinculo em questão está ativo ou inativo.

    • 0 - Inativo
    • 1 - Ativo
    Data de cadastro data_cadastro Sim Data
    Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
    Data de atualização data_atualizacao Sim Data
    Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.
    Identificação no retaguarda id_retaguarda Não Texto 100



    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
      • /api/retaguarda/v3/produtos
      • /api/retaguarda/v3/dadosdinamicos/down/12/1
    • 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

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

    Requisição

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


    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


    • Tamanho máximo: 20
    descontoMaximo numérico Desconto máximo aplicado ao produto Não
    tipoArredondaTrunca int
    Não
    codigoProduto string Código do produto

    Sim


    • Tamanho máximo: 20
    codigoAlternativo string Código alternativo do produto

    Sim


    • Tamanho máximo: 40
    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 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
    • 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


    • Tamanho máximo: 100
    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

    Exemplo de body de retorno

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

    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

    Exemplo de body de retorno

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

    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

    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

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

    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


    • Tamanho máximo: 20
    descontoMaximo numérico Desconto máximo aplicado ao produto Não
    tipoArredondaTrunca int DEFASADO Não
    codigoProduto string Código do produto

    Sim


    • Tamanho máximo: 20
    codigoAlternativo string Código alternativo do produto

    Sim


    • Tamanho máximo: 40
    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


    • Tamanho máximo: 100
    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

    Exemplo de body de retorno

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

    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

    Exemplo de body de retorno

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

    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



    • Sem rótulos