Crear un Cliente

POST 
/cliente

Crear un Cliente

Request

application/json

Body

Crear nuevo cliente

id_externo stringrequired

Identificador de cliente en plataforma del comercio, NO es recomendable usar un email como identificador único ya que un cliente podrá cambiar su correo, en caso de que un cliente actualice su correo, podrá editarse el correo electrónico del cliente. El id_externo no podrá editarse una vez creado el cliente.

nombre string

Nombre o nombres del cliente

apellido_paterno string

Apellido paterno del cliente

apellido_materno string

Apellido materno del cliente

sexo string

Sexo del cliente (masculino/femenino)

email emailrequired

email del cliente

telefono

object

tipo string

Possible values: [no_definido, movil, casa, oficina, facturacion, mensajeria, temporal]

De acuerdo al catálogo tipo teléfono

codigo_pais string

Codigo telefónico de un país

codigo_area string

Codigo telefónico de área

prefijo string

Valor opcional, prefijo utilizado por algunos países

numero number

Teléfono del cliente

extension number

Extensión

nacimiento date-time

Fecha de nacimiento

direccion

object

linea1 string

Possible values: <= 120 characters

Línea de dirección 1

linea2 string

Possible values: <= 120 characters

Línea de dirección 2

linea3 string

Possible values: <= 120 characters

Línea de dirección 3

cp string

Possible values: >= 3 characters and <= 10 characters

Código postal

telefono

object

tipo string

Possible values: [no_definido, movil, casa, oficina, facturacion, mensajeria, temporal]

De acuerdo al catálogo tipo teléfono

codigo_pais string

Codigo telefónico de un país

codigo_area string

Codigo telefónico de área

prefijo string

Valor opcional, prefijo utilizado por algunos países

numero number

Teléfono del cliente

extension number

Extensión

municipio string

Possible values: <= 60 characters

Municipio o delegación

ciudad string

Possible values: <= 60 characters

Ciudad

estado string

Possible values: >= 3 characters and <= 3 characters

Identificador de estado de tres caracteres de acuerdo al estándar ISO 3166-2

pais string

Possible values: >= 3 characters and <= 3 characters

Identificador de país de tres caracteres de acuerdo al estándar ISO 3166-1

referencia_1 string

Possible values: <= 120 characters

Referencia adicional, ejemplo: nombre de entre calle 1

referencia_2 string

Possible values: <= 120 characters

Referencia adicional, ejemplo: nombre de entre calle 2

longitud number

Possible values: >= -90 and <= 90

Coordenadas de longitud de localización del domicilio

latitud number

Possible values: >= -90 and <= 90

Coordenadas de latitud de localización del domicilio

creacion_externa date-time

Fecha y hora de creación del usuario en el comercio

device_fingerprint string

Id de dispositivo de cliente

Responses

200

Cliente creado exitosamente

application/json

Schema

Schema

status string

Possible values: [success, fail, error]

Estatus de la petición

http_code integer

Possible values: [200, 400, 401, 404, 500]

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación del plan

timestamp integer

Tiempo Unix o POSIX

data

object

cliente

object

id string

Possible values: <= 64 characters

Identificador único de cliente

creacion date-time

Fecha de creación del objeto

actualizacion date-time

Fecha de última edición

id_externo string

Possible values: non-empty and <= 64 characters

Identificador único de cliente en plataforma del comercio

creacion_externa date-time

Fecha y hora de creación del usuario en el comercio

nombre string

Possible values: >= 3 characters and <= 30 characters

Nombre o nombres del cliente

apellido_paterno string

Possible values: >= 3 characters and <= 30 characters

Apellido paterno del cliente

apellido_materno string

Possible values: >= 3 characters and <= 30 characters

Apellido materno del cliente

sexo string

Possible values: [masculino, femenino]

Sexo del cliente

email emailrequired

Possible values: <= 250 characters

Correo electrónico del cliente

telefono

object

tipo string

Possible values: [no_definido, movil, casa, oficina, facturacion, mensajeria, temporal]

De acuerdo al catálogo tipo teléfono

codigo_pais string

Codigo telefónico de un país

codigo_area string

Codigo telefónico de área

prefijo string

Valor opcional, prefijo utilizado por algunos países

numero number

Teléfono del cliente

extension number

Extensión

nacimiento date-time

Fecha de nacimiento

direccion

object

creacion date-time

Fecha de creación del objeto

linea1 string

Possible values: <= 120 characters

Línea de dirección 1

linea2 string

Possible values: <= 120 characters

Línea de dirección 2

linea3 string

Possible values: <= 120 characters

