Presence API - INCLUIR_PRODUTO

Presence API - INCLUIR_PRODUTO

Inclusão de Produtos (Atualização e Inclusão)

Este módulo é responsável por incluir produtos na base da dados.

Parâmetros

Campos

Tipo

Obrigatório

Descrição
codigo
string(8)
Não para inclusão, sim para alteração, quando codigoExterno ou codigoLegado não informado
Código do produto no sistema. Quando não informado, será criado novo código, conforme parametrização
codigoExterno
string(24)
Não para inclusão, sim para alteração, quando codigo ou codigoLegado não informado
Código externo do produto
codigoLegado
string(24)
Não para inclusão, sim para alteração, quando codigo ou codigoExterno não informado
Código do produto no sistema de terceiros
descricao
string(30)
Sim, para inclusão
Descrição do produto
narrativa
string(100)
Sim, para inclusão
Narrativa  do produto
departamento
Grupo
Sim, para inclusão

codigo
string(2)
Sim, para inclusão, se a descrição não for informada
Código do departamento do produto. Quando não informado, descrição será usada para cadastrar novo. Quando informado e inexistente, descrição será usada para cadastrar novo com o mesmo código.
descricao
string(30)
Sim, para inclusão, se o código não for informado 
Descrição do departamento do produto
grupo
Grupo
Sim, para inclusão

codigo
string(2)
Sim, para inclusão, se a descrição não for informada
Código do grupo do produto. Quando não informado, descrição será usada para cadastrar novo. Quando informado e inexistente, descrição será usada para cadastrar novo com o mesmo código.
descricao
string(30)
Sim, para inclusão, se o código não for informado 
Descrição do grupo do produto
subgrupo
Grupo
Não

codigo
string(2)
Não
Código do subgrupo do produto. Quando não informado, descrição será usada para cadastrar novo. Quando informado e inexistente, descrição será usada para cadastrar novo com o mesmo código.
descricao
string(20)
Não
Descrição do subgrupo do produto
colecao
Grupo
Sim, para inclusão

codigo
string(2)
Sim, para inclusão, se a descrição não for informada
Código da coleção do produto. Quando não informado, descrição será usada para cadastrar nova. Quando informado e inexistente, descrição será usada para cadastrar nova com o mesmo código.
descricao
string(30)
Sim, para inclusão, se o código não for informado 
Descrição da coleção do produto
linha
Grupo
Não

codigo
string(2)
Não
Código da linha do produto. Quando não informado, descrição será usada para cadastrar nova. Quando informado e inexistente, descrição será usada para cadastrar nova com o mesmo código.
descricao
string(30)
Não
Descrição da linha do produto
marca
Grupo
Não

codigo
Integer
Não
Código da marca do produto. Quando não informado, descrição será usada para cadastrar nova. Quando informado e inexistente, descrição será usada para cadastrar nova com o mesmo código.
descricao
string(30)
Não
Descrição da marca do produto
fornecedor
Grupo
Não

codigo
string(2)
Não
Código do fornecedor do produto. Quando não informado, fantasia, razaoSocial e cnpj serão usados para cadastrar novo. Quando informado e inexistente, fantasia, razaoSocial e cnpj serão usados para cadastrar novo com o mesmo código.
fantasia
string(30)
Sim, se código ou cnpj não informados
Nome fantasia do fornecedor vinculado ao produto
razaoSocial
string()
Sim, se código ou cnpj não informados
Razão social do fornecedor vinculado ao produto
cnpj
string(14)
Sim, se código não informado
CNPJ do fornecedor vinculado ao produto
tamanhoUnico
Boolean
Sim, para inclusão
Quando false,  obriga gradeTamanho.
Quando true, aplica grade única automática, não sendo necessário informar gradeTamanho.
gradeTamanho
Grupo
Sim, para Inclusão, quando tamanhoUnico = false

codigoGrade
string(4)
Sim, Quando não lista de tamanhos não informada
Código da grade de tamanhos. Quando não informado, usa tamanhos para buscar uma grade na base e fazer vínculo
buscarGradeCompleta
Boolean
Não
Quando true, obriga que a grade localiada tenha exatamente os mesmos tamanhos informados
cadastrarGradeQuandoNaoExistir
Boolean
Não
Quando true, cadastra a grade automaricamente com os tamanhos informados, caso não localize na base
listaTamanhos
Grupo
Sim, quando código da grade não for informado

tamanho
string(10)
Sim
Descrição do tamanho
corUnica
Boolean
Sim, para inclusão
Quando false,  obriga gradeCor.
Quando true, aplica grade única automática, não sendo necessário informar gradeCor.
gradeCor
GrupoSim, para Inclusão, quando tamanhoUnico = false

