Usuários VMmarket

Listar

GET /api/v1/market_users?access_token=token-de-acesso

Filtros

Os parâmetros abaixo podem ser passados como uma query string. Mais de um filtro pode ser passado na mesma consulta. Este serviço suporta paginação.

created_at: data de criação do usuário no VmMarket.

created_at_start_date:
- Data e hora inicial do período.
- Formatos suportados: dd/mm/yyyy hh:mi:ss ou ISO 8601.
created_at_end_date:
- Data e hora final do período.
- Formatos suportados: dd/mm/yyyy hh:mi:ss ou ISO 8601.

Caso o formato da data seja inválido, é retornado erro com o código HTTP 400 (bad request).

Exemplo de filtro por data de criação:

GET /api/v1/market_users?created_at_start_date=2022-01-01 01:45:00&created_at_end_date=2022-01-01 02:45:00

updated_at: data de atualização do usuário no VmMarket.

updated_at_start_date:
- Data e hora inicial do período.
- Formatos suportados: dd/mm/yyyy hh:mi:ss ou ISO 8601.
updated_at_end_date:
- Data e hora final do período.
- Formatos suportados: dd/mm/yyyy hh:mi:ss ou ISO 8601.

Caso o formato da data seja inválido, é retornado erro com o código HTTP 400 (bad request).

Exemplos de filtro por data de atualização:

GET /api/v1/market_users?updated_at_start_date=2024-04-01 01:45:00&updated_at_end_date=2024-08-31 04:45:00

Filtro por cpf:

cpf: CPF dos usuários de mercado.
- Se passado, a consulta retorna somente usuários de mercado cujo CPF contém o valor informado.

Ordenação de Colunas

Os campos a seguir podem ser utilizados para ordenar os resultados. Para ordenar, você deve fornecer o parâmetro sort_column e sort_direction.

sort_column: Especifica a coluna pela qual os resultados devem ser ordenados.
sort_direction: Especifica a direção da ordenação. Pode ser ASC (ascendente) ou DESC (descendente).

Campos Disponíveis para Ordenação

created_at: Data e hora de criação do registro.
updated_at: Data e hora da última atualização do registro.

Exemplo de Requisição

Aqui está um exemplo de como usar os parâmetros para ordenar os resultados:

GET /api/v1/market_users?sort_column=created_at&sort_direction=DESC

Neste exemplo, os resultados serão ordenados pela coluna created_at em ordem decrescente.

Notas

Se sort_direction não for especificado, o padrão é ASC.
Certifique-se de que o sort_column fornecido esteja na lista de campos disponíveis para ordenação.

Retorno

É retornado um JSON contendo um array com objetos que correspondem aos usuários do mercado. O array é ordenado por data e hora de criação, da mais recente para a mais antiga. Os campos de cada transação cashless são os seguintes:

id: Identificador único do usuário. (Tipo: Inteiro)
created_at: Data e hora em que o registro do usuário foi criado. (Formato: ISO 8601)
name: Nome do usuário. (Tipo: Texto)
email: Email registrado do usuário. (Tipo: Texto)
cpf: CPF do usuário. (Formato: Texto, anonimizado se não houver acesso total)
born_on: Data de nascimento do usuário. (Formato: ISO 8601)
phone: Número de telefone do usuário. (Formato: Texto, anonimizado se não houver acesso total)
market_user_genre: Gênero do usuário. (Tipo: Texto)
- Indefinido
- Masculino
- Feminino

Campos liberados apenas com permissão para acessar todos os operadores

operator: objeto do tipo Operator com os campos:
- id: Identificador único do operador associado ao usuário. (Tipo: Inteiro)
- name: Nome do operador vinculado ao usuário. (Tipo: Texto)
- label: Label do operador. (Tipo: Texto)
- cnpj: CNPJ do operador. (Tipo: Texto)
updated_at: Data e hora da última atualização dos dados do usuário. (Formato: ISO 8601)
market_user_banned: Retorna se o usuário foi banido. (Tipo: Texto)
market_user_banned_at: Data e hora de banimento do usuário. (Formato: ISO 8601) * Sim * Não
pre_deleted_at: Data e hora em que o usuário foi marcado para exclusão. (Formato: ISO 8601)
deleted_at: Data e hora em que o usuário foi excluído. (Formato: ISO 8601)

Segue um exemplo de retorno de consulta, caso o usuário tenha acesso total entre operadores:

[
  {
    "id": 405,
    "created_at": "2023-09-06T13:21:25.000Z",
    "updated_at": "2024-10-15T14:55:13.000Z",
    "email": "email100@email.com.br",
    "name": "Nome do Usuário",
    "pre_deleted_at": null,
    "deleted_at": null,
    "market_user_banned": "Sim - 2023-02-03 11:46:54 UTC",
    "market_user_banned_at": "2023-02-03T11:46:54.000Z",
    "operator": {
        "id": 147,
        "name": "Nutricar",
        "label": "nutricar",
        "cnpj": "21590391000111"
    },
    "born_on": "1980-09-06",
    "cpf": "12345678900",
    "phone": "41992829415"
   }
]

Segue um exemplo de retorno de consulta, caso o usuário tenha acesso restrito:

[
  {
    "id": 405,
    "created_at": "2023-09-06T13:21:25.000Z",
    "name": "Nome do Usuário",
    "email": "email100@email.com.br",
    "cpf": "036*******8",
    "born_on": "19*******9",
    "phone": "**992*****5",
    "market_user_genre": "Indefinido"
  }
]