Línea de dirección 3

cp string

Possible values: >= 3 characters and <= 10 characters

Código postal

telefono

object

tipo string

Possible values: [no_definido, movil, casa, oficina, facturacion, mensajeria, temporal]

De acuerdo al catálogo tipo teléfono

codigo_pais string

Codigo telefónico de un país

codigo_area string

Codigo telefónico de área

prefijo string

Valor opcional, prefijo utilizado por algunos países

numero number

Teléfono del cliente

extension number

Extensión

municipio string

Possible values: <= 60 characters

Municipio o delegación

ciudad string

Possible values: <= 60 characters

Ciudad

estado string

Possible values: >= 3 characters and <= 3 characters

Identificador de estado de tres caracteres de acuerdo al estándar ISO 3166-2

pais string

Possible values: >= 3 characters and <= 3 characters

Identificador de país de tres caracteres de acuerdo al estándar ISO 3166-1

referencia_1 string

Possible values: <= 120 characters

Referencia adicional, ejemplo: nombre de entre calle 1

referencia_2 string

Possible values: <= 120 characters

Referencia adicional, ejemplo: nombre de entre calle 2

longitud number

Possible values: >= -90 and <= 90

Coordenadas de longitud de localización del domicilio

latitud number

Possible values: >= -90 and <= 90

Coordenadas de latitud de localización del domicilio

estado string

Possible values: [activo, inactivo, suspendido]

Estado del Cliente

Example (from schema)

{
  "status": "success",
  "http_code": 200,
  "datetime": "2024-05-22T21:56:52.858Z",
  "timestamp": 0,
  "data": {
    "cliente": {
      "id": "176f76a82670428898001dd5f031a57e",
      "creacion": "2024-05-22T21:56:52.858Z",
      "actualizacion": "2024-05-22T21:56:52.858Z",
      "id_externo": "string",
      "creacion_externa": "2024-05-22T21:56:52.858Z",
      "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.858Z",
      "direccion": {
        "creacion": "2024-05-22T21:56:52.858Z",
        "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"
    }
  }
}

400

Error en petición

application/json

Schema

Schema

status string

Possible values: [error, fail]

Estatus de la petición

error

object

code integer

type string

message string
http_code integer

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación.

timestamp integer

Tiempo Unix o POSIX

data object

Datos del error obtenido, sólo estará presente en errores HTTP 400

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "type": "string",
    "message": "string"
  },
  "http_code": 0,
  "datetime": "2024-05-22T21:56:52.859Z",
  "timestamp": 0,
  "data": {}
}

401

No autorizado

application/json

Schema

Schema

status string

Possible values: [error, fail]

Estatus de la petición

error

object

code integer

type string

message string
http_code integer

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación.

timestamp integer

Tiempo Unix o POSIX

data object

Datos del error obtenido, sólo estará presente en errores HTTP 400

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "type": "string",
    "message": "string"
  },
  "http_code": 0,
  "datetime": "2024-05-22T21:56:52.859Z",
  "timestamp": 0,
  "data": {}
}

404

No se ha encontrado el recurso solicitado

application/json

Schema

Schema

status string

Possible values: [error, fail]

Estatus de la petición

error

object

code integer

type string

message string
http_code integer

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación.

timestamp integer

Tiempo Unix o POSIX

data object

Datos del error obtenido, sólo estará presente en errores HTTP 400

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "type": "string",
    "message": "string"
  },
  "http_code": 0,
  "datetime": "2024-05-22T21:56:52.859Z",
  "timestamp": 0,
  "data": {}
}

4XX

Error en petición

application/json

Schema

Schema

status string

Possible values: [error, fail]

Estatus de la petición

error

object

code integer

type string

message string
http_code integer

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación.

timestamp integer

Tiempo Unix o POSIX

data object

Datos del error obtenido, sólo estará presente en errores HTTP 400

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "type": "string",
    "message": "string"
  },
  "http_code": 0,
  "datetime": "2024-05-22T21:56:52.860Z",
  "timestamp": 0,
  "data": {}
}

5XX

Error interno

application/json

Schema

Schema

status string

Possible values: [error, fail]

Estatus de la petición

error

object

code integer

type string

message string
http_code integer

Código http de respuesta en el header

datetime date-time

Fecha y hora de creación.

timestamp integer

Tiempo Unix o POSIX

data object

Datos del error obtenido, sólo estará presente en errores HTTP 400

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "type": "string",
    "message": "string"
  },
  "http_code": 0,
  "datetime": "2024-05-22T21:56:52.860Z",
  "timestamp": 0,
  "data": {}
}

Loading...