codigo            
string(4)
Sim, se a descrição não for informada
Código da cor
descricao
string(20)
Sim, se o código não for informado
Descrição da cor
cartela
string(8)
Não
Cartela de cores
unidadeVenda
string(2)
Sim, para inclusão
Código da unidade de venda do produto
unidadeCompra
string(2)
Não
Código da unidade de compra do produto
classificacaoFiscal
Grupo
Sim,para Inclusão

codigo
string(3)
Sim, se o NCM e a origem não forem informadas
Código da classificação fiscal do produto
ncm
string(14)
Sim, se o código não for informado
NCM do produto
origem
string(1)
Sim, se o código não for informado
Origem do produto
tipoProduto
Integer
Sim, para Inclusão
Tipo do produto: 0 para Mercadoria para revenda, 1 para Matéria-prima, 2 para Embalagem, 3 para Produto em processo, 4 para Produto acabado, 5 para Subproduto, 6 para Produto intermediário, 7 para Material de uso e consumo, 8 para Ativo imobilizado, 9 pra Serviços, 10 para Insumos, 11 para Outras
opcao
string(1)
Sim, para Inclusão
Opção de produto: F para Fabricado, C para Comprado, S para Consignado, U para Usado, G para Combo
referenciaFornecedor
string(24)
Não
Referência do fornecedor
ativo
Boolean
Não
Situação do produto, true para ativo, false para inativo
liberadoEcommerce
Boolean
Não
Envio do produto para e-commerce, true para enviar, false para não enviar
liberadoVenda
Boolean
Não
Situação do produto para venda, true para ativo, false para inativo
liberadoProducao
Boolean
Não
Situação do produto para produção, true para ativo, false para inativo
replicaFranquia
Boolean
Não
Situação do produto para franquias, true para ativo, false para inativo
codigoGenero
Integer
Não
Código do gênero do produto
partes
Integer
Não
Partes do produto
multiplos
Integer
Não
Múliplos para o produto
codigoComprador
string(2)
Não
Código de comprador para vínculo com o produto
codigoPack
string(2)
Não
Código de Pack do produto
tipoPack
Integer
Não
Tipo de Pack do produto: 0 para Não utiliza, 1 para Sugerido, 2 para Em catálogo, 3 para Todos
brinde
Boolean
Não
True para identificar o produto como brinde
coordenado
Boolean
Não
True para identificar o produto como coordenado
exigeIbama
Boolean
Não
True para identificar o produto para exigir IBAMA
peso
Float
Não
Peso do produto
altura
Float
Não
Altura do produto
largura
Float
Não
Largura do produto
comprimento
Float
Não
Comprimento do produto
observacao
string(1024)
Não
Observação do produto
especificacaoTecnica
string(1024)
Não
Especificação técnica do produto
composicao
string(1024)
Não
Composição do produto
prazoSeparacao
Integer
Não
Dias para separação do produto
prazoManipulacao
Integer
Não
Dias para manipulação do produto
prazoCompra
Integer
Não
Dias para compra do produto
partipaFidelidade
Boolean
Não
True para identificar o produto como participante do programa de fidelidade
pontosFidelidade
Integer
Não
Pontos de fidelidade do produto
utilizaRfid
Boolean
Não
True para que o produto gera RFID
codigoTemplateProducao
Integer
Não
Código do template de produção do produto
dataInclusao
Data
Não
Data de cadastro do produto
naoConsiderarDisponibilidade
Boolean
Não
True para que o produto não passe pela pela validação de estoque na reposição
validadeInicio
Data
Não
Início do período de validade do produto
validadeFinal
Data
Não
Final do período de validade do produto
comissaoAtacadoPrazo
Float
Não
Percentual de comissão para operações atacado à prazo
comissaoAtacadoVista
Float
Não
Percentual de comissão para operações atacado à vista
comissaoVarejoPrazo
Float
Não
Percentual de comissão para operações varejo à prazo
comissaoVarejoVista
Float
Não
Percentual de comissão para operações varejo à vista
comissaoRepresentante
Float
Não
Percentual de comissão para operações representante
comissaoGueltaPercentual
Float
Não
Percentual de comissão Guelta
comissaoGueltaValor
Float
Não
Valor fixo de comissão Guelta
comissaoGueltaDataInicio
Data
Não
Data de início da validade da comissão Guelta
comissaoGueltaDataFim
Data
Não
Data de final da validade da comissão Guelta
royaltiesPercentualLicenciados
Float
Não
Percentual royalties para Licenciados
royaltiesPercentualLicenciadora
Float
Não
Percentual royalties para Licenciadora
fundoPropagandaPercentual
Float
Não
Percentual para fundo de propaganda
gpc
string(8)
Não
GPC do produto
precoCompra
Float
Não
Preço de compra do produto 
precoDataBase
Data
Não
Data base do preço de compra
segundaMoeda
Float
Não
Valor de segunda moeda
indexador
String(2)
Não
Código de indexador
markupVarejo
Float
Não
Markup para preços de varejo
markupAtacado
Float
Não
Markup para preços de atacado
markupRepresentante
Float
Não
Markup para preços de representante
precoProducao
Float
Não
Valor de produção do produto
precoInsumos
Float
Não
Valor de insumos do produto
precosVenda
Grupo
Sim, quando liberadoVenda = true

