A finalidade deste método é possibilitar a consulta a dados cadastrais básicos de produtos por empresas.
GET [URLAPI]/SMProdutosAPI/api/v4/produtos/produtos-empresa
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.CNPJEmpresa | CNPJ da empresa utilizada como filtro de informações, sem traços ou pontos. Formato: 00000000000000 | string | Não há |
| modelo.segmento | Número do segmento de venda específico para busca de algumas informações. Quando não informado, considera-se o segmento principal da empresa. | Integer | Não há |
| modelo.statusVenda | Filtro de retorno dos produtos: A = ativo (devolve apenas produtos ativos para venda) I = inativo(devolve apenas produtos inativos para venda) S = suspenso(devolve apenas produtos suspensos para venda) T = todos(Retorna todos os produtos) Padrão: A | string | Não há |
| modelo.idCategoria | Código sequencial do cadastro de categoria. | Integer | Não há |
| modelo.codigoAcesso | Códigos de acessos associados ao produto (GTIN, Interno, Fornecedor) | string | 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.descricaoProduto | Descrição cadastrada para o produto | string | Não há |
| modelo.indicaUsaAFV | Indica se usa AFV | String | Não há. |
| modelo.descricaoFamilia | 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 | 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 | Quando informado IdFornecedor, a busca também irá considerar o código de acesso do tipo Fornecedor (F). |
| 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) |
| NumeroEmpresa | Número da empresa | Integer | Não há |
| UFEmpresa | UF da empresa | String | Não há |
| NumeroDivisao | Número da divisão da empresa | Integer | Não há |
| EmbalagemVenda | Embalagem padrão de venda (caixa fechada) | String | Não há |
| QtdeEmbVenda | Quantidade da embalagem padrão de compra | number <double> | Não há |
| EmbalagemCompra | Embalagem padrão de compra (caixa fechada) | String | Não há |
| QtdeEmbCompra | Quantidade da embalagem padrão de compra | number <double> | Não há |
| StatusCompra | Status de compra do produto na empresa (ativo, inativo ou suspenso) | String | Não há |
| StatusVenda | Status de venda do produto na empresa (ativo, inativo) | String | Não há |
| Comprador | Apelido do comprador | String | 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á |
application/json, text/json
Exemplo (Sample):
{
"NumeroEmpresa": 0,
"UFEmpresa": "string",
"NumeroDivisao": 0,
"EmbalagemVenda": "string",
"QtdeEmbVenda": 0,
"EmbalagemCompra": "string",
"QtdeEmbCompra": 0,
"StatusCompra": "string",
"StatusVenda": "string",
"Comprador": "string",
"CodigoAcessoPrincipal": "string",
"IdProduto": 0,
"IdFamilia": 0,
"IdProdutoBase": 0,
"DataUltimaAtualizacao": "2020-06-30T11:53:05Z"
}