Árvore de páginas

Versões comparadas

Chave

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

...

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


Deck of Cards
iddk1
Card
idcard1
labelDescrição dos campos e regras
InformaçãoColunaObrigatórioTipoTamanhoDescriçã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


Dafasado

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




Produto_similar

Informações
titleProduto_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çãoColunaObrigatórioTipoTamanhoDescrição
Identificação no retaguardaid_retaguardaNãoTexto100
ID da tabela produto do item "raiz"id_produtoNãoInteiro
Identificação do produto raiz, que ao ser consultado irá apresentar quais seu similares
ID da tabela produto do item similar ao "raiz"id_similarNãoInteiro
Identificação do item similar ao consultado
SituaçãosituacaoSimInteiro

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

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


Produto_Sugestao

Informações
titleProduto_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çãoColunaObrigatórioTipoTamanhoDescrição
Identificação no retaguardaid_retaguardaNãoTexto100
ID da tabela produto do item "raiz"id_produtoNãoInteiro
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_sugestaoNãoInteiro
Identificação dos itens sugeridos para o item consultado
SituaçãosituacaoSimInteiro

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

  • 0 - Inativo
  • 1 - Ativo
Data de cadastrodata_cadastroSimData
Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
Data de atualizaçãodata_atualizacaoSimData
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çãoColunaObrigatórioTipoTamanhoDescrição
ID do produtoid_produtoNãoInteiro
ID do item na tabela produto. Vinculo entre a produto e codigo_identificacao_produto
CódigocodigoSimTexto200Identificação do produto raiz, que ao ser consultado irá apresentar quais itens são sugeridos ao compra-lo
Código externocodigo_externoNãoTexto200Identificação dos itens sugeridos para o item consultado
Descrição do códigodescricaoNãoTexto200Descrição do tipo de código, por padrão "Código Referência"
SituaçãosituacaoSimInteiro

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

  • 0 - Inativo
  • 1 - Ativo
Data de cadastrodata_cadastroSimData
Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
Data de atualizaçãodata_atualizacaoSimData
Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.
Identificação no retaguardaid_retaguardaNãoTexto100



Card
idcard2
labelComo 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

Expandir
titleExemplo 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"
    }
]

Expandir
titleDefinição dos campos de retorno
Expandir
title200 - Ok

Campo

Tipo

Descrição

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

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

Expandir
title400 - Bad Request

Campo

Tipo

Descrição

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