tabelaPreco 
Integer
Sim
Código da tabela de preços
precoVarejo 
Double
Não
Preço de varejo para a tabela informada
precoAtacado 
Double
Não
Preço de atacado para a tabela informada
precoRepresentante 
Double
Não
Preço de representante para a tabela informada
precoVarejoPromocao 
Double
Não
Preço promocional de varejo para a tabela informada
precoAtacadoPromocao 
Double
Não
Preço promocional de atacado para a tabela informada
precoRepresentantePromocao 
Double
Não
Preço promocional de representante para a tabela informada
dataInicioPromocao 
Data
Não
Data inicial do período promocional
dataFimPromocao 
Data
Não
Data final do período promocional
ecommerce
Grupo
Não
Situação do produto no e-commerce, true para ativo, false para inativo
apresentarHome
Boolean
Não
True para habilitar apresentação de produto na vitrine e-commerce
mostrarSemEstoque
Boolean
Não
True para apresenta rproduto sem estoque no e-commerce
nome
string(100)
Não
Nome do produto no e-commerce
titulo
string(100)
Não
Titulo do produto no e-commerce
descricao
string(4096)
Não
Descrição do produto no e-commerce
descricaoCurta
string(4096)
Não
Descrição curta do produto no e-commerce
metatag
string(4096)
Não
Metatag do produto para e-commerce
palavrasChave
string(4096)
Não
Palavras-chave do produto para e-commerce
textlink
string(120)
Não
Textlink do produto para e-commerce
categorias
Grupo

 codigo    
Integer
Não
Código da categoria para vínculo ao produto
 principal
Boolean
Não
True marca a categoria como principal
tamanhos
Grupo
Não

tamanho 
string(10)
Não
Descrição do tamanho para ativação e-commerce
ativo
Boolean
Não
True marca o tamanho como ativo para e-commerce, false marca o tamanho como inativo para e-commerce
cores
Grupo
Não

codigo
string(4)
Não
Código da cor para ativação e-commerce
descricao
string(20)
Não
Descrição da cor para ativação e-commerce
ativo
Boolean
Não
True marca a cor como ativa para e-commerce, false marca a cor como inativa para e-commerce
codigosAuxiliares
Grupo
Não

tamanho 
string(10)
Não
Descrição do tamanho do código auxiliar
corCodigo
string(4)
Não
Código da cor do código auxiliar
cor
string(20)
Não
Descrição da cor do código auxiliar
codigoAuxiliar
string(24)
Não
Código auxiliar do produto
principal
Boolean
Não
True para marcar o código auxiliar como principal do produto
tipoCodigo
string(1)
Não
Tipo de código auxiliar: G para GTIN, O para Outros, M para E-commerce

