Exibir origem

Objetivo

Método de consulta que retorna informações de uma lista de compradores.

Chamada

GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/Comprador

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 Cadastros Estruturais > API Cadastros Estruturais

Home TOTVS Varejo Supermercados > Consultar comprador - GET > image-2026-1-30_17-35-25.png

Imagem 01 - Configurações de Sistemas/Módulos/Aplicações

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
IdComprador	Lista de ids de compradores	array[integer]	Não há.
NomeComprador	Nome do comprador	string	Não há.
Apelido	Apelido do comprador	string	Não há.
Status	Status da empresa	string	Opções: A - Ativo e I - Inativo. Não passando valor, retornará todos os status.
Fields	Campos que devem retornar	string	Não há.
Order	Campo para ordenação	string	Não há.
Page	Páginas	integer($int32)	Não há.
PageSize	Tamanho das páginas	integer($int32)	Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

OK (200)
BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
  "hasNext": true,
  "items": [
    {
      "idComprador": 0,
      "nomeComprador": "string",
      "apelido": "string",
      "status": "string",
      "idPessoa": 0
    }
  ]
}

application/json, text/json

CODE 400 - BAD

{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}