A finalidade deste método é possibilitar a consulta a dados cadastrais básicos de produtos.
GET [URLAPI]/SMProdutosAPI/api/v4/produtos/dados-cadastrais
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
Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.
Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) | |
modelo.codigoAcesso | Códigos de acessos associados ao produto (GTIN, Interno, Fornecedor) | String | Não há | Quando não informado o IdFornecedor, a busca irá se basear apenas nos tipos de códigos de acesso: EAN, DUN e Interno (E, D e B). |
modelo.descricao | Descrição do produto | String | Não há | |
modelo.familia | Descrição da família do produto | String | Não há | |
modelo.dataAtualizacao | Data da ultima atualização Formato: YYYY-MM-DDThh:mm:ss | String | Não há | Quando informada a dataAtualizacao serão filtrados os registros que tiveram alteração a partir desta data. |
modelo.idFamilia | Código sequencial do cadastro de família do produto | Integer | Não há | |
modelo.idProduto | Código sequencial do cadastro do produto | Integer | Não há | |
modelo.idFornecedor | Código sequencial do cadastro de fornecedor | Integer | Não há | Quando informado IdFornecedor, a busca também irá considerar o código de acesso do tipo Fornecedor (F). |
modelo.statusVenda | Status da Venda | String | Não há | |
modelo._pageNo | Integer | Não há | ||
modelo._pageSize | Integer | Não há |
Não há.
Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
DtaInclusao | Data de inclusão | String | Não há |
DescricaoCompleta | Descrição Completa | String | Não há |
DescricaoGenerica | Descrição Genérica | String | Não há |
DescricaoReduzida | Descrição Reduzida | String | Não há |
DescricaoComposicao | Descrição da composição do produto (Produto com fabricação própria) | String | Não há |
DetalhesProduto | Especificação detalhada | String | Não há |
ReferenciaFabricante | Referência do fabricante | String | Não há |
DescricaoFamilia | Descrição da familia do produto | String | Não há |
ValidadeDias | Nro. de dias de validade | Integer | Não há |
ValidadeMes | Nro. de meses de validade | Integer | Não há |
NroDiasValidadeDeRecebto | Nro de dias de validade a partir do recebimento | Integer | Não há |
ProcessoFabricacao | Processo de fabricação: P – Produto final de receita. S – Sem Processo de Produção B – Produto base para desmembramento F – Produto final composto V – Produto de composição variavel I – Insumo para Produção C – Composto para Separação M – Movimentação Automática(MA) | String | Não há |
PermiteDecimal | Indica se permite quantidade em decimal S – Sim N – Não | String | Não há |
Pesavel | Indica se o produto é pesável S – Sim N – Não | String | Não há |
UrlEcommerce | URL do produto no e-commerce da rede. | String | Não há |
IntegraEcommerce | Indica se integra com o E-Commerce. S – Sim N – Não | String | Não há |
MultiploVendaEcommerce | Multiplo de venda do E-Commerce | Integer | Não há |
IdFornecedorPrinc | Código do fornecedor principal | Integer | Não há |
IdMarca | Código da marca | Integer | Não há |
DescricaoMarca | Descrição da marca | String | Não há |
StatusVenda | Status de Venda do Produto | String | Não há |
PrincipiosAtivos | Lista de princípios ativos | Array of objects (PrincipioAtivoRespostaDTO) | Não há |
CodigoAcessoPrincipal | Código de acesso principal | String | Não há |
IdProduto | Código sequencial do cadastro do produto | Integer | Não há |
IdFamilia | Código sequencial do cadastro da família do produto | Integer | Não há |
IdProdutoBase | Código sequencial do cadastro do produto base | Integer | Não há |
DataUltimaAtualizacao | Data da ultima atualização | String | Não há |
RetornoCustumizados | Coluna especial para customizações | Dynamic | Possui valor apenas em clientes com customização da API de Produtos |
application/json, text/json
...
Bloco de código | ||
---|---|---|
| ||
{
"DtaInclusao": "2021-05-17T12:02:51.889Z",
"DescricaoCompleta": "string",
"DescricaoGenerica": "string",
"DescricaoReduzida": "string",
"DescricaoComposicao": "string",
"DetalhesProduto": "string",
"ReferenciaFabricante": "string",
"DescricaoFamilia": "string",
"ValidadeDias": 0,
"ValidadeMes": 0,
"NroDiasValidadeDeRecebto": 0,
"ProcessoFabricacao": "string",
"PermiteDecimal": "string",
"Pesavel": "string",
"UrlEcommerce": "string",
"IntegraEcommerce": "string",
"MultiploVendaEcommerce": 0,
"IdFornecedorPrinc": 0,
"IdMarca": 0,
"DescricaoMarca": "string",
"StatusVenda": "string",
"PrincipiosAtivos": [
{
"IdPrincipioAtivo": 0,
"DescPrincipioAtivo": "string"
}
],
"RetornoCustumizados": {},
"CodigoAcessoPrincipal": "string",
"IdProduto": 0,
"IdFamilia": 0,
"IdProdutoBase": 0,
"DataUltimaAtualizacao": "2021-05-17T12:02:51.889Z"
} |