Create Cart (Sales Intent)

Description

This endpoint is used to create a new shopping cart. It is aimed at situations where a member or prospect selects products (such as memberships or services) for later purchase completion.

NOTE. Available for use with branch access key and also with General ADM access key.

📨 Request Body

Field	Type	Required	Description
idBranch	int32	Situational	ID of the branch where the cart will be created.
idBranchToken	string	Situational	Identifier token of the branch where the cart will be created.
idMember	int32	Situational	ID of the member linked to the cart. Required if the user is already enrolled.
idProspect	int32	Situational	ID of the prospect linked to the cart. Used for visitors or leads.
voucher	string	No	Discount code to be applied to the final value of the cart.
cartCheckoutLink	string	No	Direct URL for the cart checkout process.
items	array	Yes	List of items to be included in the cart. Each item can be a membership `idMembership` or a service `idService`.

🧩 Structure of the `items` Object

At least one of the fields idMember or idProspect must be provided. Additionally, each item must contain either an idMembership or an idService.

Field	Type	Required	Description
idMembership	int32	Situational	ID of the membership to be included.
idService	int32	Situational	ID of the service to be included.

📝 Example Request Body

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

📤 Response Structure

Upon creating the cart, the API returns the identifier token of the cart and the link for completing the purchase.

Field	Type	Description
idCartToken	string	Unique token of the created cart. Can be used later for retrieval.
cartCheckoutLink	string	Direct URL for the cart checkout process.

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Body Params

application/json-patch+json

Example

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Add new cart

Create Cart (Sales Intent)

Description

📨 Request Body

🧩 Structure of the `items` Object

📝 Example Request Body

📤 Response Structure

Request

Request Code Samples

Responses

Add new cart

Create Cart (Sales Intent)#

Description#

📨 Request Body#

🧩 Structure of the items Object#

📝 Example Request Body#

📤 Response Structure#

Request

Request Code Samples

Responses

Create Cart (Sales Intent)

Description

📨 Request Body

🧩 Structure of the `items` Object

📝 Example Request Body

📤 Response Structure