Obter itens que estão a venda

Descrição

Esse endpoint permite obter os itens que estão a venda.

OBS. São retornados itens que estiverem com o campo de "Autoatendimento" marcado dentro da página de vendas do EVO.

🔑 Parâmetros de Consulta

Recomendamos informar o idBranch para que sejam filtrados os itens que estão a venda por unidade.

📤 Estrutura da Resposta

Campo	Tipo	Descrição
`nameSalePage`	string	Nome da página de vendas.
`order`	int32	Ordem de exibição da página de vendas.
`idEmployeeCommission`	int32	ID do funcionário responsável pela comissão de venda.
`idBranch`	int32	ID da filial associada à página de vendas.
`idSaleItem`	int32	Identificador do item de venda.
`checkoutUrl`	string	URL de checkout para finalização da compra.
`notInaugurated`	boolean	Indica se a filial ainda não foi inaugurada.
`itens`	array	Lista de itens disponíveis para venda nesta página.

🧩 Estrutura de `ìtens`

Campo	Tipo	Descrição
`idMembership`	int32	ID da matrícula associada ao item (quando aplicável).
`membership`	string	Nome da matrícula.
`loyaltyInstallment`	boolean	Indica se o item possui parcelamento com fidelidade.
`membershipType`	int32	Tipo da matrícula.
`loyaltyTime`	int32	Tempo de fidelidade associado à matrícula.
`validityDescription`	string	Descrição da validade do plano.
`reverseInstallmentsDescription`	string	Descrição do parcelamento reverso, quando aplicável.
`valueDaysMonthsDefinedValidity`	int32	Valor numérico referente à validade definida (dias ou meses).
`serviceValue`	number	Valor do serviço.
`serviceName`	string	Nome do serviço associado.
`remark`	string	Observações adicionais sobre o item.
`membershipText`	string	Texto descritivo da matrícula.
`annuityServiceName`	string	Nome do serviço de anuidade.
`annuityServiceValue`	number	Valor do serviço de anuidade.
`annuityDay`	int32	Dia de cobrança da anuidade.
`annuityMonth`	int32	Mês de cobrança da anuidade.
`annuityChargeType`	int32	Tipo de cobrança da anuidade.
`annuityInstallmentsCount`	int32	Quantidade de parcelas da anuidade.
`promotionalDaysCount`	int32	Quantidade de dias promocionais.
`promoDayMonthType`	int32	Tipo de unidade da promoção (dia/mês).
`installmentsCount`	int32	Quantidade total de parcelas disponíveis.
`promotionalValueDescription`	string	Descrição do valor promocional.
`annuityInstallments`	array	Lista de parcelas da anuidade.
`idService`	int32	ID do serviço associado ao item.
`name`	string	Nome do item exibido na venda.
`flSpotlight`	boolean	Indica se o item está em destaque.
`order`	int32	Ordem de exibição do item.
`type`	int32	Tipo do item de venda.
`chargeValue`	number	Valor de cobrança do item.
`chargeValueDescription`	string	Descrição do valor de cobrança.
`totalValue`	number	Valor total do item.
`taxValue`	number	Valor de taxa aplicada.
`percentageType`	boolean	Indica se o valor é percentual.
`flChargeServiceAutomaticRenew`	boolean	Indica se o serviço possui renovação automática.
`flBankSlip`	boolean	Indica se o pagamento via boleto é permitido.
`flCard`	boolean	Indica se o pagamento via cartão é permitido.
`flCreditBalance`	boolean	Indica se o pagamento via saldo de crédito é permitido.
`flRegisterRequiredAddress`	boolean	Indica se o endereço é obrigatório no cadastro.
`flPrioritizeRegistrationSale`	boolean	Indica se a venda prioriza o cadastro antes da compra.
`ageFrom`	int32	Idade mínima permitida para o item.
`ageTo`	int32	Idade máxima permitida para o item.
`differentials`	array	Lista de diferenciais do item.
`membershipBranches`	array	Lista de IDs das filiais associadas à matrícula.

🧩 Estrutura de `annuityInstallments`

Campo	Tipo	Descrição
`totalValue`	number	Valor total da parcela.
`value`	number	Valor individual da parcela.
`date`	string (date-time)	Data de vencimento da parcela.
`serviceName`	string	Nome do serviço relacionado à parcela.
`serviceValue`	number	Valor do serviço relacionado.
`loyaltyMonthlyPaymentDescription`	string	Descrição do pagamento mensal com fidelidade.
`loyaltyMonthlyPaymentValueDescription`	string	Descrição do valor do pagamento mensal com fidelidade.
`annuityServiceName`	string	Nome do serviço de anuidade.
`annuityServiceValue`	number	Valor do serviço de anuidade.

🧩 Estrutura de `differentials`

Campo	Tipo	Descrição
`title`	string	Título do diferencial do item.
`order`	int32	Ordem de exibição do diferencial.

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 *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

[
    {
        "nameSalePage": "string",
        "order": 0,
        "idEmployeeCommission": 0,
        "idBranch": 0,
        "idSaleItem": 0,
        "checkoutUrl": "string",
        "notInaugurated": true,
        "itens": [
            {
                "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
                ]
            }
        ]
    }
]

🟠400Bad Request

Return itens for sale -> site/totem

Obter itens que estão a venda#

Descrição#

🔑 Parâmetros de Consulta#

📤 Estrutura da Resposta#

🧩 Estrutura de ìtens#

🧩 Estrutura de annuityInstallments#

🧩 Estrutura de differentials#

Requisição