Obtener clientes


GET {env}/1/customers

Método utilizado para obtener los clientes de una tienda en particular.

Headers


{
  "Authorization": "Bearer {access_token}",
  "X-Shop-Id": "12345"
}

Parámetro	Tipo	Requerido	Valores aceptados	Descripción
`Authorization`	string	Si	`Bearer` + access_token	Token obtenido mediante client_id y client_secret.
`X-Shop-Id`	string	Si	String numérico	Identificador único de la tienda a la cual se desea obtener sus clientes.

Query params

Nombre	Tipo	Opcional	Descripción
`page`	int	No	Número de página a recuperar. La primer página es 0.
`size`	int	Si	Cantidad de elementos por página. El valor mínimo es 1 y el valor máximo es 200. En caso de no enviarse, por defecto el valor para `size` será 15.
`wholesaler`	int	Si	Permite buscar clientes por tipo. Valores posibles: 0 (cliente minorista), 1 (cliente mayorista), -1 (mayorista solicitud enviada).
`search`	string	Si	Permite buscar clientes por email, teléfono, número de identificación, nombre o apellido. Debe cumplir con el regex: `/^[a-zá-úÁ-Úä-üÄ-ÜA-Z0-9\s\.\-\_\'\@\&]{0,100}$/`.
`banned`	int	Si	Permite buscar clientes según su estado. Valores posibles: 0 (cliente no bloqueado), 1 (cliente bloqueado).
`exported`	int	Si	Permite buscar clientes que fueron o no exportados. Valores posibles: 0 (cliente no exportado), 1 (cliente exportado).
`marketing`	int	Si	Permite buscar clientes de acuerdo a si aceptan o no recibir ofertas de marketing. Valores posibles: 0 (no desea recibir ofertas), 1 (desea recibir ofertas).
`registered`	int	Si	Permite buscar clientes de acuerdo a si completó el registro. Valores posibles: 0 (no registrado), 1 (registrado).

Response exitosa: 200 Ok

En caso de que la tienda no cuente con clientes:

[]

En caso de que la tienda tenga clientes:


[
  {
    "id": "customer-29525",
    "email": "usuario@example.com",
    "wholesaler": 1,
    "name": "Juan",
    "surname": "Pérez",
    "phone": "5491100000000",
    "identification_type": "DNI",
    "identification": "12345678",
    "street": "Calle Falsa",
    "street_number": "123",
    "floor": null,
    "apartment": null,
    "city": "Rosario",
    "state": "SANTA FE",
    "country": null,
    "marketing": 1,
    "exported": 0,
    "banned": 0,
    "registered": 1
  }
]

Campos de la respuesta

Atributo	Tipo	Descripción
`id`	string	Corresponde al identificador único e irrepetible de cada cliente.
`email`	string	Corresponde al email del cliente.
`wholesaler`	string	Indica el tipo de cliente.
`name`	string	Corresponde al nombre del cliente. Puede ser null.
`surname`	string	Corresponde al apellido del cliente. Puede ser null.
`phone`	string	Corresponde al teléfono del cliente. Puede ser null.
`identification_type`	string	Corresponde al tipo de documento del cliente. Puede ser null.
`identification`	string	Corresponde al número de identificación o documento del cliente. Puede ser null.
`street`	string	Corresponde a la calle del cliente. Puede ser null.
`street_number`	string	Corresponde al número de calle del cliente. Puede ser null.
`floor`	string	Corresponde al piso del cliente. Puede ser null.
`apartment`	string	Corresponde al departamento del cliente. Puede ser null.
`city`	string	Corresponde a la localidad/ciudad del cliente. Puede ser null.
`state`	string	Corresponde a la provincia del cliente. Puede ser null.
`country`	string	Corresponde al país del cliente. Puede ser null.
`marketing`	int	Indica la preferencia a recibir ofertas del cliente.
`exported`	int	Indica si el cliente fue o no exportado desde el panel.
`banned`	int	Indica si el cliente fue o no bloqueado.
`registered`	int	Indica el estado del registro del cliente.

Responses de error

En caso de que la respuesta http no sea 200, entonces se debe considerar haber obtenido una respuesta de error.

Atributo	Tipo	Descripción
`status`	int	Http code de respuesta.
`code`	string	Código de error, indica la naturaleza del mismo.
`msg`	string	Mensaje de error.

Ejemplo response 401 Unauthorized:


{
  "status": 401,
  "code": "error",
  "msg": "Unauthorized"
}

Ejemplo response 400 Bad Request genérico:


{
  "status": 400,
  "code": "request_error",
  "msg": "Send valid data"
}

Ejemplo response 400 Bad Request si algún parámetro de entrada requerido no es enviado:


{
  "status": 400,
  "code": "param_required",
  "msg": "invalid <param_name>. The value is required"
}

Ejemplo response 400 Bad Request si algún parámetro de entrada es inválido:


{
  "status": 400,
  "code": "param_invalid",
  "msg": "Invalid <param_name>. The value is invalid"
}

Ejemplo response 500 Internal Server Error:


{
  "status": 500,
  "code": "server_error",
  "msg": "Something went wrong"
}