Objetivo
A finalidade deste método é possibilitar o cadastro de produtos, incluindo dados de códigos de acesso, e imagens de produtos.
Chamada
POST [URLAPI]/SMProdutosAPI/api/v4/produtos/produtoPermissionamento
Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.
Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo > Sistemas/Módulo/Aplicações > Comercial Web > API Produtos > API Produtos
Imagem 01 - Configurações de Sistemas/Módulos/Aplicações
Assuntos Relacionados
Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.
Informações para Requisição (Request Information)
Parâmetros URI (URI Parameters)
Não há.
Parâmetros do Corpo (Body Parameters)
Família
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
|---|---|---|---|
| familia | Descrição da família | string | Não há. |
| pesavel | Indica se produto é pesável | string | Não há. |
| permiteDecimal | Indica se permite valor decimal | string | Não há. |
| idMarca | Código da marca | integer | Não há. |
| IndicadorVasilhame | Indicador vasilhame | string | Não há. |
| permiteMultiplicacao | Indica se permite multiplicação | string | Não há. |
| indicadorLoteEstoque | Indicador do lote | string | Não há. |
| aliquotaIPI | Aliquota de IPI | integer | Não há. |
| cstPISEntrada | CST PIS entrada | string | Não há. |
| cstCOFINSEntrada | CST COFINS entrada | string | Não há. |
| cstPISSaida | CST PIS saida | string | Não há. |
| cstCOFINSSaida | CST COFINS saida | string | Não há. |
| codigoNBMSH | Código NBMSH | string | Não há. |
| cestCodigo | Código CEST | integer | Não há. |
| impostoImportacaoPercentual | Percentual do imposto de importação | integer | Não há. |
| indicadorReceita | Indicador receita | string | Não há. |
| indicadorSimilar | Indicador Similar | string | Não há. |
| indicadorReplicacao | Indicador Replicacao | string | Não há. |
| tipoReceita | Tipo de Receita | integer | Não há. |
| indTributacaoPisCofins | Índice de Tributacao PIS COFINS | string | Não há. |
| SituacaoSimplesPISCOFINS | Situacão Simples PIS COFINS | string | Não há. |
Embalagem
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
|---|---|---|---|
| QtdEmbalagem | Quantidade por embalagem | integer | Não há. |
| SiglaEmbalagem | Sigla embalagem | string | Não há. |
| PesoBruto | Peso bruto | integer | Não há. |
| PesoLiquido | Peso liquido | integer | Não há. |
| Altura | Altura | integer | Não há. |
| Largura | Largura | integer | Não há. |
| Profundidade | Profundidade | integer | Não há. |
| Status | Status | string | Não há. |
| QtdUnitEmbalagem | Quantidade unitária por embalagem | integer | Não há. |
| Pesavel | Indica se produto é pesável | string | Não há. |
| IndicaReplicacao | Indica se permite replicação | string | Não há. |
| Litros | Litros | integer | Não há. |
| UtilizaEmissaoEtiqLote | Utiliza emissão de etiqueta por lote | string | Não há. |
| TipoEmbalagemPreco | Tipo embalagem preço | string | Não há. |
| EmbalagemDecimal | Embalagem decimal | string | Não há. |
Fornecedores
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
|---|---|---|---|
| cnpj | CNPJ do fornecedor | string | Não há. |
| fornecedorPrincipal | Indica se é fornecedor principal | string | Não há. |
| indReplicacao | Indica se permite replicação | string | Não há. |
| calculaDescontoSuframaParaPisCofins | Calcula desconto para PIS COFINS | string | Não há. |
| indCobraIPIReceb | Indica cobrança IPI recebido | string | Não há. |
| indControlaPrincipal | Indica controle principal | string | Não há. |
Divisões
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
|---|---|---|---|
| numeroDivisao | Número da divisao | integer | Não há. |
| embalagemCompraPadrao | Embalagem compra padrão | integer | Não há. |
| idComprador | Código do comprador | integer | Não há. |
| numeroTributacao | Número da tributação | integer | Não há. |
| finalidadeFamilia | Finalidade familia | string | Não há. |
| formaAbastecimento | Forma de abastecimento | string | Não há. |
| fatorAtendimento | Fator atendimento | integer | Não há. |
| margemLucro | Margem lucro | integer | Não há. |
| indReplicacao | Indica se permite replicação | string | Não há. |
| idCategoria | Código da categoria | integer | Não há. |
Produto
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
|---|---|---|---|
| seqFamilia | Código sequencial da familia | integer | Não há. |
| complemento | Complemento | string | Não há. |
| descricaoCompleta | Descrição completa | string | Não há. |
| descricaoReduzida | Descrição reduzida | string | Não há. |
| indProcessoFabricacao | Indica processo fabricação | string | Não há. |
| descricaoGenerica | Descrição genérica | string | Não há. |
| codigoANP | Código ANP | integer | Não há. |
| descricaoANP | Descrição ANP | string | Não há. |
| indPrecoSaldoZero | Indica preço saldo zero | string | Não há. |
| indTemperaturaControleProduto | Indica temperatura controle produto | string | Não há. |
| integracaoSistemaCodTributario | Integração sistema código tributário | string | Não há. |
| indReplicacao | Indica se permite replicação | string | Não há. |
| indEmitiCodTributarioNFE | Indica emite código tributário NFE | string | Não há. |
Códigos
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
|---|---|---|---|
| TipoCodigo | Tipo código | string | Não há. |
| CNPJFornecedor | CNPJ fornecedor | string | Não há. |
| CPFCNPJCliente | CPF CNPJ cliente | string | Não há. |
| SeqRede | Sequencial rede | integer | Não há. |
| CodAcessoNum | Código acesso | integer | Não há. |
| QtdEmbalagem | Quantidade embalagem | integer | Não há. |
| CodigoAcesso | Código de acesso | string | Não há. |
| IndUtilVenda | Indica utilidade venda | string | Não há. |
| IndEANTribNFE | Indica EAN tributação NFE | string | Não há. |
| IndUtilNFE | Indica utilidade NFE | string | Não há. |
Imagens
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
|---|---|---|---|
| descricao | Descrição da imagem | string | Não há. |
| imagem | Imagem | string | Não há. |
| urlImagem | URL imagem | string | Não há. |
| principal | Imagem principal | string | Não há. |
| DisposicaoImagem | Disposição imagem | string | Não há. |
Formatos da Requisição (Request Formats)
application/json, text/json
Exemplo (Sample):
{
"dadosFamilia": {
"familia": "string",
"pesavel": "string",
"permiteDecimal": "string",
"idMarca": 0,
"IndicadorVasilhame": "string",
"permiteMultiplicacao": "string",
"indicadorLoteEstoque": "string",
"aliquotaIPI": 0,
"cstPISEntrada": "string",
"cstCOFINSEntrada": "string",
"cstPISSaida": "string",
"cstCOFINSSaida": "string",
"codigoNBMSH": "string",
"cestCodigo": 0,
"impostoImportacaoPercentual": 0,
"indicadorReceita": "string",
"indicadorSimilar": "string",
"indicadorReplicacao": "string",
"tipoReceita": 0,
"indTributacaoPisCofins": "string",
"SituacaoSimplesPISCOFINS": "string",
"embalagem": [
{
"QtdEmbalagem": 0,
"SiglaEmbalagem": "string",
"PesoBruto": 0,
"PesoLiquido": 0,
"Altura": 0,
"Largura": 0,
"Profundidade": 0,
"Status": "string",
"QtdUnitEmbalagem": 0,
"Pesavel": "string",
"IndicaReplicacao": "string",
"Litros": 0,
"UtilizaEmissaoEtiqLote": "string",
"TipoEmbalagemPreco": "string",
"EmbalagemDecimal": "string"
}
],
"fornecedores": [
{
"cnpj": "string",
"fornecedorPrincipal": "string",
"indReplicacao": "string",
"calculaDescontoSuframaParaPisCofins": "string",
"indCobraIPIReceb": "string",
"indControlaPrincipal": "string"
}
],
"divisoes": [
{
"numeroDivisao": 0,
"embalagemCompraPadrao": 0,
"idComprador": 0,
"numeroTributacao": 0,
"finalidadeFamilia": "string",
"formaAbastecimento": "string",
"fatorAtendimento": 0,
"margemLucro": 0,
"indReplicacao": "string",
"idCategoria": 0
}
]
},
"seqFamilia": 0,
"complemento": "string",
"descricaoCompleta": "string",
"descricaoReduzida": "string",
"indProcessoFabricacao": "string",
"descricaoGenerica": "string",
"codigoANP": 0,
"descricaoANP": "string",
"indPrecoSaldoZero": "string",
"indTemperaturaControleProduto": "string",
"integracaoSistemaCodTributario": "string",
"indReplicacao": "string",
"indEmitiCodTributarioNFE": "string",
"codigos": [
{
"TipoCodigo": "string",
"CNPJFornecedor": "string",
"CPFCNPJCliente": "string",
"SeqRede": 0,
"CodAcessoNum": 0,
"QtdEmbalagem": 0,
"CodigoAcesso": "string",
"IndUtilVenda": "string",
"IndEANTribNFE": "string",
"IndUtilNFE": "string"
}
],
"imagens": [
{
"descricao": "string",
"imagem": "string",
"urlImagem": "string",
"principal": "string",
"DisposicaoImagem": "string"
}
]
}
Formatos de Resposta (Response Formats)
application/json, text/json, application/xml, text/xml
Status 201 Created:
{
"seqProduto": 0,
"seqFamilia": 0,
"complemento": "string",
"descricaoCompleta": "string",
"descricaoReduzida": "string",
"indProcessoFabricacao": "string",
"descricaoGenerica": "string",
"codigoANP": 0,
"descricaoANP": "string",
"indPrecoSaldoZero": "string",
"indTemperaturaControleProduto": "string",
"indReplicacao": "string",
"indEmitiCodTributarioNFE": "string",
"integracaoSistemaCodTributario": "string",
"usuarioInclusao": "string",
"dataInclusao": "2023-06-06T13:28:16.692Z",
"usuarioAlteracao": "string",
"dataAlteracao": "2023-06-06T13:28:16.692Z"
}
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas