Produto | Códigos de Acesso do Produto (Consultar) - GET

Objetivo

A finalidade deste método é possibilitar a consulta do código de acesso dos produtos.

Chamada

GET [URLAPI]/SMProdutosAPI/api/v4/produtos/codigos-acesso-prod

Permissionamento

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)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
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.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.somenteInativos	Traz somente os códigos de acesso inativos. Se não informado, traz somente os código de acesso ativos. Valores: S – Traz somente os inativos; N – Traz somente os ativos	String	Atenção! Se informado ‘S’ o unico outro parametro aceito será [DataAtualizacao].
modelo._pageNo		Integer	Não há
modelo._pageSize		Integer	Não há

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
CodigosAcessos	Lista de principios ativos	Array of objects (CodigosAcessoProdCodAcessoRespostaDTO)	Não há
CodigoAcesso	Código de acesso principal	String	Pertence ao array CodigosAcessos
TipoCodigo	Tipo do código de acesso (B – Código Interno / D – DUN / E – EAN / F – Fornecedor / I – Transição)	String	Pertence ao array CodigosAcessos
QtdEmbalagem	Quantidade da embalagem vinculada ao código	Integer	Pertence ao array CodigosAcessos
Status	Status do código de acesso: A – Ativo / I – Inativo	String	Pertence ao array CodigosAcessos
DataExclusao	Data/Hora da exclusão do código de acesso. Nulo se o código ainda estiver ativo.	String	Pertence ao array CodigosAcessos
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á

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

{
  "CodigosAcessos": [
    {
      "CodigoAcesso": "string",
      "TipoCodigo": "string",
      "QtdEmbalagem": 0,
      "Status": "string",
      "DataExclusao": "2020-06-30T11:53:05Z"
    }
  ],
  "CodigoAcessoPrincipal": "string",
  "IdProduto": 0,
  "IdFamilia": 0,
  "IdProdutoBase": 0,
  "DataUltimaAtualizacao": "2020-06-30T11:53:05Z"
}

Árvore de páginas