Obter Carrinho

Descrição

Recupera o carrinho de compras associado a um aluno idMember ou prospect idProspect. Esse carrinho pode conter itens como planos de matrícula idMembership e serviços idService, previamente adicionados..
Este endpoint é usado para exibir o estado atual do carrinho de um usuário antes da finalização da compra.

🔑 Parâmetros de Consulta

Esse endpoint requer que um dos dois campos idMember ou idProspect seja informado. Se ambos forem omitidos, o carrinho não será localizado.

Parâmetro	Tipo	Obrigatoriedade	Descrição
idMember	int32	Situacional	ID do aluno. Utilize este campo quando o carrinho estiver vinculado a um aluno já cadastrado.
idProspect	int32	Situacional	ID do prospect. Use este campo se o carrinho for de um visitante ou potencial cliente ainda não convertido em aluno.

📤 Estrutura da Resposta

A resposta será um objeto representando o carrinho atual do aluno ou prospect.

Campo	Tipo	Descrição
idBranchToken	string	Token identificador da filial onde o carrinho foi criado.
idBranch	int32	ID da filial onde o carrinho foi criado.
idMember	int32	ID do aluno vinculado ao carrinho (se aplicável).
idProspect	int32	ID do prospect vinculado ao carrinho (se aplicável).
voucher	string	Código de voucher aplicado ao carrinho (se houver).
items	array	Lista de itens no carrinho. Cada item pode ser uma matrícula ou serviço.

🧩 Estrutura do Objeto `items`

Campo	Tipo	Descrição
idMembership	int32	ID da matrícula selecionada para compra.
idService	int32	ID do serviço selecionado para compra.

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

{
    "idBranchToken": "string",
    "idBranch": 0,
    "idMember": 0,
    "idProspect": 0,
    "voucher": "string",
    "cartCheckoutLink": "string",
    "items": [
        {
            "idMembership": 0,
            "idService": 0
        }
    ]
}

🟠400Bad Request

Get cart by idMember or idProspect

Obter Carrinho#

Descrição#

🔑 Parâmetros de Consulta#

📤 Estrutura da Resposta#

🧩 Estrutura do Objeto items#