Skip to main content

Consultar listado de Clientes

GET 
/cliente

Consultar listado de Clientes

Request​

Query Parameters

    registros_por_pagina integer

    Possible values: >= 5 and <= 100

    Default value: 25

    Máximo de registros a regresar

    pagina integer

    Número de página

    ordenar_por string

    Possible values: [actualizacion, apellido_materno, apellido_paterno, creacion, email, estado, id, nacimiento, nombre, sexo]

    Valor que será usado como referencia en la búsqueda, podrá ser "creacion" o "email"

    orden string

    Possible values: [asc, desc]

    Podrá ser de orden Ascendente (asc) o Descendente (desc)

Responses​

Listado de objetos tipo Cliente

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

    clientes

    object

    Arreglo de objetos tipo Cliente

    data

    object[]

  • Array [

    • 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

  • ]

    • desde integer

    Índice de inicio

    hasta integer

    Índice de fin

    registros_por_pagina integer

    Possible values: >= 5 and <= 100

    Default value: 10

    Número de registros por página

    pagina_actual integer

    Possible values: >= 1

    Página actual de registros

    ultima_pagina integer

    Possible values: >= 1

    Número de última página

    total_pagina integer

    Total de registros

    total integer

    Total de registros

Loading...