EVO API ES
Inicio
GuíasAPIs💎 API Pro📢 Novedades
Inicio
GuíasAPIs💎 API Pro📢 Novedades
  1. Sales
  • ¡Bienvenido 💜
  • 📃 Guías
    • Primeros pasos con la API
      • Primeros pasos con la EVO API
      • Permisos de token
      • Límites de solicitudes
      • API Pro
    • Comprender la documentación
      • Utilizar la documentación de forma eficaz
      • Novedades
    • Casos de uso
      • Realizar ventas online a través de API
      • Integración de EVO Pay
      • Cómo usar webhooks
      • Agendamiento de una clase experimental
      • Exportar llamadas a Excel
      • Conciliación de pagos bancarios
      • Emisión de factura
    • FAQ
      • Configuraciones e integraciones
      • Gestión de clientes y relaciones
      • Operación y actividades
      • Financiero
    • Sugerencias
      • Sugerencia de implementación
  • 🌐 API Reference
    • AccessControl
      • Post access control entry authorize
      • Post access control insert manual liberation
      • Get access control turnstiles
      • Update access control serial number turnstiles
    • Activities
      • Get activities
      • Get activities schedule
      • Get activities schedule details
      • Enroll member in activity schedule
      • Change status of a member in activity schedule
      • Create a new experimental class and enroll the member on it
      • List of spots that are already filled in the activity session
      • Get activities schedule by idService or idMembership
      • Get activities enrollment by member or membership
      • Create a new enrollment for a member
      • Delete enrollment
      • Get enrollment details for a member
      • Book member in activity schedule
      • Change status of a member in activity schedule
      • Get activities schedule by enrollment
      • Create a new enrollment for a member
      • Delete enrollment
      • Get enrollment details for a member
      • Get activity sessions for a member
    • Appointments
      • Get activities
      • Retrieves detailed information about scheduled appointment sessions
      • Get blocked appointments
      • Get available activities for appointment
      • Get the available times for appointment
      • Change status of a member in a appointment
      • Enroll member in activity appointment
    • BankAccounts
      • Get bank accounts
    • Carts
      • Get cart by idCartToken
      • Get cart by idMember or idProspect
      • Add new cart
      • Forfeit cart
    • Configuration
      • Get branch configurations
      • Get gateway configurations
      • Get gateway form token
      • Get card flag
      • Get card translation
      • Get occupation
    • Employees
      • Get employees
      • Add employees
      • Update employees
      • Delete employees
      • Retrieves employee permissions.
    • Entries
      • Get entries
    • Invoices
      • Get invoices by date
    • Management
      • Get non-renewed clients
      • Get prospects
      • Get active clients
    • MemberMembership
      • Get summary of MemberMemberships (active, canceled, or specific types).
      • Get summary of MemberMemberships by id
      • Cancel MemberMembership
      • Revert scheduled membership cancellation.
    • Members
      • Get member profile
      • Get members
      • Retrieves active members from a specific branch or from all branches
      • Get member services
      • Get member credit cards
      • Update a member card number
      • Authenticate member
      • Get link for reset password
      • Update a member fitcoins
      • Get member fitcoins
      • Get basic member information.
      • Get member's latest branch transfer
      • Update basic member data
      • Transfers a member from one branch to another
      • Block/unblock member
      • Send push notification to a specific member
      • Send push notification to multiple members
    • Membership
      • Get memberships
      • Get memberships categories
    • Notifications
      • Insert a member notification
      • Insert a prospect notification
    • Parking
      • Validates parking access authorization by CPF (`document`) or by `idMember` for a specific branch.
    • Partnership
      • Get partnerships
    • Payables
      • Get payables
      • Get cost center
    • Pix
      • Get qr-code
    • Product
      • Get products
    • Prospects
      • Get prospects
      • Add prospects
      • Update prospect
      • Get prospect services
      • Transfers a prospect from one branch to another
      • Get prospect's latest branch transfer
      • Get interests list
      • Turn the opportunity into a member, returns the idMember created.
    • Receivables
      • Gets a list of debts and current status (Similar to the Collections - Default report)
      • Creates batch collection attempts for the member membership contracts.
      • Gets the details of a specific charge batch.
      • Get receivables
      • Marks a list of receivables as received (paid)
      • Reverses a list of received (paid) receivables back to open status
      • Get cost center
      • Get receivables conciliation report
      • Charge a receivable using a member's credit card
    • Sales
      • Get sale by Id
        GET
      • Get sales
        GET
      • Create a new sale
        POST
      • Get sales bySessionId
        GET
      • Return itens for sale -> site/totem
        GET
    • Service
      • Get services
    • States
      • Get all states for the current user's country
    • Voucher
      • Get vouchers
      • Get all vouchers code by voucher id
      • Creates a new voucher
      • Validate the voucher
    • Webhook
      • Add new webhook
      • Remove a specific webhook by id
      • List all webhooks created
      • List all webhooks created
    • Workout
      • Change data from a client's prescribed workout
      • Get all Exercises
      • Get all default workouts of the new prescription
      • Get all client's or prospect's or employee's workouts of the new prescription
      • Get all client's or prospect's or employee's workouts of the new prescription by month, year or idProfessor
      • Link workout of the new prescription for client
      • Create a workout of the new prescription
  • Schemas
    • Schemas
      • ClientesAtivosViewModel
      • ContratoNaoRenovadosViewModel
      • SpsRelProspectsCadastradosConvertidos
    • ActiveMembersReturnViewModel
    • ActivityAreaViewModel
    • ActivityEmployeesViewModel
    • ActivityGroupApiViewModel
    • ActivityGroupViewModel
    • ActivityResourcesViewModel
    • ActivityUnavailability
    • AreaBloqueioAgendaApiViewModel
    • AtividadeAgendaApiCustomViewModel
    • AtividadeAgendaApiViewModel
    • AtividadeAgendaListApiViewModel
    • AtividadeBasicoApiViewModel
    • AtividadeEnrollScheduleApiV2ViewModel
    • AtividadeListApiViewModel
    • AddressFamily
    • AtividadeLugarReservaApiViewModel
    • AtividadeLugarReservaViewModel
    • AtividadeSessaoAgendaViewModel
    • AtividadeSessaoParticipanteApiViewModel
    • AsnEncodedData
    • BairroViewModel
    • BandeirasBasicoViewModel
    • Assembly
    • BankAccountsViewModel
    • BasicFreezeViewModel
    • AsymmetricAlgorithm
    • BasicMemberMembershipApiViewModel
    • BloqueioAgendaApiViewModel
    • BonusSessionViewModel
    • BranchGatewayViewModel
    • BusinessHoursViewModel
    • CardDataViewModel
    • CardTranslationViewModel
    • CartIdViewModel
    • CartItemsViewModel
    • CartViewModel
    • ChargeReceivableRequestViewModel
    • ChargeReceivableResponseViewModel
    • CidadeViewModel
    • CityViewModel
    • ClienteDetalhesBasicosApiViewModel
    • ClienteEnotasRetorno
    • ClienteTransferenciaViewModel
    • CofinsEnotasRetorno
    • ColaboradoresBloqueioAgendaApiViewModel
    • ClientesAtivosRetornoViewModel
    • ConfiguracaoApiViewModel
    • ConjugadoItemRequestApiViewModel
    • ContratoEntradasApiViewModel
    • ByteReadOnlyMemory
    • ContratoFiliaisResumoApiViewModel
    • ContratosCanceladosParcelasApiViewModel
    • ByteReadOnlySpan
    • ContratosCanceladosResumoApiViewModel
    • ContratosResumoApiViewModel
    • CallingConventions
    • ContratosResumoPaginaVendaViewModel
    • ConveniosApiViewModel
    • CancellationToken
    • CostCenterApiViewModel
    • DadosContratoTrasnferenciaApiViewModel
    • DadosTrocaContratoApiViewModel
    • DebtorChargesViewModel
    • DebtorsItensViewModel
    • DefaultResponseViewModel
    • DiferenciaisApiViewModel
    • DifferentialsViewModel
    • DropsetItemRequestApiViewModel
    • EFormaContato
    • Claim
    • EFormaPagamentoTotem
    • EOrigemAgendamento
    • ClaimsIdentity
    • EStatusAtividade
    • EStatusAtividadeSessao
    • ClaimsPrincipal
    • ESubStatus
    • ESubStatusApi
    • ETemperatura
    • ETipoContrato
    • ETipoDocumento
    • ETipoGateway
    • EmployeeApiBranchPermissions
    • EmployeeApiIntegracaoAtualizacaoViewModel
    • EmployeeApiIntegracaoViewModel
    • EmpresasConveniosApiViewModel
    • ConnectionInfo
    • EmpresasFiliaisOcupacaoViewModel
    • EnderecoEnotasRetorno
    • ConstructorInfo
    • EnotasRetorno
    • EntradasResumoApiViewModel
    • ExperimentalClassResponseViewModel
    • FitcoinsResponseViewModel
    • FreezeViewModel
    • FreteEnotasRetorno
    • FuncionariosResumoApiViewModel
    • HttpResponseError
    • IcmsEnotasRetorno
    • IdMemberResponseViewModel
    • EmpresasFiliaisGatewayViewModel
    • ImpostosEnotasRetorno
    • InformacoesIndicadosViewModel
    • InstallmentViewModel
    • ItenEnotasRetorno
    • CustomAttributeData
    • ItensBloqueioAgendaApiViewModel
    • LiberacaoCatracaManualViewModel
    • CustomAttributeNamedArgument
    • LogTefApiViewModel
    • MatriculaDetalhesApiV2ViewModel
    • CustomAttributeTypedArgument
    • MatriculaDetalhesApiViewModel
    • EstadoViewModel
    • MatricularApiViewModel
    • MatricularConfiguracaoApiViewModel
    • MemberAuthenticateViewModel
    • MemberBasicResponsibleViewModel
    • MemberBlockUnblockViewModel
    • MemberCreditCardApiViewModel
    • MemberDataViewModel
    • MemberLevelViewModel
    • MemberMembershipApiViewModel
    • MemberNewSaleViewModel
    • MemberParkingViewModel
    • MemberResponsibleViewModel
    • MemberScheduleApiV2ViewModel
    • MemberServiceViewModel
    • MemberTransferViewModel
    • MembersApiResumidoVendaViewModel
    • MembersApiViewModel
    • MembersBasicApiViewModel
    • MetadadosEnotasRetorno
    • MobilePushMultiplaViewModel
    • MobilePushViewModel
    • MonthDiscountViewModel
    • NeighborhoodViewModel
    • NewSaleViewModel
    • NotificationApiViewModel
    • NotificationProspectApiViewModel
    • NotificationResponseViewModel
    • NovoVoucherViewModel
    • PagamentoEnotasRetorno
    • PayablesApiSubTypesViewModel
    • PayablesApiViewModel
    • PedidoEnotasRetorno
    • PercentualAproximadoTributosEnotasRetorno
    • PeriodizacaoApiViewModel
    • EventAttributes
    • PisEnotasRetorno
    • PixPaymentDetailsViewModel
    • EventInfo
    • PrescricaoTreinoViewModel
    • ProblemDetails
    • ProdutoResumoApiViewModel
    • FieldAttributes
    • ProgressivoItemRequestApiViewModel
    • ProspectApiIntegracaoAtualizacaoViewModel
    • FieldInfo
    • ProspectApiIntegracaoViewModel
    • ProspectIdViewModel
    • ProspectResponsavelFinanceiroViewmodel
    • ProspectTransferViewModel
    • ProspectTransferenciaViewModel
    • ProspectsResumoApiViewModel
    • GenericParameterAttributes
    • ProtocoloEnotasRetorno
    • PublicoAtividadeViewModel
    • HostString
    • ReceivablesApiResumoVendaViewModel
    • ReceivablesApiSubTypesViewModel
    • HttpContext
    • ReceivablesApiViewModel
    • ReceivablesApiViewModelListGridComQtdeViewModel
    • HttpRequest
    • ReceivablesCreditDetails
    • ReceivablesInvoiceApiViewModel
    • HttpResponse
    • ReceivablesMaskReceivedViewModel
    • RecursosBloqueioAgendaApiViewModel
    • RetornoCatracaViewModel
    • ICustomAttributeProvider
    • RetornoEntradaManualViewModel
    • RevenueCenterApiViewModel
    • IIdentity
    • ReverseReceivedResponseViewModel
    • ReverseReceivedViewModel
    • IPAddress
    • SaleItensViewModel
    • SalesItemViewModel
    • SalesItemsViewModel
    • IResponseCookies
    • SalesViewModelV2
    • SerieItemRequestApiViewModel
    • IServiceProvider
    • SeriePrescricaoRequestApiViewModel
    • ServiceDiscountViewModel
    • ISession
    • ServicoAdicionalApiViewModel
    • ServicoAnualApiViewModel
    • ServicoEnotasRetorno
    • ServicosResumoApiViewModel
    • SimplificadoEnotasRetorno
    • SpsProspectsServicosInteresses
    • StateViewModel
    • SumaryDebtorsViewModel
    • IntPtr
    • TaxDataViewModel
    • TelefoneApiViewModel
    • TransferClientResponseViewModel
    • TransporteEnotasRetorno
    • KeySizes
    • TreinoPrescricaoRequestApiViewModel
    • UnavailableSpotsResponseViewModel
    • LayoutKind
    • VendasResumoApiViewModel
    • VoucherAtributePublicViewModel
    • VoucherCriacaoViewModel
    • VoucherItemApiViewModel
    • VouchersCodigosViewModel
    • SalesViewModel
    • VouchersCodigosViewModelListWithQuantityViewModel
    • VouchersResumoApiViewModel
    • W12UtilsCategoryMembershipViewModel
    • W12UtilsWebhookHeaderViewModel
    • W12UtilsWebhookViewModel
    • W12UtilzWebHookFilterViewModel
    • YearDiscountViewModel
    • autorizaEntradaExternoViewModel
    • retornoAutorizaEntradaExternoViewModel
    • MemberInfo
    • MemberTypes
    • MethodAttributes
    • MethodBase
    • TimeSpan
    • MethodImplAttributes
    • MethodInfo
    • Module
    • ModuleHandle
    • Oid
    • ParameterAttributes
    • ParameterInfo
    • PathString
    • PipeReader
    • PipeWriter
    • PropertyAttributes
    • PropertyInfo
    • PublicKey
    • QueryString
    • RuntimeFieldHandle
    • RuntimeMethodHandle
    • RuntimeTypeHandle
    • SafeWaitHandle
    • SecurityRuleSet
    • Stream
    • StringStringKeyValuePair
    • StringStringValuesKeyValuePair
    • StructLayoutAttribute
    • Type
    • TypeAttributes
    • TypeInfo
    • TypeObjectKeyValuePair
    • WaitHandle
    • WebSocketManager
    • X500DistinguishedName
    • X509Certificate2
    • X509Extension
  1. Sales

