Crear una nueva venta

Descripción

Este endpoint permite registrar ventas de servicios, contratos o clases experimentales para prospectos y miembros, procesando la transacción y aplicando reglas de pago, descuentos y vinculación de sucursal.

🛂 Permiso necesario: Ventas - Edición.
OBS. Disponible para uso con clave de acceso de sucursal o ADM General.

🔗 Referencia Complementaria

Cómo realizar una venta online vía API

🚧 Atención
totalInstallments del cardData es válido solo para pagos con tarjeta de crédito.
Incluya en el Header de la solicitud el campo culture: pt-BR.

Ejemplo

curl --location --request POST 'https://evo-integracao-api.w12app.com.br/api/v2/sales' \
--header 'Content-Type: application/json-patch+json' \
--header 'Authorization: Basic Og==' \
--header 'culture: pt-BR' \ 👈👈👈
--data-raw '{
    "idBranch": 0,
    "idBranchToken": "string",
    "idMembership": 0,
    ...
}'

📨 Parámetros del Cuerpo de la Solicitud

Parámetro	Tipo	Obligatorio	Descripción
`idBranch`	int32	No	Sucursal donde se realizó la venta.
`idBranchToken`	string	No	Token de la sucursal, usado en sistemas multifiliales.
`idMembership`	int32	No	ID del contrato adquirido.
`membershipValue`	double	No	Valor final del contrato.
`idService`	int32	No	ID del servicio o clase experimental adquirida.
`serviceValue`	double	No	Valor final del servicio.
`idProduct`	int32	No	ID del producto relacionado a la venta.
`productValue`	double	No	Valor final del producto.
`productAmount`	int32	No	Cantidad del producto.
`memberData`	object	Sí	Datos del miembro. Contiene `idMember` e información adicional.
`cardData`	object	No	Datos de la tarjeta de crédito, si aplica.
`idProspect`	int32	No	ID del prospecto que realiza la compra.
`idProspectToken`	string	No	Token del prospecto para validar la transacción.
`idMemberToken`	string	No	Token del miembro registrado, si aplica.
`voucher`	string	No	Código de voucher de descuento.
`idVoucherToken`	int32	No	Token del voucher, si aplica.
`idCardMember`	int32	No	ID de la tarjeta del miembro, si aplica.
`idMemberCardToken`	string	No	Token de la tarjeta del miembro, si aplica.
`membershipStart`	string	No	Fecha de inicio del contrato/membership.
`totalInstallments`	int32	Sí	Número de cuotas. Para pago al contado, use 0 o 1.
`payment`	int32	Sí	Tipo de pago (ver enum más abajo).
`sessionId`	string	No	Identificador de la sesión de la transacción.

🧩 Estructura del Objeto `memberData`

Campo	Tipo	Obligatorio	Descripción
`idMember`	int32	Sí	Identificador del miembro.
`document`	string	No	CPF o CNPJ del miembro.
`zipCode`	string	No	Código postal.
`address`	string	No	Dirección del miembro.
`number`	string	No	Número de la dirección.
`complement`	string	No	Complemento de la dirección.
`neighborhood`	string	No	Barrio del miembro.
`city`	string	No	Ciudad del miembro.
`idState`	int32	No	ID del estado del miembro.

🧩 Estructura del Objeto `cardData`

Campo	Tipo	Obligatorio	Descripción
`token`	string	No	Identificador único de la tarjeta.
`temporaryToken`	string	No	Token temporal de la tarjeta, si aplica.
`branchToken`	string	No	Token de la sucursal para sistemas multifiliales.
`totalInstallments`	int32	No	Número total de cuotas en pagos parcelados.
`truncatedCardNumber`	string	No	Últimos 4 dígitos de la tarjeta para seguridad.
`brand`	string	No	Marca de la tarjeta (Visa, MasterCard, etc.).
`cardHolderName`	string	No	Nombre del titular de la tarjeta.
`cardExpirationYear`	int32	No	Año de vencimiento de la tarjeta.
`cardExpirationMonth`	int32	No	Mes de vencimiento de la tarjeta.

🔷 Enum de `payment`

Código	Tipo de Pago	Descripción
null	LinkCheckout	Pago mediante LinkCheckout.
1	Credit Card	Tarjeta de crédito (requiere token de Evo Pay).
2	Boleto	Pago mediante boleto bancario.
3	Sale Credits	Pago con créditos de ventas.
4	Transfer	Transferencia bancaria.
5	ValorZerado	Transacciones con valor cero, como clases experimentales.
6	LinkCheckout	Pago mediante link de checkout generado externamente.
7	Pix	Pago mediante Pix.
13	Transferencia	Transferencia bancaria.

Requisição

Authorization

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Parâmetros de Consulta

Parâmetros Bodyapplication/json-patch+json

Exemplo

{
    "idBranch": 0,
    "idBranchToken": "string",
    "idMembership": 0,
    "membershipValue": 0,
    "idService": 0,
    "serviceValue": 0,
    "idProduct": 0,
    "productValue": 0,
    "productAmount": 0,
    "memberData": {
        "idMember": 0,
        "document": "string",
        "zipCode": "string",
        "address": "string",
        "number": "string",
        "complement": "string",
        "neighborhood": "string",
        "city": "string",
        "idState": 0
    },
    "cardData": {
        "token": "string",
        "temporaryToken": "string",
        "branchToken": "string",
        "totalInstallments": 0,
        "truncatedCardNumber": "string",
        "brand": "string",
        "cardHolderName": "string",
        "cardExpirationYear": 0,
        "cardExpirationMonth": 0
    },
    "idProspect": 0,
    "idProspectToken": "string",
    "idMemberToken": "string",
    "voucher": "string",
    "idCartToken": "string",
    "idCardMember": 0,
    "idMemberCardToken": "string",
    "membershipStart": "string",
    "totalInstallments": 0,
    "payment": 1,
    "sessionId": "string"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

{
    "idBranch": 0,
    "idBranchToken": "string",
    "idMembership": 0,
    "membershipValue": 0,
    "idService": 0,
    "serviceValue": 0,
    "idProduct": 0,
    "productValue": 0,
    "productAmount": 0,
    "memberData": {
        "idMember": 0,
        "document": "string",
        "zipCode": "string",
        "address": "string",
        "number": "string",
        "complement": "string",
        "neighborhood": "string",
        "city": "string",
        "idState": 0
    },
    "cardData": {
        "token": "string",
        "temporaryToken": "string",
        "branchToken": "string",
        "totalInstallments": 0,
        "truncatedCardNumber": "string",
        "brand": "string",
        "cardHolderName": "string",
        "cardExpirationYear": 0,
        "cardExpirationMonth": 0
    },
    "idProspect": 0,
    "idProspectToken": "string",
    "idMemberToken": "string",
    "voucher": "string",
    "idCartToken": "string",
    "idCardMember": 0,
    "idMemberCardToken": "string",
    "membershipStart": "string",
    "typePayment": "string",
    "totalInstallments": 0,
    "payment": 1,
    "sessionId": "string"
}

🟠400Bad Request

/api/v2/sales

Crear una nueva venta#

Descripción#

🔗 Referencia Complementaria#

📨 Parámetros del Cuerpo de la Solicitud#

🧩 Estructura del Objeto memberData#

🧩 Estructura del Objeto cardData#

🔷 Enum de payment#