Consultar un cliente por correo electrónico
GET/cliente/email/:email
Consultar un cliente por correo electrónico
Request
Path Parameters
Correo electrónico
Responses
- 200
- 400
- 401
- 404
- 4XX
- 5XX
Cliente encontrado
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [success, fail, error]
Estatus de la petición
Possible values: [200, 400, 401, 404, 500]
Código http de respuesta en el header
Fecha y hora de creación del plan
Tiempo Unix o POSIX
data
object
cliente
object
Possible values: <= 64 characters
Identificador único de cliente
Fecha de creación del objeto
Fecha de última edición
Possible values: non-empty and <= 64 characters
Identificador único de cliente en plataforma del comercio
Fecha y hora de creación del usuario en el comercio
Possible values: >= 3 characters and <= 30 characters
Nombre o nombres del cliente
Possible values: >= 3 characters and <= 30 characters
Apellido paterno del cliente
Possible values: >= 3 characters and <= 30 characters
Apellido materno del cliente
Possible values: [masculino, femenino]
Sexo del cliente
Possible values: <= 250 characters
Correo electrónico del cliente
telefono
object
Possible values: [no_definido, movil, casa, oficina, facturacion, mensajeria, temporal]
De acuerdo al catálogo tipo teléfono
Codigo telefónico de un país
Codigo telefónico de área
Valor opcional, prefijo utilizado por algunos países
Teléfono del cliente
Extensión
Fecha de nacimiento
direccion
object
Fecha de creación del objeto
Possible values: <= 120 characters
Línea de dirección 1
Possible values: <= 120 characters
Línea de dirección 2
Possible values: <= 120 characters
Línea de dirección 3
Possible values: >= 3 characters and <= 10 characters
Código postal
telefono
object
Possible values: [no_definido, movil, casa, oficina, facturacion, mensajeria, temporal]
De acuerdo al catálogo tipo teléfono
Codigo telefónico de un país
Codigo telefónico de área
Valor opcional, prefijo utilizado por algunos países
Teléfono del cliente
Extensión
Possible values: <= 60 characters
Municipio o delegación
Possible values: <= 60 characters
Ciudad
Possible values: >= 3 characters and <= 3 characters
Identificador de estado de tres caracteres de acuerdo al estándar ISO 3166-2
Possible values: >= 3 characters and <= 3 characters
Identificador de país de tres caracteres de acuerdo al estándar ISO 3166-1
Possible values: <= 120 characters
Referencia adicional, ejemplo: nombre de entre calle 1
Possible values: <= 120 characters
Referencia adicional, ejemplo: nombre de entre calle 2
Possible values: >= -90 and <= 90
Coordenadas de longitud de localización del domicilio
Possible values: >= -90 and <= 90
Coordenadas de latitud de localización del domicilio
Possible values: [activo, inactivo, suspendido]
Estado del Cliente
{
"status": "success",
"http_code": 200,
"datetime": "2024-05-22T21:56:52.897Z",
"timestamp": 0,
"data": {
"cliente": {
"id": "176f76a82670428898001dd5f031a57e",
"creacion": "2024-05-22T21:56:52.897Z",
"actualizacion": "2024-05-22T21:56:52.897Z",
"id_externo": "string",
"creacion_externa": "2024-05-22T21:56:52.897Z",
"nombre": "string",
"apellido_paterno": "string",
"apellido_materno": "string",
"sexo": "masculino",
"email": "usuario@t1pagos.com",
"telefono": {
"tipo": "no_definido",
"codigo_pais": "string",
"codigo_area": "string",
"prefijo": "string",
"numero": "5566778899",
"extension": 0
},
"nacimiento": "2024-05-22T21:56:52.897Z",
"direccion": {
"creacion": "2024-05-22T21:56:52.897Z",
"linea1": "string",
"linea2": "string",
"linea3": "string",
"cp": "string",
"telefono": {
"tipo": "no_definido",
"codigo_pais": "string",
"codigo_area": "string",
"prefijo": "string",
"numero": "5566778899",
"extension": 0
},
"municipio": "string",
"ciudad": "string",
"estado": "string",
"pais": "string",
"referencia_1": "string",
"referencia_2": "string",
"longitud": 0,
"latitud": 0
},
"estado": "activo"
}
}
}
Error en petición
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [error, fail]
Estatus de la petición
error
object
Código http de respuesta en el header
Fecha y hora de creación.
Tiempo Unix o POSIX
Datos del error obtenido, sólo estará presente en errores HTTP 400
{
"status": "error",
"error": {
"code": 0,
"type": "string",
"message": "string"
},
"http_code": 0,
"datetime": "2024-05-22T21:56:52.898Z",
"timestamp": 0,
"data": {}
}
No autorizado
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [error, fail]
Estatus de la petición
error
object
Código http de respuesta en el header
Fecha y hora de creación.
Tiempo Unix o POSIX
Datos del error obtenido, sólo estará presente en errores HTTP 400
{
"status": "error",
"error": {
"code": 0,
"type": "string",
"message": "string"
},
"http_code": 0,
"datetime": "2024-05-22T21:56:52.898Z",
"timestamp": 0,
"data": {}
}
No se ha encontrado el recurso solicitado
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [error, fail]
Estatus de la petición
error
object
Código http de respuesta en el header
Fecha y hora de creación.
Tiempo Unix o POSIX
Datos del error obtenido, sólo estará presente en errores HTTP 400
{
"status": "error",
"error": {
"code": 0,
"type": "string",
"message": "string"
},
"http_code": 0,
"datetime": "2024-05-22T21:56:52.898Z",
"timestamp": 0,
"data": {}
}
Error en petición
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [error, fail]
Estatus de la petición
error
object
Código http de respuesta en el header
Fecha y hora de creación.
Tiempo Unix o POSIX
Datos del error obtenido, sólo estará presente en errores HTTP 400
{
"status": "error",
"error": {
"code": 0,
"type": "string",
"message": "string"
},
"http_code": 0,
"datetime": "2024-05-22T21:56:52.898Z",
"timestamp": 0,
"data": {}
}
Error interno
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [error, fail]
Estatus de la petición
error
object
Código http de respuesta en el header
Fecha y hora de creación.
Tiempo Unix o POSIX
Datos del error obtenido, sólo estará presente en errores HTTP 400
{
"status": "error",
"error": {
"code": 0,
"type": "string",
"message": "string"
},
"http_code": 0,
"datetime": "2024-05-22T21:56:52.898Z",
"timestamp": 0,
"data": {}
}