Saltar al contenido principal

edit-customer

Este método se utiliza para editar un cliente, ya sea para cambiar el nombre, email o algún otro dato que contiene el cliente.

NOTAS

Este método solo es funcional para los clientes que tengan el campo isEditable con valor -1, por ejemplo, Cliente general que se crea por default al dar de alta una tienda no es editable.

Para conocer más acerca de los elementos creados por default se deberá de consultar la sección: Elementos creados por default


Path del método

edit-customer

Endpoint final

PRODUCCION

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

SANDBOX DE PRUEBAS

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

Método de petición HTTP

POST

Lista de parámetros

ParámetroObligatorioDescripciónvalor
codeSiEl código del cliente que se quiere editarEjemplo:
pgbcus52768928368489799

Deveras de ingresar el código del cliente que requieres editar, el código debe de ser de un cliente editable

Este código es único y puedes encontrarlo al consultar la información de un cliente dentro de los métodos get-customers o show-customer
nameNoEl nombre que se le asignara al clienteejemplo:
Juan Carlos, Martin, Distribuidora San Felipe, etc.

Deveras de ingresar el nombre con el que requieres que el cliente se edite
NOTAS
  • Los parámetros que se envíen y estén vacios remplazaran el contenido del cliente por un valor nulo, ejemplo, si deseas eliminar por completo el email del cliente deveras de enviar el parámetro email con valor vacío para que al ejecutar el servicio el campo email quede con valor nulo.
  • El único campo que no aplica con la regla anterior es name, si se envía name con un valor vacío, el nombre actual del cliente se mantendrá.

Lista de códigos

Exitoso
CódigoDescripción
0053El cliente se ha actualizado 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
1292El Token API no es correcto y la autenticación del usuario ha fallado
1293El código del cliente es requerido
1302El cliente que se intenta editar no existe (el código del cliente es incorrecto)
1335No es posible editar el cliente, el código del cliente ingresado debe de corresponder a un cliente que sea editable
1303El Token API no es correcto y la autenticación del usuario ha fallado
1304Ocurrió un problema al editar el cliente, inténtelo nuevamente o consulte con soporte técnico para más ayuda
1305Ocurrió un problema al editar 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": "0053"
},
"data": {
"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"
}
}

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": "1302"
}
}

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.