Realizar ventas online a través de API

La API de ventas permite registrar transacciones que involucran prospects (clientes potenciales) y miembros (clientes registrados), abarcando la adquisición de servicios, contratos de membresía y clases de prueba. Fue desarrollada para ofrecer flexibilidad y precisión en el control comercial, integrando procesos como la aplicación de descuentos, la definición de la forma de pago (al contado o en cuotas), el uso de vouchers y la vinculación con la sucursal responsable de la venta.

Cada tipo de venta tiene un flujo específico, determinado por el estado del cliente (prospect o miembro) y por el tipo de producto adquirido (servicio o contrato). Esta guía presenta los principales casos de uso, con ejemplos prácticos y estructuras de payload, para facilitar la correcta integración con la API.

El uso adecuado de los campos obligatorios y opcionales garantiza que la información sea procesada correctamente por el sistema, optimizando el registro de ventas y la conversión de prospects en miembros activos.

Casos de Uso

Caso 1: Prospect + Servicio

Descripción
Un prospect (cliente potencial) realiza la compra de un servicio específico. El sistema registra el prospect y el servicio adquirido.

Campos Obligatorios:

idProspect: Identificación del prospect.

idService: Identificación del servicio adquirido.

payment: Tipo de pago (1 para pago al contado, 5 para pago en cuotas).

idMember: 0 (indica que aún no es miembro).

Ejemplo:

{
  "memberData": {
    "idMember": 0
  },
  "idProspect": 27473,
  "idService": 481,
  "payment": 5
}

Flujo:

Prospect identificado por idProspect.

Servicio asociado mediante idService.

Pago registrado en payment.

Si es en cuotas, usar totalInstallments.

El campo serviceValue puede ajustarse.

Caso 2: Miembro + Servicio

Descripción:
Un miembro registrado realiza la compra de un servicio. El sistema asocia el servicio al miembro.

Campos Obligatorios:

idMember: Identificación del miembro.

idService: Identificación del servicio adquirido.

payment: Tipo de pago.

Ejemplo:

{
  "memberData": {
    "idMember": 12345
  },
  "idService": 481,
  "payment": 6
}

Flujo:

Miembro identificado por idMember.

Servicio identificado por idService.

Pago registrado.

Parcelación con totalInstallments, si aplica.

serviceValue ajustable.

Caso 3: Venta de Contrato para Prospect

Descripción:
Un prospect adquiere un contrato de membresía. El sistema registra la venta para el prospect.

Campos Obligatorios:

idProspect: Identificación del prospect.

idMembership: ID del contrato adquirido.

payment: Tipo de pago.

idMember: 0 (aún no es miembro).

Ejemplo:

{
  "memberData": {
    "idMember": 0
  },
  "idProspect": 27473,
  "idMembership": 789,
  "payment": 6
}

Flujo:

Prospect identificado por idProspect.

Contrato identificado por idMembership.

Tipo de pago informado.

Parcelación con totalInstallments, si es necesario.

Valor ajustable (serviceValue) y posible uso de voucher.

Después de la compra, el prospect se convierte en miembro (idMember es asignado).

Caso 4: Venta de Contrato para Miembro

Descripción:
Un miembro adquiere un contrato de membresía. El sistema asocia la venta al miembro.

Campos Obligatorios:

idMember: Identificación del miembro.

idMembership: ID del contrato.

payment: Tipo de pago.

Ejemplo:

{
  "memberData": {
    "idMember": 12345
  },
  "idMembership": 789,
  "payment": 6
}

Caso 5: Clase de Prueba para Prospect

Descripción:
El prospect desea inscribirse en una clase de prueba, donde el valor es cero para promover el servicio y generar interés. La transacción se registra con un pago de valor cero, pero se trata como una transacción válida en el sistema, con payment definido como 5 (indicando que es un servicio, incluso sin valor de pago).

Campos Obligatorios:

idProspect: Identificación del prospect.

idService: ID de la clase de prueba.

payment: 5 (indica servicio gratuito).

idMember: 0.

Campos Opcionales:

idBranch: Si existen múltiples sucursales.

Ejemplo:

{
  "memberData": {
    "idMember": 0
  },
  "idProspect": 27473,
  "idService": 101,
  "payment": 5
}

Flujo:

Prospect realiza la inscripción (idProspect).

Clase de prueba identificada mediante idService.

Pago marcado como 5 (valor cero).

Venta registrada con idMember: 0.

Recursos Adicionales

1. Agregar Pago en Cuotas

Si la venta es en cuotas, complete el campo totalInstallments con el número de cuotas.
Por ejemplo, para 12 cuotas:

"totalInstallments": 12

Si el pago es al contado, el campo puede ser:

"totalInstallments": 0

"totalInstallments": 1

2. Agregar Voucher de Descuento

Si el cliente utiliza un voucher para obtener un descuento, ingrese el código del voucher en el campo voucher.
El sistema aplicará automáticamente el descuento al valor del contrato o servicio.

"voucher": "MEUDESCONTO123"

3. Modificar el Valor del Servicio (Solo para servicios)

El campo serviceValue puede ajustarse en caso de que exista algún descuento, modificación u otro cambio en el valor del servicio.
Si no se informa, el sistema utilizará el valor estándar registrado.

"serviceValue": 199.90

4. Elegir la Sucursal de la Venta (Token Multisucursal)

Si el sistema opera con múltiples sucursales, utilice el campo idBranch para indicar la sucursal responsable de la venta.
Si el token de autenticación es multisucursal:

Si idBranch es informado, la venta se registrará en la sucursal correspondiente.

Si idBranch no es informado, el sistema utilizará el valor de idBranch del propio token.

"idBranch": 12

Quiero integrar con EVO PAY

Realizar ventas online a través de API

Casos de Uso#

Caso 1: Prospect + Servicio#

Caso 2: Miembro + Servicio#

Caso 3: Venta de Contrato para Prospect#

Caso 4: Venta de Contrato para Miembro#

Caso 5: Clase de Prueba para Prospect#

Recursos Adicionales#

1. Agregar Pago en Cuotas#

2. Agregar Voucher de Descuento#

3. Modificar el Valor del Servicio (Solo para servicios)#

4. Elegir la Sucursal de la Venta (Token Multisucursal)#

Casos de Uso

Caso 1: Prospect + Servicio

Caso 2: Miembro + Servicio

Caso 3: Venta de Contrato para Prospect

Caso 4: Venta de Contrato para Miembro

Caso 5: Clase de Prueba para Prospect

Recursos Adicionales

1. Agregar Pago en Cuotas

2. Agregar Voucher de Descuento

3. Modificar el Valor del Servicio (Solo para servicios)

4. Elegir la Sucursal de la Venta (Token Multisucursal)