Criar Carrinho (Sales Intent)

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.

OBS. Disponível para uso com chave de acesso de filial e também com chave de acesso de ADM Geral.

📨 Corpo da Requisição (Request Body)

Campo	Tipo	Obrigatoriedade	Descrição
idBranch	int32	Situacional	ID da filial onde o carrinho será criado.
idBranchToken	string	Situacional	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.
cartCheckoutLink	string	Não	URL direta para o processo de finalização do carrinho (checkout).
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)

{
  "idBranch": "123",
  "idMember": 1010,
  "idProspect": 0,
  "voucher": "PROMOACADEMIA",
  "items": [
    {
      "idMembership": 2001,
      "idService": 0
    }
  ]
}

📤 Estrutura da 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).

Requisição

Authorization

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

Parâmetros Bodyapplication/json-patch+json

Exemplo

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

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Add new cart

Criar Carrinho (Sales Intent)

Descrição

📨 Corpo da Requisição (Request Body)

🧩 Estrutura do Objeto `items`

📝 Exemplo de Requisição (Request Body)

📤 Estrutura da Resposta

Requisição

Exemplos de Requisição

Respostas

Add new cart

Criar Carrinho (Sales Intent)#

Descrição#

📨 Corpo da Requisição (Request Body)#

🧩 Estrutura do Objeto items#

📝 Exemplo de Requisição (Request Body)#

📤 Estrutura da Resposta#

Requisição

Exemplos de Requisição

Respostas

Criar Carrinho (Sales Intent)

Descrição

📨 Corpo da Requisição (Request Body)

🧩 Estrutura do Objeto `items`

📝 Exemplo de Requisição (Request Body)

📤 Estrutura da Resposta