Criar

Descrição

Esse endpoint é utilizado para criar um novo carrinho de compras. É voltado para situações em que um aluno ou prospect seleciona produtos (como matrículas ou serviços) para posterior finalização da compra.

Corpo da Requisição (Request Body)

Campo	Tipo	Obrigatoriedade	Padrão	Descrição
idBranchToken	string	Sim	-	Token identificador da filial onde o carrinho será criado.
idMember	int32	Situacional	-	ID do aluno vinculado ao carrinho. Necessário caso o usuário já seja matriculado.
idProspect	int32	Situacional	-	ID do prospect vinculado ao carrinho. Utilizado para visitantes ou leads.
voucher	string	Não	-	Código de desconto que será aplicado ao valor final do carrinho.
items	array	Sim	-	Lista de itens a serem incluídos no carrinho. Cada item pode ser uma matrícula `idMembership` ou um serviço `idService`.

Estrutura do Objeto `items`

Ao menos um dos campos idMember ou idProspect deve ser informado. Além disso, cada item deve conter ou um idMembership ou um idService.

Campo	Tipo	Obrigatório	Descrição
idMembership	int32	Situacional	ID da matrícula a ser incluída.
idService	int32	Situacional	ID do serviço a ser incluído.

Exemplo de Requisição (Request Body)

{
  "idBranchToken": "filial-token-123",
  "idMember": 1010,
  "idProspect": 0,
  "voucher": "PROMOACADEMIA",
  "items": [
    {
      "idMembership": 2001,
      "idService": 0
    }
  ]
}

Resposta

Ao criar o carrinho, a API retorna o token identificador do carrinho e o link para a finalização da compra.

Campo	Tipo	Descrição
idCartToken	string	Token único do carrinho criado. Pode ser usado posteriormente para recuperação.
cartCheckoutLink	string	URL direta para o processo de finalização do carrinho (checkout).

Exemplo de Resposta

{
  "idCartToken": "ef4b2c91-1234-4567-a1b2-3d4e5f6g7h8i",
  "cartCheckoutLink": "https://suaacademia.com.br/checkout/ef4b2c91-1234-4567-a1b2-3d4e5f6g7h8i"
}