Listar Clientes por Estado
GET/api/customers/filter
Su propósito es obtener una lista de clientes filtrada por su estado.
Ejemplo:
- Método: GET
- URL: https://empresa1.demo3pro6.ibu.pe/api/customers/filter?status=active
- TOKEN: HOHYgwd4atPalTxqi2IIspythpLAU7eP239oByfjk9VuveiOpfUTm4Yg0Szt
Request
- application/json
Query Parameters
Parámetros de consulta disponibles
statusstringrequired
posible values: active, inactive
Example:
active
Responses
- 200
- 400
- 404
Lista de clientes obtenida exitosamente
- application/json
- Schema
- Example (from schema)
Schema
successboolean
Example:
true
messagestring
Example:
Clientes encontrados
data object[]
idinteger
Example:
55
descriptionstring
Example:
72346556 - Pedro Diaz
namestring
Example:
Pedro Diaz
numberstring
Example:
72346556
identity_document_type_idstring
Example:
1
addressstring
Example:
Urb Sesquicentenario Vipol Callao
emailstring
Example:
cliente@email.com
telephonestring
Example:
954533737
statusstring
Example:
active
created_atstring
Example:
2023-08-17 10:30:00
ResponseSamples component placeholder
Parámetro de estado inválido
No se encontraron clientes con el estado especificado