Saltar al contenido principal

add-customer

Este método se utiliza para dar de alta un nuevo cliente en una tienda, no existe un límite y puede tener tantos clientes como lo requiera el usuario en cada una de las tiendas que tenga creadas.

NOTAS

Si se da de alta un cliente ligado a un agente de ventas no significa que el cliente será exclusivo del agente de ventas, se podrán generar órdenes de venta sin la necesidad de que también estén ligadas al agente de ventas, para más información y saber cómo crear órdenes de venta consulta: add-order

Path del método​

add-customer

Endpoint final​

PRODUCCION

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

SANDBOX DE PRUEBAS

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

Método de petición HTTP​

POST

Lista de parámetros​

ParámetroObligatorioDescripciónvalor
code_shopSiEs el código de la tienda a la que se asignara el clienteejemplo:
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
nameSiEl 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 genere
lastnameNoEl apellido que le asignaras al clienteejemplo:
Gómez Sánchez, Torres, etc.

Deveras de ingresar el apellido con el que requieres que el cliente se genere, al no ser obligatorio no es necesario que lo ingreses, sobre todo para clientes que son empresas o negocios que solo necesitan el parámetro name para poder identificarlos
phoneNoEl número de teléfono que se le asignara al clienteejemplo:
+523333333333, (33) 3333333333, 3333333333, etc.

Deveras de ingresar el número de teléfono con el que requieres que el cliente se genere, este campo es útil para poder comunicarte con tu cliente en caso de que lo necesites
emailNoEl email que se le asignara al clienteejemplo:
juan@ejemplo.com, negocio@outlook.mx, etc.

Deveras de ingresar el email con el que requieres que el cliente se genere, este campo es útil para poder comunicarte con tu cliente en caso de que lo necesites
code_agentNoEs el código del agente de ventas al que se asignara el clienteejemplo:
pgbage9743166351596541

Este código es unico 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

Como nota adicional es necesario que el agente de ventas pertenezca a la misma tienda donde se dará de alta el cliente, es decir, el código de tienda que ingreses en el parámetro code_shop debe de ser el mismo que el agente de ventas tenga ligado en su información, si ingresas un código de agente que pertenece a otra tienda recibirás el código de ERROR 1288
NOTAS

Si el parámetro price_mxn no se envía se asignara un precio de $0.00 MXN al servicio

Lista de codigos​

Exitoso
CódigoDescripción
0052Cliente creado 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
1276El Token API no es correcto y la autenticación del usuario ha fallado
1285El código de la tienda es requerido
1277El nombre del cliente es requerido
1286La tienda a la que se asignara el cliente no existe (código de tienda incorrecto)
1287El agente de ventas al que se asignara el cliente no existe (código de agente incorrecto)
1288El agente de ventas no pertenece a la tienda, revise la relación tienda-agente
1289El Token API no es correcto y la autenticación del usuario ha fallado
1290Ocurrió un problema y no es posible dar de alta el cliente, inténtelo nuevamente o consulte con soporte técnico para más ayuda
1291Ocurrió un problema y no es posible dar de alta 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": "0052"
    },
    "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
    }
}

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 recién creado
    • 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": "1287"
    }
}

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.