Return itens for sale -> site/totem
GET
https://evo-integracao-api.w12app.com.br/api/v1/sales/sales-items
🌐 API Reference/Sales
Obtener artículos en venta
Descripción
🚧 OBS. Solo se retornan los artículos que tengan el campo "Autoatendimento" marcado en la página de ventas del EVO.
🔑 Parámetros de Consulta
idBranch para filtrar los artículos en venta por unidad.📤 Estructura de la Respuesta
| Campo | Tipo | Descripción |
|---|---|---|
nameSalePage | string | Nombre de la página de ventas. |
order | int32 | Orden de visualización de la página de ventas. |
idEmployeeCommission | int32 | ID del empleado responsable de la comisión de venta. |
idBranch | int32 | ID de la sucursal asociada a la página de ventas. |
idSaleItem | int32 | Identificador del artículo en venta. |
checkoutUrl | string | URL de checkout para finalizar la compra. |
notInaugurated | boolean | Indica si la sucursal aún no ha sido inaugurada. |
itens | array | Lista de artículos disponibles para la venta en esta página. |
🧩 Estructura de itens
| Campo | Tipo | Descripción |
|---|---|---|
idMembership | int32 | ID de la matrícula asociada al artículo (cuando aplique). |
membership | string | Nombre de la matrícula. |
loyaltyInstallment | boolean | Indica si el artículo tiene pago en cuotas con fidelidad. |
membershipType | int32 | Tipo de matrícula. |
loyaltyTime | int32 | Tiempo de fidelidad asociado a la matrícula. |
validityDescription | string | Descripción de la validez del plan. |
reverseInstallmentsDescription | string | Descripción del pago en cuotas reverso, cuando aplique. |
valueDaysMonthsDefinedValidity | int32 | Valor numérico referente a la validez definida (días o meses). |
serviceValue | number | Valor del servicio. |
serviceName | string | Nombre del servicio asociado. |
remark | string | Observaciones adicionales sobre el artículo. |
membershipText | string | Texto descriptivo de la matrícula. |
annuityServiceName | string | Nombre del servicio de anualidad. |
annuityServiceValue | number | Valor del servicio de anualidad. |
annuityDay | int32 | Día de cobro de la anualidad. |
annuityMonth | int32 | Mes de cobro de la anualidad. |
annuityChargeType | int32 | Tipo de cobro de la anualidad. |
annuityInstallmentsCount | int32 | Cantidad de cuotas de la anualidad. |
promotionalDaysCount | int32 | Cantidad de días promocionales. |
promoDayMonthType | int32 | Tipo de unidad de la promoción (día/mes). |
installmentsCount | int32 | Cantidad total de cuotas disponibles. |
promotionalValueDescription | string | Descripción del valor promocional. |
annuityInstallments | array | Lista de cuotas de la anualidad. |
idService | int32 | ID del servicio asociado al artículo. |
name | string | Nombre del artículo mostrado en la venta. |
flSpotlight | boolean | Indica si el artículo está destacado. |
order | int32 | Orden de visualización del artículo. |
type | int32 | Tipo de artículo en venta. |
chargeValue | number | Valor de cobro del artículo. |
chargeValueDescription | string | Descripción del valor de cobro. |
totalValue | number | Valor total del artículo. |
taxValue | number | Valor de impuesto aplicado. |
percentageType | boolean | Indica si el valor es porcentual. |
flChargeServiceAutomaticRenew | boolean | Indica si el servicio tiene renovación automática. |
flBankSlip | boolean | Indica si se permite pago mediante boleto. |
flCard | boolean | Indica si se permite pago mediante tarjeta. |
flCreditBalance | boolean | Indica si se permite pago mediante saldo de crédito. |
flRegisterRequiredAddress | boolean | Indica si es obligatorio registrar la dirección. |
flPrioritizeRegistrationSale | boolean | Indica si la venta prioriza el registro antes de la compra. |
ageFrom | int32 | Edad mínima permitida para el artículo. |
ageTo | int32 | Edad máxima permitida para el artículo. |
differentials | array | Lista de diferenciales del artículo. |
membershipBranches | array | Lista de IDs de las sucursales asociadas a la matrícula. |
🧩 Estructura de annuityInstallments
| Campo | Tipo | Descripción |
|---|---|---|
totalValue | number | Valor total de la cuota. |
value | number | Valor individual de la cuota. |
date | string (date-time) | Fecha de vencimiento de la cuota. |
serviceName | string | Nombre del servicio relacionado con la cuota. |
serviceValue | number | Valor del servicio relacionado. |
loyaltyMonthlyPaymentDescription | string | Descripción del pago mensual con fidelidad. |
loyaltyMonthlyPaymentValueDescription | string | Descripción del valor del pago mensual con fidelidad. |
annuityServiceName | string | Nombre del servicio de anualidad. |
annuityServiceValue | number | Valor del servicio de anualidad. |
🧩 Estructura de differentials
| Campo | Tipo | Descripción |
|---|---|---|
title | string | Título del diferencial del artículo. |
order | int32 | Orden de visualización del diferencial. |
Solicitud
Parámetros de consulta
Respuestas
Solicitud Ejemplo de Solicitud
Shell
JavaScript
Java
Swift
curl --location 'https://evo-integracao-api.w12app.com.br/api/v1/sales/sales-items?idBranch=undefined'Respuesta Ejemplo de Respuesta
200 - Ejemplo 1
[
{
"nameSalePage": "string",
"order": 0,
"idEmployeeCommission": 0,
"idBranch": 0,
"idSaleItem": 0,
"checkoutUrl": "string",
"notInaugurated": true,
"itens": [
{
"promotionalValueCompleteDescription": "string",
"promotionalValueCompleteDescriptionDay": "string",
"completeValidityDescription": "string",
"membershipLoyaltyDescription": "string",
"validityMonthsAmount": 0,
"installmentsDescription": "string",
"installmentsLoyaltyDescription": "string",
"firstInstallments": [
{
"totalValue": 0,
"value": 0,
"date": "2019-08-24T14:15:22.123Z",
"serviceName": "string",
"serviceValue": 0,
"loyaltyMonthlyPaymentDescription": "string",
"loyaltyMonthlyPaymentValueDescription": "string",
"annuityServiceName": "string",
"annuityServiceValue": 0
}
],
"paymentDescription": "string",
"cardInstallments": [
"string"
],
"nextInstallment": 0,
"annuityDate": "2019-08-24T14:15:22.123Z",
"sessionsCountDescription": "string",
"recurrency": true,
"calculatedValue": 0,
"valueDescription": "string",
"valueTextDescription": "string",
"valueWithoutCentsDescription": "string",
"valueCentsDescription": "string",
"textMonthDescription": "string",
"promotionalValueDayDescription": "string",
"nextChargeDate": "2019-08-24T14:15:22.123Z",
"idMembership": 0,
"membership": "string",
"loyaltyInstallment": true,
"membershipType": 1,
"loyaltyTime": 0,
"validityDescription": "string",
"reverseInstallmentsDescription": "string",
"valueDaysMonthsDefinedValidity": 0,
"serviceValue": 0,
"serviceName": "string",
"remark": "string",
"membershipText": "string",
"annuityServiceName": "string",
"annuityServiceValue": 0,
"annuityDay": 0,
"annuityMonth": 0,
"annuityChargeType": 0,
"annuityInstallmentsCount": 0,
"promotionalDaysCount": 0,
"promoDayMonthType": 0,
"installmentsCount": 0,
"promotionalValueDescription": "string",
"annuityInstallments": [
{
"totalValue": 0,
"value": 0,
"date": "2019-08-24T14:15:22.123Z",
"serviceName": "string",
"serviceValue": 0,
"loyaltyMonthlyPaymentDescription": "string",
"loyaltyMonthlyPaymentValueDescription": "string",
"annuityServiceName": "string",
"annuityServiceValue": 0
}
],
"idService": 0,
"name": "string",
"flSpotlight": true,
"order": 0,
"type": 0,
"chargeValue": 0,
"chargeValueDescription": "string",
"totalValue": 0,
"taxValue": 0,
"percentageType": true,
"flChargeServiceAutomaticRenew": true,
"flBankSlip": true,
"flCard": true,
"flCreditBalance": true,
"flRegisterRequiredAddress": true,
"flPrioritizeRegistrationSale": true,
"ageFrom": 0,
"ageTo": 0,
"differentials": [
{
"title": "string",
"order": 0
}
],
"membershipBranches": [
0
]
}
]
}
]Modificado en 2026-05-15 13:34:34