Cloudcart

Learn how to use Cloudcart with Composio

Overview

SLUG: CLOUDCART

Description

CloudCart is an e-commerce platform that enables businesses to create and manage online stores efficiently.

Authentication Details

subdomain
stringRequired
generic_api_key
stringRequired

Connecting to Cloudcart

Create an auth config

Use the dashboard to create an auth config for the Cloudcart toolkit. This allows you to connect multiple Cloudcart accounts to Composio for agents to use.

1

Select App

Navigate to Cloudcart.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Cloudcart Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4cloudcart_auth_config_id = "ac_YOUR_CLOUDCART_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": user_api_key}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Cloudcart for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, cloudcart_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Cloudcart toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["CLOUDCART"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Add to Cart

Description

Tool to add an item to the cart. use after confirming a product selection with desired quantity.

Action Parameters

product_id
integerRequired
quantity
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Clear Cart

Description

Tool to remove all items from the specified cart. use when you need to empty the cart before adding new items or starting over.

Action Parameters

cart_id
stringRequired

Action Response

data
object
error
string
message
string
success
booleanRequired
successful
booleanRequired

Tool Name: Create Category

Description

Tool to create a new category. use when you need to add organizational structure to your product catalog.

Action Parameters

description
string
image
string
meta_description
string
meta_keywords
string
meta_title
string
parent_id
integer
position
integer
title
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Customer

Description

Tool to create a new customer in cloudcart. use when you need to register a new customer profile. provide validated customer details (name, email, and password).

Action Parameters

address
string
email
stringRequired
name
stringRequired
password
stringRequired
phone
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Order

Description

Tool to create a new order. use after assembling customer id, cart items, and optional addresses/payment info.

Action Parameters

billing_address
object
currency
customer_id
integerRequired
items
arrayRequired
payment_method
string
shipping_address
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Product

Description

Tool to create a new product. use when you have all details and want to add it to cloudcart.

Action Parameters

barcode
string
categories
array
description
string
images
array
name
stringRequired
price
numberRequired
quantity
integer
sku
string
status
string
tags
array
vendor
string
weight
number

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Category

Description

Tool to delete a category by its id. use after confirming the correct id to permanently remove it.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Customer

Description

Tool to delete a customer. use when you need to remove a customer by their id. example: "delete customer with id 123".

Action Parameters

customer_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Order

Description

Tool to delete an order. use after confirming the order exists.

Action Parameters

order_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Product

Description

Tool to delete a product by its id. use after confirming the product exists to permanently remove it from the catalog.

Action Parameters

product_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Cart

Description

Tool to retrieve the current shopping cart. use when you need to view or verify the cart contents before checkout.

Action Parameters

cart_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Categories

Description

Tool to retrieve a list of all categories. use when you need to list available categories for selection.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Customers

Description

Tool to retrieve a list of all customers. use when you need to display or process multiple customer profiles. note: the response is paginated; use page[number] and page[size] to control pagination.

Action Parameters

filter[email]
string
filter[name]
string
page[number]
integer
page[size]
integer
sort
string

Action Response

data
arrayRequired
error
string
links
object
meta
objectRequired
successful
booleanRequired

Tool Name: Get Orders

Description

Tool to retrieve a list of all orders. use when you need to collect orders for processing. returns json api order resources including id, type, and attributes. ensure authentication before calling.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get Payment Methods

Description

Tool to retrieve all available payment methods. use when you need to list supported payment options before checkout.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Products

Description

Tool to retrieve a list of products with optional filters. use when you need a paginated catalog of products (e.g., by page, category, price range).

Action Parameters

brand_id
integer
category_id
integer
limit
integer
max_price
number
min_price
number
page
integer
search
string
with_hidden
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Product With Relations

Description

Tool to retrieve a product with related entities. use when detailed product information is needed after obtaining its id.

Action Parameters

product_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Shipping Methods

Description

Tool to retrieve all available shipping methods. use when you need to list shipping options before checkout.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Order Payment

Description

Tool to retrieve a list of order payments. use when you need to view payments for orders, optionally filtered by order id or status. useful after creating or updating orders to inspect their payment history.

Action Parameters

limit
integer
order_id
integer
page
integer
status
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove from Cart

Description

Tool to remove an item from the cart. use after confirming the product exists in the cart to delete it.

Action Parameters

product_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Cart Item

Description

Tool to update the quantity of an item in the cart. use when you need to adjust item quantities in the cart before checkout.

Action Parameters

product_id
integerRequired
quantity
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Category

Description

Tool to update an existing category. use when you need to modify category details after reviewing its current values.

Action Parameters

description
string
id
stringRequired
image
string
meta_description
string
meta_keywords
string
meta_title
string
parent_id
integer
position
integer
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Customer

Description

Tool to update an existing customer. use when modifying customer details like name, email, or address.

Action Parameters

address
string
customer_id
integerRequired
email
string
name
string
password
string
phone
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Order

Description

Tool to update an existing order. use when you need to modify order details after creation (e.g., change status or addresses). provide only the fields you wish to change.

Action Parameters

attributes
objectRequired
order_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Product

Description

Tool to update an existing product's details. use when you need to modify product information after confirming the product id.

Action Parameters

category_id
string
description
string
images
array
name
string
price
number
product_id
stringRequired
stock
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Variant

Description

Tool to create a new product variant for a given product. use when you need to add a variant with specific sku, price, and options.

Action Parameters

option_values
array
price
numberRequired
productId
stringRequired
quantity
integer
sku
stringRequired
weight
number

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Variant Option

Description

Tool to create a new variant option for a specific product variant. use when you need to add an option (e.g., 'large') with an optional price adjustment to an existing variant.

Action Parameters

is_default
boolean
name
stringRequired
position
integer
price
number
product_id
integerRequired
variant_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Variant Parameter

Description

Tool to create a new variant parameter for a product variant. use when you need to add custom attributes (e.g., color, size) after a variant is created.

Action Parameters

name
stringRequired
productId
stringRequired
type
string
value
stringRequired
variantId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Vendor

Description

Tool to create a new vendor via cloudcart api. use when adding a new brand or partner entity to your store.

Action Parameters

data
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Vendor

Description

Tool to delete a vendor by its id. use when removing an obsolete vendor from the store.

Action Parameters

vendor_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Property Options Relationship

Description

Tool to retrieve property options relationship for a product. use when you need to fetch which property options are assigned to a product after confirming it exists.

Action Parameters

product_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Vendor

Description

Tool to retrieve details of a specific vendor. use when you have the vendor id.

Action Parameters

vendor_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Vendors

Description

Tool to retrieve a list of all vendors. use when you need a paginated list of vendors or filter by name/status. example: "list active vendors on page 2."

Action Parameters

limit
integer
page
integer
search
string
status
string

Action Response

data
arrayRequired
error
string
limit
integerRequired
page
integerRequired
successful
booleanRequired
total
integerRequired

Tool Name: Update Vendor

Description

Tool to update an existing vendor. use when vendor details change and need saving. call after confirming the vendor id.

Action Parameters

data
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired