...
Abaixo temos mais informações sobre cada EndPoint utilizado na comunicação com o ERP/Retaguarda.
A API compartilhamento é de extrema importância para que o PDVSync saiba onde entregar as informações enviadas em todos as API´s, ou seja, através da composição dos dados da compartilhamento o PDVSync sabe quem é o dado enviado tem um ID Proprietário e este na compartilhamento tem quem são as lojas que devem receber as informações enviadas com um ID Proprietário.
...
API com um método Post, Get, Put e Delete para o ERP possa ser enviar o cadastro de produtos no PDVSync.
Parâmetros de entrada:
Campo | Tipo | Tamanho | Obrigatoriedade | Descrição |
IdInquilino | String | Sim | Identificador do inquilino no PDV Sync | |
IdProprietario | String | Sim | Identificador do proprietário da informação, deve ser enviada a mesma informação criada na API de Compartilhamento, pois ela irá definir para quais lojas a informação deverá ser distribuída. | |
IdRetaguarda | String | 100 | Sim | Identificador do produto no ERP |
Lote | Integer | Não | Informação do PDV Sync, não integrado pelo ERP | |
LoteOrigem | Integer | Sim | Número do lote que está sendo integrado, disponibilizado pelo PDV Sync ao ERP na abertura da integração | |
dataAtualizacao | DateTime | Não | Data de atualização do registro | |
dataCadastro | DateTime | Não | Data de cadastro do registro | |
IdRetaguardaImposto | String | 100 | Não | Identificador do cadastro de alíquota do qual o produto está associado. A informação não é envio obrigatório, mas sua ausência irá impedir a venda do produto no PDV. |
IdRetaguardaNcm | String | 100 | Não | Identificador do cadastro de NCM do qual o produto está associado. A informação não é envio obrigatório, mas sua ausência irá impedir a venda do produto no PDV. |
IdRetaguardaPisCofins | String | 100 | Não | Identificador do cadastro de PIS e Cofins do qual o produto está associado. A informação não é envio obrigatório, mas sua ausência poderá impedir a venda do produto no PDV. Exigido no modelo fiscal SAT e opcional para o modelo fiscal NFCe |
Descricao | String | 200 | Sim | Descrição do produto que será utilizado para venda e pesquisa. |
UnidadeMedida | String | 20 | Sim | Unidade de medida do produto, exemplo: UN, PC, KG |
DescontoMaximo | N/A | N/A | N/A | Item descontinuado , enviar o valor padrão 99 |
TipoArredondaTrunca | String | 1 | Sim | Indicador de Arredondamento ou Truncamento para geração do arquivo "Registros do PAF-NFCe" solicitados no modelo fiscal PAF-NFCe. Sendo: A - Arredondamento T - Truncamento |
CodigoProduto | String | 20 | Sim | Código do produto que será utilizado para venda e pesquisa |
CodigoAlternativo | 40 | Não | Código alternativo do produto, por exemplo código de barras. O código será utilizado para venda e pesquisa. | |
OrigemProduto | 20 | Sim | Origem do produto, sendo: 0 - Nacional 1 - Importado | |
Situacao | Integer | Sim | Situação de venda do produto, podendo ser: 0 - Inativo 1 - Ativo | |
Imagem | N/A | N/A | N/A | Item descontinuado |
TipoProduto | Integer | Sim | Identificador do tipo do produto, podendo ser: 1 - Consumo 2 - Revenda 3 - Kit 6 - Serviço Quando informado um produto do tipo KIT, é obrigatório o envio do campo produto.kit com os produtos associados ao kit | |
Fracionado | Boolean | N/A | Sim | Indicador para definir se o produto poderá ser vendido com quantidade fracionada |
CnpjFornecedor | String | 20 | Não | CNPJ do fabricante do produto quando produto não é fabricado em escala relevante, conforme Nota Técnica 2016.002 |
EscalaRelevante | Boolean | Sim | Indicador de produção em escala relevante, conforme Nota Técnica 2016.002 | |
ValorBaseFcp | Numeric | Não | Valor da Base de Cálculo do Fundo de Combate a Pobreza, conforme NFCe 4.0 | |
CodigoBeneficioFiscal | String | 20 | Não | Código de Benefício Fiscal, onde deve ser informado o tipo de incentivo tributário que a empresa/produto está recebendo, conforme Nota Técnica 2019.001 versão 1.2 |
PercentualFcp | Numeric | Não | Percentual do Fundo de Combate à Pobreza, conforme NFCe 4.0 | |
CstIcms | N/A | N/A | N/A | Avaliando |
PercentualReducaoIcms | N/A | N/A | N/A | Avaliando |
AliquotaIcms | N/A | N/A | N/A | Avaliando |
Vlicmsret | Numeric | Não | Valor do ICMS retido anteriormente, conforme Nota Técnica 2018.005 | |
MotivoDesoneracaoIcms | Integer | Não | Motivo de desoneração do ICMS, conforme Nota Técnica | |
DescontaDesoneracaoNf | Boolean | Não | Indicador se o PDV deverá descontar o valor de desoneração do total da venda | |
Cest | String | 7 | Não | Código Especificador da Substituição Tributária do produto. A informação não é envio obrigatório, mas sua ausência irá impedir a venda do produto com alíquota do tipo substituição tributária. |
produtoKits | List | Não | Lista com os produtos associados ao Kit, obrigatório quando o TipoProduto for igual a 3. | |
produtoKits.IdRetaguardaProduto | String | 100 | Sim | Identificador do produto no ERP |
produtoKits.IdRetaguardaProdutoKit | String | 100 | Sim | Identificador |
produtoKits.Descricao | String | 200 | Sim | Descrição do produto que será utilizado para venda e pesquisa. |
produtoKits.QuantidadeVendaKit | Integer | Sim | Quantidade de venda do produto no Kit | |
produtoKits.TipoValorKit | Integer | Sim | Verificar os tipos! | |
produtoKits.Situacao | Integer | Sim | Situação de venda do produto, podendo ser: 0 - Inativo 1 - Ativo | |
produtoKits.ValorDesconto | ||||
produtoKits.NovoValorUnitario | ||||
produtosSimilares | ||||
produtosSimilares.Id | ||||
produtosSimilares.IdInquilino | ||||
produtosSimilares.IdRetaguarda | ||||
produtosSimilares.IdProprietario | ||||
produtosSimilares.Lote | ||||
produtosSimilares.LoteOrigem | ||||
produtosSimilares.IdRetaguardaProduto | ||||
produtosSimilares.Situacao | ||||
produtosSimilares.IdRetaguardaSimilar | ||||
ProdutosSugestoes | ||||
produtosSimilares.Id | ||||
ProdutosSugestoes.IdInquilino | ||||
ProdutosSugestoes.IdRetaguarda | ||||
ProdutosSugestoes.IdProprietario | ||||
ProdutosSugestoes.Lote | ||||
ProdutosSugestoes.LoteOrigem | ||||
ProdutosSugestoes.IdRetaguardaProduto | ||||
ProdutosSugestoes.Situacao | ||||
ProdutosSugestoes.IdRetaguardaSugestao | ||||
codigosProduto | ||||
codigosProduto.codigo | ||||
codigosProduto.descricao | ||||
codigosProduto.idRetaguarda | ||||
codigosProduto.dataAtualizacao | ||||
codigosProduto.dataCadastro | ||||
codigosProduto.situacao | ||||
associacaoProdutosClassificacao |
Campo | Tipo | Tamanho | Obrigatoriedade | Descrição |
---|---|---|---|---|
IdProprietario | ||||
Lote | ||||
LoteOrigem | ||||
IdRetaguardaImposto | ||||
IdRetaguardaNcm | ||||
IdRetaguardaPisCofins | ||||
Descricao | ||||
UnidadeMedida | ||||
DescontoMaximo | ||||
TipoArredondaTrunca | ||||
CodigoProduto | ||||
CodigoAlternativo | ||||
OrigemProduto | ||||
Situacao | ||||
Imagem | ||||
TipoProduto | ||||
Fracionado | ||||
CnpjFornecedor | ||||
EscalaRelevante | ||||
ValorBaseFcp | ||||
CodigoBeneficioFiscal | ||||
PercentualFcp | ||||
CstIcms | ||||
PercentualReducaoIcms | ||||
AliquotaIcms | ||||
Vlicmsret | ||||
MotivoDesoneracaoIcms | ||||
DescontaDesoneracaoNf | ||||
Cest | ||||
produtoKits | ||||
produtoKits.Id | ||||
produtoKits.IdInquilino | ||||
produtoKits.IdRetaguarda | ||||
produtoKits.IdProprietario | ||||
produtoKits.Lote | ||||
produtoKits.LoteOrigem | ||||
produtoKits.IdRetaguardaProduto | ||||
produtoKits.IdRetaguardaProdutoKit | ||||
produtoKits.Descricao | ||||
produtoKits.QuantidadeVendaKit | ||||
produtoKits.TipoValorKit | ||||
produtoKits.Situacao | ||||
produtoKits.ValorDesconto | ||||
produtoKits.NovoValorUnitario | ||||
produtosSimilares | ||||
produtosSimilares.Id | ||||
produtosSimilares.IdInquilino | ||||
produtosSimilares.IdRetaguarda | ||||
produtosSimilares.IdProprietario | ||||
produtosSimilares.Lote | ||||
produtosSimilares.LoteOrigem | ||||
produtosSimilares.IdRetaguardaProduto | ||||
produtosSimilares.Situacao | ||||
produtosSimilares.IdRetaguardaSimilar | ||||
ProdutosSugestoes | ||||
produtosSimilares.Id | ||||
ProdutosSugestoes.IdInquilino | ||||
ProdutosSugestoes.IdRetaguarda | ||||
ProdutosSugestoes.IdProprietario | ||||
ProdutosSugestoes.Lote | ||||
ProdutosSugestoes.LoteOrigem | ||||
ProdutosSugestoes.IdRetaguardaProduto | ||||
ProdutosSugestoes.Situacao | ||||
ProdutosSugestoes.IdRetaguardaSugestao | ||||
codigosProduto | ||||
codigosProduto.codigo | ||||
codigosProduto.descricao | ||||
codigosProduto.idRetaguarda | ||||
codigosProduto.dataAtualizacao | ||||
codigosProduto.dataCadastro | ||||
codigosProduto.situacao |
...