Saltar al contenido principal

get-customers

Este método obtiene el listado de clientes que el usuario tiene creados en la plataforma (se utiliza paginación para la consulta ordenada).

Notas

Si necesitas más información sobre cómo funciona la paginación consulta la sección: Paginación.

Los resultados se ordenan de manera descendente por fecha en la que se creo el cliente.

Path del método​

get-customers

Endpoint final​

PRODUCCION

https://aceptabits.com/api/thirdparty/v1/get-customers

SANDBOX DE PRUEBAS

https://sandbox.aceptabits.com/api/thirdparty/v1/get-customers

Método de petición HTTP​

GET

Lista de parámetros​

ParámetroObligatorioDescripciónvalor
pageSiEs la página que se utilizara en la paginación de la peticiónEjemplo:
1, 2, 3, etc.

Este valor debe ser numérico y entero, indicara la página actual a la cual se hará la consulta
limitSiEs el límite de elementos que se utilizara en la paginación de la peticiónEjemplo:
5, 10, 20, 50, etc.

Este valor debe de ser numérico y entero, con un valor máximo posible de 100, si se envía un número mayor a 100 se realizara la consulta con el valor 100
code_shopNoEs el código de la tienda a la que se requiere obtener el listado de clientes en especificoejemplo:
pgbsho0635214789653205

Este código es único de cada tienda, se obtiene al consultar el listado de tiendas o al generar una tienda nueva, consulte los métodos: get-shops, add-shop o show-shop para más detalles
code_agentNoEs el código del agente de ventas al que se requiere obtener el listado de clientes en específicoejemplo:
pgbage9743166351596541

Este código es único de cada agente, se obtiene al consultar el listado de agentes o al generar un agente nuevo, consulte los métodos: get-agents, add-agent o show-agent para mas detalles
searchNoSe utiliza como filtro de búsqueda para la consulta de los clientes, el filtro se aplicara dentro de:

code name lastname phone email code_shop name_shop code_agent name_agent

Para más información de estos campos consulta el metodo add-customer, show-customer o en esta misma sección en Ejemplo de respuesta EXITOSA		Ejemplo:
pgbsho6199, mario, pgbage97431661, juan@mail, etc.

Se puede enviar una cadena de texto, un numero o cualquier valor que se quiera utilizar como filtro

Lista de códigos​

Exitoso
CódigoDescripción
0051Lista de clientes obtenida con éxito

 

Error
CódigoDescripción
0000El Token API no es correcto y la autenticación del usuario ha fallado
0003El Token API no es correcto y la autenticación del usuario ha fallado
1273El Token API no es correcto y la autenticación del usuario ha fallado
1575El campo página de la paginación es requerido
1576El campo límite de la paginación es requerido
1274El Token API no es correcto y la autenticación del usuario ha fallado
1275Ocurrió un problema al obtener el listado de clientes, inténtelo nuevamente o consulte con soporte técnico para más ayuda

Ejemplo de respuesta EXITOSA​

Exitoso

Código HTTP 200


