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 contratos ou serviços, para posterior finalização da compra.

Para itens do tipo contrato (idMembership), é possível incluir um ou mais contratos adicionais opcionais por meio do campo additionalMemberships. Os adicionais informados são vinculados ao item principal, preservados no carrinho e seguem para a etapa de checkout.

🚧 Observações
Disponível para uso com chave de acesso de filial e também com chave de acesso de ADM Geral.
Ao menos um dos campos idMember ou idProspect deve ser informado.
Cada item deve conter um idMembership ou um idService.
O campo additionalMemberships deve ser utilizado apenas para contratos adicionais opcionais. Adicionais do tipo Fixed não devem ser enviados pela integração, pois são incluídos automaticamente quando a venda do contrato principal é concluída no checkout.
Os contratos adicionais estão sujeitos às mesmas validações de vínculo e elegibilidade aplicadas no fluxo de Sales. Caso a combinação informada seja inválida, a operação será rejeitada e não será gerado um carrinho utilizável.

📨 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 conter um contrato (`idMembership`) ou um serviço (`idService`).

🧩 Estrutura do Objeto `items`

Campo	Tipo	Obrigatoriedade	Descrição
`idMembership`	int32	Situacional	ID do contrato a ser incluído no carrinho.
`idService`	int32	Situacional	ID do serviço a ser incluído no carrinho.
`additionalMemberships`	arrayobject	Não	Lista de contratos adicionais opcionais vinculados ao item de contrato. Permite informar um ou mais adicionais. Ver mais abaixo.

🧩 Estrutura do Objeto `additionalMemberships`

Campo	Tipo	Obrigatoriedade	Descrição
`idMembership`	int32	Sim	ID do contrato adicional opcional a ser incluído no carrinho.
`membershipValue`	number (double)	Não	Valor final do contrato adicional informado pela integração. Quando informado, sobrescreve o valor padrão definido pelo EVO (`defaultSaleValue`) e não é recalculado ou multiplicado pela vigência. Quando não informado, o EVO utiliza o valor padrão aplicável ao contrato adicional.

OBS. Cada contrato informado em additionalMemberships deve possuir um vínculo opcional válido com o contrato principal ou atender às regras de elegibilidade para venda de adicionais a um membro que já possua um contrato principal elegível.

📥 Exemplo de Requisição

Exemplo de um contrato principal com múltiplos contratos adicionais opcionais:

{
  "idMember": 123,
  "items": [
    {
      "idMembership": 100,
      "additionalMemberships": [
        {
          "idMembership": 200
        },
        {
          "idMembership": 201,
          "membershipValue": 45.00
        }
      ]
    }
  ]
}

No exemplo acima, o adicional 200 utilizará o valor padrão definido pelo EVO, enquanto o adicional 201 utilizará 45.00 como valor final informado pela integração.

📤 Estrutura da Resposta

Ao criar o carrinho, a API retorna o token identificador do carrinho, o link para a finalização da compra e os itens adicionados. Quando contratos adicionais forem informados, eles são preservados e retornados dentro do respectivo item de contrato.

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).
`items`	array	Lista de itens incluídos no carrinho. Ver mais abaixo.

🧩 Estrutura do Objeto `items`

Campo	Tipo	Descrição
`idMembership`	int32	ID do contrato incluído no carrinho, quando aplicável.
`idService`	int32	ID do serviço incluído no carrinho, quando aplicável.
`additionalMemberships`	arrayobject	Lista de contratos adicionais opcionais vinculados ao item de contrato.

🧩 Estrutura do Objeto `additionalMemberships`

Campo	Tipo	Descrição
`idMembership`	int32	ID do contrato adicional opcional.
`membershipValue`	number (double)	Valor informado para o contrato adicional, quando aplicável.

OBS. Os contratos adicionais informados na criação são preservados com seus vínculos, retornados posteriormente pelos endpoints de consulta de Carts e mantidos durante o fluxo até a conclusão do 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 Body

application/json-patch+json

Exemplo

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

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

{
    "idCartToken": "string",
    "cartCheckoutLink": "string",
    "items": [
        {
            "idMembership": 0,
            "idService": 0,
            "additionalMemberships": [
                {
                    "idMembership": 0,
                    "membershipValue": 0
                }
            ]
        }
    ]
}

🟠400Bad Request

Add new cart

Criar Carrinho (Sales Intent)#

Descrição#

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

🧩 Estrutura do Objeto items#

🧩 Estrutura do Objeto additionalMemberships#

📥 Exemplo de Requisição#

📤 Estrutura da Resposta#

🧩 Estrutura do Objeto items#

🧩 Estrutura do Objeto additionalMemberships#

Requisição

Exemplos de Requisição

Respostas

Criar Carrinho (Sales Intent)

Descrição

📨 Corpo da Requisição (Request Body)

🧩 Estrutura do Objeto `items`

🧩 Estrutura do Objeto `additionalMemberships`

📥 Exemplo de Requisição

📤 Estrutura da Resposta

🧩 Estrutura do Objeto `items`

🧩 Estrutura do Objeto `additionalMemberships`