Saltar al contenido principal

show-customer

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


Path del método

show-customer

Endpoint final

PRODUCCION

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

SANDBOX DE PRUEBAS

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

Método de petición HTTP

GET

Lista de parámetros

ParámetroObligatorioDescripciónvalor
codeSiEl código del cliente que se quiere obtenerEjemplo:
pgbcus49196546354813961

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

Lista de códigos

Exitoso
CódigoDescripción
0062El cliente 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
1373El Token API no es correcto y la autenticación del usuario ha fallado
1374El código del cliente es requerido
1375El cliente que se intenta obtener no existe (el código del cliente es incorrecto)
1376El Token API no es correcto y la autenticación del usuario ha fallado
1377Ocurrió un problema al obtener el cliente, inténtelo nuevamente o consulte con soporte técnico para más ayuda
1378Ocurrió un problema al obtener el cliente, 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": "0062"
},
"data": {
"code": "pgbcus37375715916693313",
"name": "Cliente",
"lastname": "General",
"phone": "",
"email": "",
"created_at": "2024-07-18T20:09:19.000000Z",
"created_at_format": "2024-07-18 15:09:19",
"code_shop": "pgbsho40996222369461182",
"name_shop": "Tienda general",
"code_agent": null,
"name_agent": null,
"total_orders": 0,
"total_agent_orders": 0,
"total_no_agent_orders": 0,
"isEditable": "0"
}
}

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 cliente
    • 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": "1375"
}
}

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.