Este método é responsável pela criação de novos Produtoou 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
...
| Expandir |
|---|
| title | Definição dos campos de requisição |
|---|
|
Campo | Tipo | Descrição | Obrigatório | Observações |
|---|
| descricao | string | Descrição do produto |
Obrigatório;X | - 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 |
Obrigatório;X
| | | descontoMaximo | string | Desconto máximo aplicado ao produto |
OpcionalOpcional |
|
|
| | codigoProduto | string | Código do produto |
Obrigatório;X
| | | codigoAlternativo | string | Código alternativo do produto |
Obrigatório;X
| | | origemProduto | int | Origem do produto |
Obrigatório| X |
| | situacao | int | Situação do produto (0 - Inativo, 1 - Ativo) |
ObrigatórioX |
| | imagem | string | URL com a imagem do produto |
Opcional |
|
| | tipoProduto | int | Tipo do produto |
Obrigatório| X |
| | fracionado | boolean | Indica se o produto é vendido fracionado |
Opcional |
|
| | cnpjFornecedor | string | CNPJ do fornecedor do produto |
Opcional |
|
| | escalaRelevante | boolean | Escala relevante |
Opcional |
|
| | cstIcms | string | CST ICMS do produto |
Opcional |
|
| | percentualReducaoIcms | string | Percentual de redução ICMS |
Opcional |
|
| | aliquotaIcms | string | Aliquota ICMS |
Opcional | OpcionalOpcional |
|
| | encomenda | boolean | Indica se o produto é uma encomenda |
Opcional |
|
| | pesoLiquido | float | Peso liquido do produto |
Opcional |
|
| | pesoBruto | float | Peso bruto do produto |
Opcional |
|
| | associacaoProdutosClassificacao | Lista de objetos | Lista de classificação do produto |
Opcional |
|
| | associacaoProdutosClassificacao.idRetaguarda | string | Identificador da classificação na retaguarda |
Opcional |
|
| | associacaoProdutosClassificacao.idRetaguardaProduto | string | Identificador do produto na retaguarda |
Opcional |
|
| | associacaoProdutosClassificacao.idRetaguardaClassificacaoProduto | string | Identificador da classificação na retaguarda |
Opcional |
|
| | associacaoProdutosClassificacao.ordemOpcional | int | Ordem opcional |
Opcional |
|
| | associacaoProdutosClassificacao.situacao | int | Situação da classificação |
Opcional |
|
| | produtoEmbalagens | lista de objetos | Lista de embalagens do produto |
Opcional |
|
| | produtoEmbalagens.codigoBarras | string | Código de barras da embalagem |
Opcional |
|
| | produtoEmbalagens.descricao | string | Descrição da embalagem |
Opcional
| - 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 |
Opcional |
|
| | produtoEmbalagens.idRetaguarda | string | Identificador da embalagem na retaguarda |
Opcional |
|
| | produtoEmbalagens.pesoBruto | float | Peso bruto da embalagem |
Opcional |
|
| | produtoEmbalagens.pesoLiquido | float | Peso liquido da embalagem |
Opcional |
|
| | produtoEmbalagens.quantidade | int | Quantidade de produtos na embalagem |
Opcional |
|
| | produtoEmbalagens.situacao | int | Situação da embalagem |
Opcional |
|
| | produtoEmbalagens.unidadeMedida | string | Unidade de medida da embalagem |
Opcional |
|
| | produtoKits | Lista de objetos | Lista de kits |
Opcional |
|
| | produtoKits.idRetaguarda | string | Registo único, responsável por identificar o item na tabela de produto_kit. |
| - 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 |
na retaguardaOpcional| KIT criado na tabela de produto. |
| - 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 |
retaguardaOpcional| tabela de produto |
| - Referencia os itens da tabela de produto que compõe o kit.
| | produtoKits.descricao | string | Descrição do kit |
Opcional |
|
| | produtoKits.quantidadeVendaKit | int | Quantidade de venda do kit |
Opcional |
|
| | produtoKits.tipoValorKit | int | Tipo valor kit |
Opcional |
|
| | produtoKits.situacao | int | Situação do kit |
Opcional |
|
| | produtoKits.valorDesconto | string | Valor de desconto |
Opcional |
|
| | produtoKits.novoValorUnitario | string | Novo valor unitário |
Opcional |
|
| | produtosSimilares | Lista de objetos | Lista de produtos similares |
Opcional |
|
| | produtosSimilares.idRetaguardaProduto | string | Identificador do produto na retaguarda |
Opcional |
|
| | produtosSimilares.idRetaguardaSimilar | string | Identificador do produto similar na retaguarda |
Opcional |
|
| | produtosSimilares.situacao | int | Situação do produto similar |
Opcional |
|
| | produtosSugestoes | Lista de objetos | Lista de sugestôes |
Opcional |
|
| | produtosSugestoes.idRetaguardaProduto | string | Identificador do produto na retaguarda |
Opcional |
|
| | produtosSugestoes.idRetaguardaSugestao | string | Identificador da sugestão na retaguarda |
Opcional |
|
| | produtosSugestoes.situacao | int | Situação da sugestão |
Opcional |
|
| | codigosProduto | Lista de objetos | Lista de códigos do produto |
Opcional |
|
| | codigosProduto.codigo | string | Código do produto |
Opcional |
|
| | codigosProduto.descricao | string | Descrição do código |
Opcional |
|
| | codigosProduto.idRetaguarda | string | Identificador do código na retaguarda |
Opcional |
|
| | codigosProduto.dataAtualizacao | string | Data atualização do código |
Opcional |
|
| | codigosProduto.dataCadastro | string | Data cadastro do código |
Opcional |
|
| | codigosProduto.situacao | int | Situação do produto |
Opcional |
|
| | impostos | Lista de objetos | Lista de impostos do produto |
Obrigatório |
|
| | impostos.idRetaguarda | string | Identificador do imposto na retaguarda |
Opcional |
|
| | impostos.idProprietario | string | Identificador do proprietário |
Opcional |
|
| | ncms | Lista de objetos | Lista de NCMs |
Opcional |
|
| | ncms.idRetaguarda | string | Identificador do NCM na retaguarda |
Opcional |
|
| | ncms.idProprietario | string | Identificador do proprietário |
Opcional |
|
| | pisCofins | Lista de objetos | Lista de PisCofins |
Opcional |
|
| | pisCofins.idRetaguarda | string | Identificador do PisCofin na retaguarda |
Opcional |
|
| | pisCofins.idProprietario | string | Identificador do proprietário |
Opcional |
|
| | fcps | Lista de objetos | Lista de FCPs |
Opcional |
|
| | fcps.valorBaseFcp | string | Valor base do FCP |
Opcional |
|
| | fcps.percentualFcp | string | Percentual do FCP |
Opcional |
|
| | fcps.codigoBeneficioFiscal | string | Código de benefício fiscal |
Opcional |
|
| | fcps.motivoDesoneracaoIcms | int | Motivo desoneração |
Opcional |
|
| | fcps.descontaDesoneracaoNf | boolean | Desconto desoneraçao |
Opcional |
|
| | fcps.idProprietario | string | Identificador do proprietário |
Opcional |
|
| | quantidadeMovimentacao | float | Quanitdade de movimentação |
Opcional |
|
| | idInquilino | string | Identificador do inquilino |
Obrigatório| X |
| | idRetaguarda | string | Identificador do produto na retaguarda |
Obrigatório;X
| | | idProprietario | string | Identificador do proprietário |
Obrigatório |
|
| | loteOrigem | string | Identificador do lote que os dados serão enviados |
Opcional |
| Expandir |
|---|
| title | Definição dos campos de retorno |
|---|
|
| Expandir |
|---|
| 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 |
| Expandir |
|---|
| {
"success": true,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
|
| Expandir |
|---|
| 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 |
|
|