BODY

  1. {
  2.    "codigo":"Z5628",
  3.    "codigoExterno":"EXT15628",
  4.    "codigoLegado":"LEG15628",
  5.    "descricao":"Teste de Inclusão API - 15628",
  6.    "narrativa":"Teste de Inclusão API - 15628 Narrativa",
  7.    "departamento":{
  8.       "codigo":"AA",
  9.       "descricao":"DEPARTAMENTO AA"
  10.    },
  11.    "grupo":{
  12.       "codigo":"AA",
  13.       "descricao":"GRUPO AA"
  14.    },
  15.    "subgrupo":{
  16.       "codigo":"AA",
  17.       "descricao":"SUBGRUPO AA"
  18.    },
  19.    "colecao":{
  20.       "codigo":"AA",
  21.       "descricao":"COLEÇÃO AA"
  22.    },
  23.    "linha":{
  24.       "codigo":"AA",
  25.       "descricao":"LINHA AA"
  26.    },    
  27.    "marca":{
  28.       "codigo":99,
  29.       "descricao":"MARCA 99"
  30.    },    
  31.    "fornecedor":{
  32.        "codigo":98,
  33.        "fantasia":"FORNECEDOR 98",
  34.        "razaoSocial":"FORNECEDOR 98 RAZÃO",
  35.        "cnpj":"57037731000129"
  36.    },
  37.    "tamanhoUnico":false,
  38.     "gradeTamanho":{
  39.         "codigoGrade":71,
  40.         "buscarGradeCompleta":true,
  41.         "cadastrarGradeQuandoNaoExistir":true,
  42.         "listaTamanhos":[
  43.             {                
  44.                 "tamanho":"P"
  45.             },
  46.             {                
  47.                 "tamanho":"M"
  48.             },
  49.             {
  50.                 "tamanho":"G"
  51.             },
  52.             {
  53.                 "tamanho":"BB"
  54.             }
  55.         ]
  56.     },
  57.    "corUnica":false,
  58.    "gradeCor":[
  59.        {
  60.            "codigo":"0019",
  61.            "descricao":""
  62.        },
  63.        {
  64.            "codigo":"",
  65.            "descricao":"BRANCA"
  66.        }
  67.    ],
  68.    "cartela":"CART15628",
  69.    "unidadeVenda":"FR",
  70.    "unidadeCompra":"UN",
  71.    "classificacaoFiscal":{
  72.        "codigo":"99",
  73.        "ncm":"48194000",
  74.        "origem":"0"
  75.    },
  76.    "tipoProduto": 4,
  77.    "opcao":"C",
  78.    "referenciaFornecedor":"RefForn15628",
  79.    "ativo":true,
  80.    "liberadoEcommerce":true,
  81.    "liberadoVenda":true,
  82.    "liberadoProducao":true,
  83.    "replicaFranquia":true,
  84.    "codigoGenero": "1234567891",
  85.    "partes":15,
  86.    "multiplos":0,
  87.    "codigoComprador":"01",
  88.    "codigoPack":71,
  89.    "tipoPack":2,
  90.    "brinde":true,
  91.    "coordenado":true,
  92.    "exigeIbama":true,
  93.    "exclusivoFranquia":true,    
  94.    "peso":"0.511",
  95.    "altura":1.22,
  96.    "largura":2.33,
  97.    "comprimento":3.44,
  98.    "observacao":"Observação do produto via API",
  99.    "especificacaoTecnica":"Ficha Técnica do produto via API ",
  100.    "composicao":"Composição do Produto via API",
  101.    "prazoSeparacao":"10",
  102.    "prazoManipulacao":6,
  103.    "prazoCompra":7,
  104.    "partipaFidelidade":true,
  105.    "pontosFidelidade":"10",
  106.    "utilizaRfid":true,
  107.    "codigoTemplateProducao":"4",
  108.    "dataInclusao": "2024-10-04",
  109.    "naoConsiderarDisponibilidade":false,
  110.    "validadeInicio":"2024-01-02",
  111.    "validadeFinal":"2025-01-03",
  112.    "comissaoAtacadoPrazo":"5,55555",
  113.    "comissaoAtacadoVista":2.22222,
  114.    "comissaoVarejoPrazo":3.33333,
  115.    "comissaoVarejoVista": 4.444444,
  116.    "comissaoRepresentante":5.55555,
  117.    "comissaoGueltaPercentual":7.77777,
  118.    "comissaoGueltaValor":8.88888,
  119.    "comissaoGueltaDataInicio":"2023-01-01",
  120.    "comissaoGueltaDataFim":"2025-01-01",
  121.    "royaltiesPercentualLicenciados":10.11111,
  122.    "royaltiesPercentualLicenciadora":12.22222,
  123.    "fundoPropagandaPercentual":13.33333,
  124.    "gpc":"GPC123456789",
  125.    "precoCompra":"19.95",
  126.    "precoDataBase":"2022-12-31",
  127.    "segundaMoeda":18.95,
  128.    "indexador":"01",
  129.    "precoProducao":6.95,    
  130.    "precoInsumos":1.98,    
  131.    "markupVarejo":2.00,
  132.    "markupAtacado":1.50,
  133.    "markupRepresentante":1.0,
  134.    "precosVenda":[
  135.        {
  136.            "tabelaPreco":1,
  137.            "precoVarejo":39.95,
  138.            "precoAtacado":29.99,
  139.            "precoRepresentante":19.99,
  140.            "precoVarejoPromocao":35.95,
  141.            "precoAtacadoPromocao":25.95,
  142.            "precoRepresentantePromocao":15.95,
  143.            "dataInicioPromocao":"2024-01-01",
  144.            "dataFimPromocao":"2025-01-05"
  145.        },
  146.        {
  147.            "tabelaPreco":2,
  148.            "precoVarejo":49.99,
  149.            "precoAtacado":0.00,
  150.            "precoRepresentante":0.00,
  151.            "precoVarejoPromocao":0.00,
  152.            "precoAtacadoPromocao":0.00,
  153.            "precoRepresentantePromocao":0.00
  154.        }        
  155.    ],
  156.    "ecommerce":{
  157.        "ativo":true,
  158.        "apresentarHome":false,
  159.        "mostrarSemEstoque":false,
  160.        "nome":"ECM Nome",
  161.        "titulo":"ECM Título ",
  162.        "descricao":"ECM Descrição ",
  163.        "descricaoCurta":"ECM Descrição Curta",
  164.        "metatag":"ECM Metatag",
  165.        "palavrasChave":"ECM Palavras Chave",
  166.        "textlink":"ECM TextLink",
  167.        "categorias":[
  168.            {
  169.                "codigo":"22",            
  170.                "principal":true
  171.            },
  172.            {
  173.                "codigo":26,
  174.                "principal":true
  175.            }            
  176.        ],
  177.        "tamanhos":[
  178.            {
  179.                "tamanho":"P",
  180.                "ativo":true
  181.            }
  182.        ],
  183.        "cores":[
  184.            {
  185.            "codigo":"0019",
  186.            "descricao":"BRANCA",
  187.            "ativo":true  
  188.            } ,
  189.            {
  190.            "codigo":"",
  191.            "descricao":"BRANCA"
  192.            }
  193.        ]
  194.    },
  195.    "codigosAuxiliares":[
  196.        {
  197.           "tamanho":"P",
  198.           "corCodigo":"0001",
  199.           "cor":"",
  200.           "codigoAuxiliar":"AUX15628BP1",
  201.           "principal":true,
  202.           "tipoCodigo":"E"    
  203.        },      
  204.        {
  205.           "tamanho":"M",
  206.           "corCodigo":"",
  207.           "cor":"PRETO",          
  208.           "codigoAuxiliar":"AUX15628PM1",
  209.           "principal":false,
  210.           "tipoCodigo":"G"    
  211.        },      
  212.        {
  213.           "tamanho":"P",
  214.           "corCodigo":"",
  215.           "cor":"BRANCA",          
  216.           "codigoAuxiliar":"AUX15628BP2",
  217.           "principal":true,
  218.           "tipoCodigo":"O"    
  219.        },      
  220.        {
  221.           "tamanho":"P",
  222.           "corCodigo":"",
  223.           "cor":"BRANCA",          
  224.           "codigoAuxiliar":"AUX15628BP3",
  225.           "principal":false,
  226.           "tipoCodigo":"M"    
  227.        }              
  228.    ]
  229. }







    • Related Articles

    • Presence API - INCLUIR_PEDIDO

      Inclusão de Pedidos (Somente Inclusão) Este módulo é responsável por incluir pedidos na base da dados. BODY Pedido Nome Obrigatório Tipo Descrição codigoPedidoExterno Sim String Código do pedido na plataforma dataEmissão Não Data ...

    • Presence API - Página Inicial

      Essa API permite o consumo de informações disponíveis nos sistemas Presence através de chamadas de serviço, bem como a inserção de dados nos sistemas. Para ter acesso aos métodos já existentes, ou solicitação da criação de novos métodos, consulte as ...

    • Presence API - INCLUIR_CLIENTE

      Inclusão de Clientes (Atualização e Inclusão) Este módulo é responsável por incluir clientes na base da dados. Parâmetros Nome Obrigatório Tipo Descrição codigoExterno Não String Código do cliente no sistema de terceiros, obrigatório quando cpf_cnpj ...

    • Presence API - ESTOQUE

      Saldo de Estoque Este módulo é responsável por listar o estoque do produto/sku da base da dados. Parâmetros Nome Obrigatório Tipo Descrição codigo SIM quando não informado data_at String  Código do sku(produto) loja SIM String Código da loja. data_at ...

    • Presence API - ESTOQUE-MOVIMENTACAO

      Movimentações de Estoque Este método é responsável por realizar movimentações de estoque de skus. Parâmetros Nome Obrigatório Tipo Descrição codigoTransacao Sim Integer Código da transação do movimento: 10 - Entrada de Mercadoria 11 - Devolução de ...