Create a new sale

POST
https://evo-integracao-api.w12app.com.br/api/v2/sales
🌐 API Reference/Sales

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ámetroTipoObligatorioDescripción
idBranchint32NoSucursal donde se realizó la venta.
idBranchTokenstringNoToken de la sucursal, usado en sistemas multifiliales.
idMembershipint32NoID del contrato adquirido.
membershipValuedoubleNoValor final del contrato.
idServiceint32NoID del servicio o clase experimental adquirida.
serviceValuedoubleNoValor final del servicio.
idProductint32NoID del producto relacionado a la venta.
productValuedoubleNoValor final del producto.
productAmountint32NoCantidad del producto.
memberDataobjectSíDatos del miembro. Contiene idMember e información adicional.
cardDataobjectNoDatos de la tarjeta de crédito, si aplica.
idProspectint32NoID del prospecto que realiza la compra.
idProspectTokenstringNoToken del prospecto para validar la transacción.
idMemberTokenstringNoToken del miembro registrado, si aplica.
voucherstringNoCódigo de voucher de descuento.
idVoucherTokenint32NoToken del voucher, si aplica.
idCardMemberint32NoID de la tarjeta del miembro, si aplica.
idMemberCardTokenstringNoToken de la tarjeta del miembro, si aplica.
membershipStartstringNoFecha de inicio del contrato/membership.
totalInstallmentsint32SíNúmero de cuotas. Para pago al contado, use 0 o 1.
paymentint32SíTipo de pago (ver enum más abajo).
sessionIdstringNoIdentificador de la sesión de la transacción.