{
    "status": true,
    "success": {
        "code": "0051"
    },
    "data": {        
        "data": [
            {
                "code": "pgbcus56777697528357625",
                "name": "Mario",
                "lastname": "Chavez Alvarez",
                "phone": null,
                "email": "mario.alvarez@mail.com",
                "created_at": "2024-08-08T23:57:37.000000Z",
                "created_at_format": "2024-08-08 18:57:37",
                "code_shop": "pgbsho44747793463129176",
                "name_shop": "Velas martin",
                "code_agent": "pgbage9743164921458226",
                "name_agent": "Francisco Perez",
                "total_orders": 0,
                "total_agent_orders": 0,
                "total_no_agent_orders": 0,
                "isEditable": "-1"
            },
            {
                "code": "pgbcus55264118161569676",
                "name": "Detergentes la perla",
                "lastname": null,
                "phone": "89 56 23 12 78",
                "email": "mail@tyr",
                "created_at": "2024-08-08T23:26:05.000000Z",
                "created_at_format": "2024-08-08 18:26:05",
                "code_shop": "pgbsho44747793463129176",
                "name_shop": "Velas martin",
                "code_agent": "pgbage9743164921458226",
                "name_agent": "Francisco Perez",
                "total_orders": 0,
                "total_agent_orders": 0,
                "total_no_agent_orders": 0,
                "isEditable": "-1"
            },
            {
                "code": "pgbcus54372281224679636",
                "name": "Cliente agente",
                "lastname": "General agente",
                "phone": "",
                "email": "",
                "created_at": "2024-08-08T23:22:57.000000Z",
                "created_at_format": "2024-08-08 18:22:57",
                "code_shop": "pgbsho44747793463129176",
                "name_shop": "Velas martin",
                "code_agent": "pgbage9743164921458226",
                "name_agent": "Francisco Perez",
                "total_orders": 0,
                "total_agent_orders": 0,
                "total_no_agent_orders": 0,
                "isEditable": "0"
            },
            {
                "code": "pgbcus52768928368489799",
                "name": "Distribuidora San Felipe e Hijos",
                "lastname": null,
                "phone": null,
                "email": "distribuidora@mail.com",
                "created_at": "2024-08-08T22:44:23.000000Z",
                "created_at_format": "2024-08-08 17:44:23",
                "code_shop": "pgbsho44747793463129176",
                "name_shop": "Velas martin",
                "code_agent": null,
                "name_agent": null,
                "total_orders": 0,
                "total_agent_orders": 0,
                "total_no_agent_orders": 0,
                "isEditable": "-1"
            }
        ],
        "current_page": 1,
        "last_page": 1,
        "per_page": 10,
        "from": 1,        
        "to": 4,
        "total": 4
    }
}

Descripción de la respuesta​

  • Revisar el listado de códigos EXITOSO para conocer el significado de success code.
  • data - Se obtiene la información de los clientes y la información actual de la paginación
    • current_page - Indica cual es la página actual en la paginación
    • last_page - Indica cual es el último número de página posible (este valor cambia dependiendo del límite de elementos por página que se envio con el parametro limit)
    • per_page - Indica el límite de elementos mostrados por pagina
    • from - indica el índice inicial de la numeración de los clientes mostrado en esta pagina
    • to - indica el índice final de la numeración de los clientes mostrado en esta pagina
    • total - Indica el número de total de elementos que existen
    • data - Arreglo donde se listan los clientes que tiene creados el usuario en la plataforma
      • code - Código del cliente (este código es único para cada cliente dado de alta)
      • name - Nombre del cliente
      • lastname - Apellidos del cliente
      • phone - Teléfono del cliente
      • email - Email del cliente
      • created_at - Fecha y hora de creación del cliente (UTC)
      • created_at_format - Fecha y hora de creación del cliente (America/Mexico_City)
      • code_shop - Código de la tienda a la que pertenece el cliente
      • name_shop - Nombre de la tienda a la que pertenece el cliente
      • code_agent - Código del agente de ventas al que pertenece el cliente
      • name_agent - Nombre del agente ventas al que pertenece el cliente
      • total_orders - Total de órdenes de venta asignadas al cliente (órdenes con y sin agente de ventas)
      • total_agent_orders - Total de órdenes de venta asignadas al cliente (hechas con agente de ventas)
      • total_no_agent_orders - Total de órdenes de venta asignadas al cliente (hechas sin agente de ventas)
      • isEditable - indica si el cliente se puede o no editar, los valores posibles son:
        • 0 = no se puede editar
        • -1 = si se puede editar

Ejemplo de respuesta FALLIDA​

Error

Código HTTP 400, Código HTTP 401, Código HTTP 500


{
    "status": false,
    "error": {
        "code": "1576"
    }
}

Descripción de la respuesta​

  • Revisar el listado de códigos ERROR para conocer la causa y saber cómo corregir
  • Si se obtiene un código HTTP 500 comunicarse a soporte técnico
  • Si se obtiene un código HTTP 401 revisar que el Token API este correcto
Notas

Si tienes alguna duda recuerda que siempre puedes contactar con el equipo de soporte para desarrolladores ingresando en el siguiente enlace: Soporte para desarrolladores.