Marca (Consultar) - GET

Objetivo

A finalidade deste método é possibilitar a consulta de marca.

Chamada

GET [URLAPI]/SMProdutosAPI/api/v4/marcas/marca

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.idMarca	Código sequencial do cadastro da marca.	long	Não há.
modelo.descricaoMarca	Descrição da Marca.	string	Tamanho máximo de 20 caracteres.
modelo.tipoMarca	Tipo da Marca.	string	Tamanho máximo de 5 caracteres.
modelo.statusMarca	Status da Marca.	string	Tamanho máximo de 1 caractere. Valores possíveis: A = Ativo; I = Inativo
modelo.totalizaEmissaoPedidoVenda	Participa de totalização na emissão do Pedido de Venda	string	Tamanho máximo de 1 caractere. Valores possíveis: S= Sim; N = Não
modelo.dataUltimaAtualizacao	Data da ultima atualização da Marca	string	Formato: YYYY-MM-DDThh:mm:ss
modelo._pageNo		Integer	Não há
modelo._pageSize		Integer	Não há

Parâmetros do Corpo (Body Parameters)

Não há.

Formatos de Resposta (Response Formats)

application/json, text/json, application/xml, text/xml

Status 200 - Ok

{
  "IdMarca": 0,
  "DescricaoMarca": "string",
  "TipoMarca": "string",
  "StatusMarca": "string",
  "TotalizaEmissaoPedidoVenda": "string",
  "TituloECommerce": "string",
  "DescricaoECommerce": "string",
  "PalavraChaveECommerce": "string"
}

Árvore de páginas