Get cart by IdMember or IdProspect

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âmetroTipoObrigatoriedadeDescrição
idMemberint32SituacionalID do aluno. Utilize este campo quando o carrinho estiver vinculado a um aluno já cadastrado.
idProspectint32SituacionalID do prospect. Use este campo se o carrinho for de um visitante ou potencial cliente ainda não convertido em aluno.

Resposta

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

CampoTipoDescrição
idBranchTokenstringToken identificador da filial onde o carrinho foi criado.
idMemberint32ID do aluno vinculado ao carrinho (se aplicável).
idProspectint32ID do prospect vinculado ao carrinho (se aplicável).
voucherstringCódigo de voucher aplicado ao carrinho (se houver).
itemsarrayLista de itens no carrinho. Cada item pode ser uma matrícula ou serviço.

Estrutura do Objeto items

CampoTipoDescrição
idMembershipint32ID da matrícula selecionada para compra.
idServiceint32ID do serviço selecionado para compra.

Exemplo de resposta

{
  "idBranchToken": "abc123-token-filial",
  "idMember": 123,
  "idProspect": 0,
  "voucher": "PROMO20",
  "items": [
    {
      "idMembership": 456,
      "idService": 0
    }
  ]
}
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!