Create Cart (Sales Intent)

Description

This endpoint is used to create a new shopping cart. It is intended for scenarios where a member or prospect selects products, such as memberships or services, for later purchase completion.

For membership items (idMembership), one or more optional add-on memberships can be included through the additionalMemberships field. The provided add-ons are linked to the main item, preserved in the cart, and carried through to the checkout stage.

🚧 Notes
Available for use with both Branch Access Keys and General Admin Access Keys.
At least one of the idMember or idProspect fields must be provided.
Each item must contain either an idMembership or an idService.
The additionalMemberships field must only be used for optional add-on memberships. Fixed add-ons must not be sent by the integration, as they are automatically included when the sale of the main membership is completed at checkout.
Add-on memberships are subject to the same link and eligibility validations applied in the Sales flow. If the provided combination is invalid, the operation will be rejected and no usable cart will be generated.

📨 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 when the user is already registered as a member.
`idProspect`	int32	Situational	ID of the prospect linked to the cart. Used for visitors or leads.
`voucher`	string	No	Discount code that will be applied to the final cart value.
`cartCheckoutLink`	string	No	Direct URL to the cart checkout process.
`items`	array	Yes	List of items to be included in the cart. Each item can contain a membership (`idMembership`) or a service (`idService`).

🧩 `items` Object Structure

Field	Type	Required	Description
`idMembership`	int32	Situational	ID of the membership to be included in the cart.
`idService`	int32	Situational	ID of the service to be included in the cart.
`additionalMemberships`	arrayobject	No	List of optional add-on memberships linked to the membership item. Allows one or more add-ons to be provided. See below.

🧩 `additionalMemberships` Object Structure

Field	Type	Required	Description
`idMembership`	int32	Yes	ID of the optional add-on membership to be included in the cart.
`membershipValue`	number (double)	No	Final value of the add-on membership provided by the integration. When provided, it overrides the default value defined by EVO (`defaultSaleValue`) and is not recalculated or multiplied by the membership duration. When omitted, EVO uses the default value applicable to the add-on membership.

NOTE. Each membership provided in additionalMemberships must have a valid optional link to the main membership or meet the eligibility rules for selling add-ons to a member who already has an eligible main membership.

📥 Request Example

Example of a main membership with multiple optional add-on memberships:

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

In the example above, add-on 200 will use the default value defined by EVO, while add-on 201 will use 45.00 as the final value provided by the integration.

📤 Response Structure

When the cart is created, the API returns the cart identifier token, the checkout link, and the added items. When add-on memberships are provided, they are preserved and returned within the corresponding membership item.

Field	Type	Description
`idCartToken`	string	Unique token of the created cart. It can be used later to retrieve the cart.
`cartCheckoutLink`	string	Direct URL to the cart checkout process.
`items`	array	List of items included in the cart. See below.

🧩 `items` Object Structure

Field	Type	Description
`idMembership`	int32	ID of the membership included in the cart, when applicable.
`idService`	int32	ID of the service included in the cart, when applicable.
`additionalMemberships`	arrayobject	List of optional add-on memberships linked to the membership item.

🧩 `additionalMemberships` Object Structure

Field	Type	Description
`idMembership`	int32	ID of the optional add-on membership.
`membershipValue`	number (double)	Value provided for the add-on membership, when applicable.

NOTE. Add-on memberships provided when the cart is created are preserved with their links, subsequently returned by the Carts query endpoints, and maintained throughout the flow until checkout is completed.

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,
            "additionalMemberships": [
                {
                    "idMembership": 0,
                    "membershipValue": 0
                }
            ]
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

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

🟠400Bad Request

Add new cart

Create Cart (Sales Intent)#

Description#

📨 Request Body#

🧩 items Object Structure#

🧩 additionalMemberships Object Structure#

📥 Request Example#

📤 Response Structure#

🧩 items Object Structure#

🧩 additionalMemberships Object Structure#

Request

Request Code Samples

Responses

Create Cart (Sales Intent)

Description

📨 Request Body

🧩 `items` Object Structure

🧩 `additionalMemberships` Object Structure

📥 Request Example

📤 Response Structure

🧩 `items` Object Structure

🧩 `additionalMemberships` Object Structure