Saltar al contenido principal

get-agents

Este método obtiene el listado de agentes 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 generó el agente.

Path del método​

get-agents

Endpoint final​

PRODUCCION

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

SANDBOX DE PRUEBAS

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

Método de petición HTTP​

GET

Lista de parámetros​

ParámetroObligatorioDescripciónvalor
pageSiEs la pagina 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 agentes en específicoejemplo:
pgbsho0635214789653205

Este codigo 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
searchNoSe utiliza como filtro de búsqueda para la consulta de los agentes, el filtro se aplicara dentro de:

code name lastname phone email code_shop name_shop

Para mas información de estos campos consulta el método add-agent, show-agent o en esta misma sección en Ejemplo de respuesta EXITOSA		Ejemplo:
pgbsho6199, mario, 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
0048Lista de agentes 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
1235El Token API no es correcto y la autenticación del usuario ha fallado
1583El campo página de la paginación es requerido
1584El campo límite de la paginación es requerido
1236El Token API no es correcto y la autenticación del usuario ha fallado
1237Ocurrió un problema al obtener el listado de agentes, 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": "0048"
    },
    "data": {        
        "data": [
            {
                "code": "pgbage9743164921458226",
                "name": "Francisco",
                "lastname": "Perez lopez",
                "email": "francisco@tester.com",
                "phone": "+523313337135",
                "created_at": "2024-08-08T23:22:57.000000Z",
                "created_at_format": "2024-08-08 18:22:57",
                "code_shop": "pgbsho44747793463129176",
                "name_shop": "Velas martin",
                "total_customers": 1,
                "total_orders": 1,
                "active_account": "-1",
                "isEditable": "-1"
            }
        ],
        "current_page": 1,
        "last_page": 1,
        "per_page": 5,
        "from": 1,        
        "to": 1,
        "total": 1
    }
}

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 agentes 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 envió con el parámetro limit)
    • per_page - Indica el límite de elementos mostrados por pagina
    • from - indica el índice inicial de la numeración de los agentes mostrado en esta pagina
    • to - indica el índice final de la numeración de los agentes mostrado en esta pagina
    • total - Indica el número de total de elementos que existen
    • data - Arreglo donde se listan los agentes que tiene creados el usuario en la plataforma
      • code - Código del agente (este código es único para cada agente dado de alta)
      • name - Nombre del agente
      • lastname - Apellidos del agente
      • email - Email del agente
      • phone - Teléfono del agente
      • created_at - Fecha y hora de creación del agente (UTC)
      • created_at_format - Fecha y hora de creación del agente (America/Mexico_City)
      • code_shop - Código de la tienda a la que pertenece el agente
      • name_shop - Nombre de la tienda a la que pertenece el agente
      • total_customers - Total de clientes asignados al agente
      • total_orders - Total de órdenes de venta asignadas al agente
      • active_account - indica si el agente tiene su cuenta activa en la plataforma (es decir, que pueda iniciar sesión y hacer uso de la plataforma), los valores posibles son:
        • 0 = el agente no tiene activa su cuenta
        • -1 = el agente si tiene activa su cuenta
      • isEditable - indica si el agente 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": "1583"
    }
}

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.