Saltar al contenido principal

show-agent

Este método se utiliza para mostrar de manera individual la información de un agente de ventas, no aplica paginación con en el caso de get-agents.

Path del método​

show-agent

Endpoint final​

PRODUCCION

https://aceptabits.com/api/thirdparty/v1/show-agent

SANDBOX DE PRUEBAS

https://sandbox.aceptabits.com/api/thirdparty/v1/show-agent

Método de petición HTTP​

GET

Lista de parámetros​

ParámetroObligatorioDescripciónvalor
codeSiEl código del agente que se quiere obtenerEjemplo:
pgbage9743164639751694

Deberás de ingresar el código del agente que requieres obtener

Lista de códigos​

Exitoso
CódigoDescripción
0061El agente se ha obtenido 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
1367El Token API no es correcto y la autenticación del usuario ha fallado
1368El código del agente es requerido
1369El agente que se intenta obtener no existe (el código del agente es incorrecto)
1370El Token API no es correcto y la autenticación del usuario ha fallado
1371Ocurrió un problema al obtener el agente, inténtelo nuevamente o consulte con soporte técnico para más ayuda
1372Ocurrió un problema al obtener el agente, 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": "0061"
    },
    "data": {
        "code": "pgbage9743164921458226",
        "name": "Francisco",
        "lastname": "Perez",
        "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": 0,
        "total_orders": 0,
        "active_account": "-1",
        "isEditable": "-1"
    }
}

Descripción de la respuesta​

  • Revisar el listado de códigos EXITOSO para conocer el significado de success code.
  • data - muestra la información del agente
    • 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": "1369"
    }
}

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.