🧩 Estructura del Objeto memberData#

CampoTipoObligatorioDescripción
idMemberint32SíIdentificador del miembro.
documentstringNoCPF o CNPJ del miembro.
zipCodestringNoCódigo postal.
addressstringNoDirección del miembro.
numberstringNoNúmero de la dirección.
complementstringNoComplemento de la dirección.
neighborhoodstringNoBarrio del miembro.
citystringNoCiudad del miembro.
idStateint32NoID del estado del miembro.

🧩 Estructura del Objeto cardData#

CampoTipoObligatorioDescripción
tokenstringNoIdentificador único de la tarjeta.
temporaryTokenstringNoToken temporal de la tarjeta, si aplica.
branchTokenstringNoToken de la sucursal para sistemas multifiliales.
totalInstallmentsint32NoNúmero total de cuotas en pagos parcelados.
truncatedCardNumberstringNoÚltimos 4 dígitos de la tarjeta para seguridad.
brandstringNoMarca de la tarjeta (Visa, MasterCard, etc.).
cardHolderNamestringNoNombre del titular de la tarjeta.
cardExpirationYearint32NoAño de vencimiento de la tarjeta.
cardExpirationMonthint32NoMes de vencimiento de la tarjeta.

🔷 Enum de payment#

CódigoTipo de PagoDescripción
nullLinkCheckoutPago mediante LinkCheckout.
1Credit CardTarjeta de crédito (requiere token de Evo Pay).
2BoletoPago mediante boleto bancario.
3Sale CreditsPago con créditos de ventas.
4TransferTransferencia bancaria.
5ValorZeradoTransacciones con valor cero, como clases experimentales.
6LinkCheckoutPago mediante link de checkout generado externamente.
7PixPago mediante Pix.
13TransferenciaTransferencia bancaria.

Solicitud

Autorización
or
Parámetros de consulta

Parámetros del Body
application/json-patch+json

Ejemplos

Respuestas

🟢200OK
application/json
Success
Body

🟠400Bad Request
Solicitud Ejemplo de Solicitud
Shell
JavaScript
Java
Swift
curl --location 'https://evo-integracao-api.w12app.com.br/api/v2/sales?showContractHTML=undefined' \
--header 'Content-Type: application/json-patch+json' \
--data '{
    "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"
}'
Respuesta Ejemplo de Respuesta
200 - Ejemplo 1
{
    "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"
}
Modificado en 2026-05-15 13:34:34
Anterior
Get sales
Siguiente
Get sales bySessionId
Built with