# Customers

Obtén los datos de tus clientes

Endpoint: GET /retailers/api/v1/customers
Version: 1.0.0
Security: api-key

## Query parameters:

  - `page` (number)
    Busca la página específica de clientes
    Example: 1

  - `start_date` (string)
    Fecha inicial de búsqueda en formato YYYY-MM-DD
    Example: "2024-01-01"

  - `end_date` (string)
    Fecha final de búsqueda en formato YYYY-MM-DD
    Example: "2024-12-31"

  - `id_type` (string)
    Especifica el tipo de documento a buscar
    Enum: "cedula", "pasaporte", "ruc", "rut", "otro"

  - `id_number` (string)
    Número de documento a buscar
    Example: "1234567890"

  - `platform` (string)
    Plataforma de interacción
    Enum: "whatsapp", "messenger", "instagram"

  - `order_by_last_interaction` (string)
    Ordena los clientes por la última interacción según la plataforma
    Enum: "asc", "desc"

## Response 200 fields (application/json):

  - `results` (integer)
    Número total de resultados
    Example: 1

  - `total_pages` (integer)
    Número total de páginas
    Example: 1

  - `customers` (array)
    Lista de clientes

  - `customers.id` (integer)
    ID interno del cliente
    Example: 12345

  - `customers.first_name` (string)
    Nombre del cliente
    Example: "Juan"

  - `customers.last_name` (string)
    Apellido del cliente
    Example: "Pérez"

  - `customers.email` (string)
    Correo electrónico del cliente
    Example: "juan@example.com"

  - `customers.phone` (string)
    Teléfono del cliente en formato internacional
    Example: "+593999999999"

  - `customers.id_type` (string)
    Tipo de documento de identidad
    Enum: "cedula", "pasaporte", "ruc", "rut", "otro"

  - `customers.id_number` (string)
    Número de documento de identidad
    Example: "1234567890"

  - `customers.address` (string)
    Dirección del cliente
    Example: "Av. Principal 123"

  - `customers.city` (string)
    Ciudad del cliente
    Example: "Quito"

  - `customers.state` (string)
    Estado/Provincia del cliente
    Example: "Pichincha"

  - `customers.zip_code` (string)
    Código postal
    Example: "170101"

  - `customers.notes` (string)
    Notas adicionales del cliente
    Example: "Cliente preferencial"

  - `customers.created_at` (string)
    Fecha de creación del cliente
    Example: "2024-01-15T10:30:00.000Z"

  - `customers.updated_at` (string)
    Fecha de última actualización
    Example: "2024-01-20T15:45:00.000Z"

## Response 400 fields (application/json):

  - `message` (string)
    Example: "Bad Request"