> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to CloudCart

The CloudCart connector lets your AI agent act in each user's CloudCart account. Each user connects their own CloudCart API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 58 tools.

**Authentication:** API Key
**Categories:** CRM & Sales
**Tools:** 58: 30 read, 19 write, 9 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=CLOUDCART)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the CloudCart connection

   In **AgentKit > Connections**, create a CloudCart connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'cloudcart'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize CloudCart:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'cloudcart_categories_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "cloudcart"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize CloudCart:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="cloudcart_categories_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their CloudCart credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'cloudcart_categories_list',
  toolInput: {},
  connector: 'cloudcart',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="cloudcart_categories_list",
    tool_input={},
    connection_name="cloudcart",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `cloudcart_categories_list`

List Categories · Read-only

List the product categories of a CloudCart store.
Returns categories with name, slug, description, order and parent ID.
Use this to find category IDs for products and discounts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_parent_id` (`string`, optional): Only children of this category ID. Example: 3.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.
- `sort` (`string`, optional): Sort field, with a leading - for descending. Allowed: name, order, id. Example: -name.

Example input: `{}`

### `cloudcart_category_get`

Get Category · Read-only

Get one CloudCart category.
Returns the category's name, slug, description, image and parent.
Use this for a category's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the category, from cloudcart_categories_list. Example: 1042.

Example input: `{"id":"<id>"}`

### `cloudcart_customer_get`

Get Customer · Read-only

Get one CloudCart customer.
Returns the customer's details; include adds orders, addresses and group.
Use this for a customer's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the customer, from cloudcart_customers_list. Example: 1042.
- `include` (`string`, optional): Related resources to include, comma-separated: orders, shipping-addresses, billing-addresses, group. Example: orders.

Example input: `{"id":"<id>"}`

### `cloudcart_customer_groups_list`

List Customer Groups · Read-only

List the customer groups of a CloudCart store.
Returns groups with name and discount percent.
Use this to find group IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.

Example input: `{}`

### `cloudcart_customer_shipping_addresses_list`

List Customer Shipping Addresses · Read-only

List saved customer shipping addresses in CloudCart, optionally for one customer.
Returns addresses with name, phone, street, city, postcode and country.
Use this to read a customer's addresses.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_customer_id` (`string`, optional): Only addresses of this customer ID. Example: 1201.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.

Example input: `{}`

### `cloudcart_customers_list`

List Customers · Read-only

List the customers of a CloudCart store, filtered by any column such as email.
Returns customers with name, email, phone, company, marketing opt-in and dates.
Use this to find a customer.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_email` (`string`, optional): Exact email address. Example: jane@example.com.
- `include` (`string`, optional): Related resources to include, comma-separated: orders, shipping-addresses, billing-addresses, group. Example: orders.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.
- `sort` (`string`, optional): Sort field, with a leading - for descending. Allowed: date_added, id. Example: -date_added.

Example input: `{}`

### `cloudcart_discount_codes_list`

List Discount Codes · Read-only

List the percentage discount codes of a CloudCart store.
Returns codes with code, value (10000 = 100%) and active flag.
Use this to review codes.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_code` (`string`, optional): Exact code. Example: SPRING20.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.

Example input: `{}`

### `cloudcart_discount_get`

Get Discount · Read-only

Get one CloudCart discount campaign.
Returns the discount's type, value, target, dates, code, limits and uses.
Use this for a discount's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the discount, from cloudcart_discounts_list. Example: 1042.

Example input: `{"id":"<id>"}`

### `cloudcart_discounts_list`

List Discounts · Read-only

List the discount campaigns of a CloudCart store.
Returns discounts with name, type, value, target, dates, code and uses.
Use this to review promotions.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_active` (`string`, optional): yes for active discounts only. Example: yes.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.

Example input: `{}`

### `cloudcart_order_fulfillments_list`

List Order Fulfillments · Read-only

List CloudCart order fulfillments (shipments with tracking), optionally for one order.
Returns fulfillments with tracking number, URL, company and dates.
Use this to check what has shipped.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_order_id` (`string`, optional): Only fulfillments of this order ID. Example: 5012.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.

Example input: `{}`

### `cloudcart_order_get`

Get Order · Read-only

Get one CloudCart order.
Returns the order with status, customer, invoice and shipping data; include adds line items, payment, totals and addresses.
Use this for an order's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the order, from cloudcart_orders_list. Example: 1042.
- `include` (`string`, optional): Related resources to include, comma-separated: products, payment, totals, shipping, shipping-address, billing-address, discounts, taxes. Example: products.

Example input: `{"id":"<id>"}`

### `cloudcart_order_payments_list`

List Order Payments · Read-only

List CloudCart order payment records, usually for one order.
Returns payments with provider, status, amount and transaction details.
Order sub-resources are read-only; filter them by order with filter_order_id.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_order_id` (`string`, optional): Only the payment of this order ID. Example: 5012.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.

Example input: `{}`

### `cloudcart_order_products_list`

List Order Line Items · Read-only

List CloudCart order line items, usually for one order.
Returns line items with product, variant, SKU, quantity and prices.
Order sub-resources are read-only; filter them by order with filter_order_id.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_order_id` (`string`, optional): Only line items of this order ID. Example: 5012.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.

Example input: `{}`

### `cloudcart_order_return_get`

Get Order Return · Read-only

Get one CloudCart order return.
Returns the return's lines, totals, refund details, status and history.
Use this for a return's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the return, from cloudcart_order_returns_list. Example: 1042.

Example input: `{"id":"<id>"}`

### `cloudcart_order_returns_list`

List Order Returns · Read-only

List CloudCart order returns, optionally by status or order.
Returns returns with type, status, refund method and amount, and dates.
Use this to track returns and refunds.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_order_id` (`string`, optional): Only returns of this order ID. Example: 5012.
- `filter_status` (`string`, optional): pending, returned or cancelled. Example: pending.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.

Example input: `{}`

### `cloudcart_order_shipping_addresses_list`

List Order Shipping Addresses · Read-only

List CloudCart order shipping addresses, usually for one order.
Returns the delivery address with name, phone, street, city, postcode and country.
Order sub-resources are read-only; filter them by order with filter_order_id.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_order_id` (`string`, optional): Only the address of this order ID. Example: 5012.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.

Example input: `{}`

### `cloudcart_order_shipping_list`

List Order Shipping · Read-only

List CloudCart order shipping records, usually for one order.
Returns the shipping provider, method and price.
Order sub-resources are read-only; filter them by order with filter_order_id.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_order_id` (`string`, optional): Only the shipping of this order ID. Example: 5012.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.

Example input: `{}`

### `cloudcart_order_statuses_list`

List Order Statuses · Read-only

List the order statuses configured in the CloudCart store.
Returns statuses with ID and name.
Use this to get valid status IDs; they differ per store.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `cloudcart_orders_list`

List Orders · Read-only

List the orders of a CloudCart store, filtered by status, customer or date range, with sorting and related data.
Returns orders with status, fulfillment status, customer details, currency, invoice data and dates.
Use this to find orders. Use include=products,totals for line items and totals.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_customer_id` (`string`, optional): Only orders of this customer ID. Example: 1201.
- `filter_end_date` (`string`, optional): Orders placed on or before this date, YYYY-MM-DD. Example: 2026-11-30.
- `filter_start_date` (`string`, optional): Orders placed on or after this date, YYYY-MM-DD. Example: 2026-11-01.
- `filter_status` (`string`, optional): Order status ID, from cloudcart_order_statuses_list. Example: 5.
- `filter_status_fulfillment` (`string`, optional): unfulfilled, partial or fulfilled. Example: unfulfilled.
- `include` (`string`, optional): Related resources to include, comma-separated: products, payment, totals, shipping, shipping-address, billing-address, discounts, taxes. Example: products.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.
- `sort` (`string`, optional): Sort field, with a leading - for descending. Allowed: date_added, id. Example: -date_added.

Example input: `{}`

### `cloudcart_payment_providers_list`

List Payment Providers · Read-only

List the payment providers configured in the CloudCart store.
Returns providers with key, name and status.
Use this to see how customers can pay.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.

Example input: `{}`

### `cloudcart_posts_list`

List Blog Posts · Read-only

List the blog posts of a CloudCart store.
Returns posts with title, slug, content summary, blog and dates.
Use this to review store content.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.

Example input: `{}`

### `cloudcart_product_get`

Get Product · Read-only

Get one CloudCart product.
Returns the product with name, description, flags, price range and relationships; include=variants adds SKUs, prices and stock.
Use this for a product's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the product, from cloudcart_products_list. Example: 1042.
- `include` (`string`, optional): Related resources to include, comma-separated: variants, images, variants.images, property-options, product-to-discount. Example: variants.

Example input: `{"id":"<id>"}`

### `cloudcart_products_list`

List Products · Read-only

List the products of a CloudCart store, with filtering by any column, SKU or barcode, sorting and related data.
Returns products with name, flags, price range and relationship IDs, plus meta.total_count and paging links.
Use this to find products. Use include=variants for SKUs, prices and stock.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_active` (`string`, optional): yes for published products only, no for unpublished. Example: yes.
- `filter_barcode` (`string`, optional): Only the product that has a variant with this barcode. Example: 5901234123457.
- `filter_sku` (`string`, optional): Only the product that has a variant with this SKU. Example: CWS-TEE-S.
- `filter_url_handle` (`string`, optional): Look up a product by URL slug. Example: organic-cotton-hoodie.
- `include` (`string`, optional): Related resources to include, comma-separated: variants, images, variants.images, property-options. Example: variants.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.
- `sort` (`string`, optional): Sort field, with a leading - for descending. Allowed: date_added, name, date_modified, sort_order, views, id. Example: -date_added.

Example input: `{}`

### `cloudcart_redirects_list`

List Redirects · Read-only

List the URL redirects of a CloudCart store.
Returns redirects with old URL, new URL and type.
Use this to review redirects.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.

Example input: `{}`

### `cloudcart_segments_list`

List Segments · Read-only

List the customer segments (regular and automated) of a CloudCart store.
Returns segments with name and type.
Use this to see audience segments.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.

Example input: `{}`

### `cloudcart_shipping_providers_list`

List Shipping Providers · Read-only

List the shipping providers configured in the CloudCart store.
Returns providers with key, name and status.
Use this to see available carriers.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.

Example input: `{}`

### `cloudcart_subscribers_list`

List Subscribers · Read-only

List the newsletter subscribers of a CloudCart store.
Returns subscribers with name, email, phone, country, source and email stats.
Use this to read the marketing audience.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_email` (`string`, optional): Exact email address. Example: jane@example.com.
- `include` (`string`, optional): Related resources to include, comma-separated: channels, tags. Example: channels.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.

Example input: `{}`

### `cloudcart_variant_get`

Get Variant · Read-only

Get one CloudCart variant.
Returns the variant's SKU, price in cents, quantity, weight, barcode and option values.
Use this for a variant's details.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the variant, from cloudcart_variants_list. Example: 1042.

Example input: `{"id":"<id>"}`

### `cloudcart_variants_list`

List Variants · Read-only

List CloudCart product variants (the purchasable items with SKU, price and stock), optionally for one product or SKU.
Returns variants with SKU, price in cents, quantity, weight, barcode and option values.
Use this to check stock and prices.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter_item_id` (`string`, optional): Only variants of this product ID. Example: 1042.
- `filter_sku` (`string`, optional): Only the variant with this SKU. Example: CWS-TEE-M.
- `include` (`string`, optional): Related resources to include, comma-separated: product, images. Example: product.
- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.

Example input: `{}`

### `cloudcart_vendors_list`

List Vendors · Read-only

List the vendors (brands) of a CloudCart store.
Returns vendors with name, slug, description and image.
Use this to find vendor IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page_number` (`integer`, optional): Page number, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Results per page, up to 100. Example: 25.
- `sort` (`string`, optional): Sort field, with a leading - for descending. Allowed: name, id. Example: -name.

Example input: `{}`

### `cloudcart_category_create`

Create Category · Write

Create a CloudCart product category, optionally under a parent category.
Returns the created category with its ID.
Use this to organize products.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Category name, at least 2 characters. Example: Hoodies.
- `description` (`string`, optional): Category description, HTML allowed. Example: Warm hoodies for every season.
- `image_url` (`string`, optional): Public URL of a category image; CloudCart downloads and hosts it. Example: https://example.com/img/hoodies.jpg.
- `meta_description` (`string`, optional): SEO meta description. Example: Shop organic cotton hoodies.
- `order` (`integer`, optional): Sort position among sibling categories. Example: 1.
- `page_title` (`string`, optional): SEO page title. Example: Hoodies | My Store.
- `parent_id` (`string`, optional): ID of the parent category; leave empty for a top-level category. Example: 3.
- `url_handle` (`string`, optional): URL slug; generated from the name if empty. Example: hoodies.

Example input: `{"name":"<name>"}`

### `cloudcart_category_update`

Update Category · Write

Update a CloudCart category's name, description, slug, image, SEO fields or parent.
Returns the updated category.
Use this to edit or move a category.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the category, from cloudcart_categories_list. Example: 1042.
- `description` (`string`, optional): Category description, HTML allowed. Example: Warm hoodies for every season.
- `image_url` (`string`, optional): Public URL of a category image; CloudCart downloads and hosts it. Example: https://example.com/img/hoodies.jpg.
- `meta_description` (`string`, optional): SEO meta description. Example: Shop organic cotton hoodies.
- `name` (`string`, optional): Category name, at least 2 characters. Example: Hoodies.
- `order` (`integer`, optional): Sort position among sibling categories. Example: 1.
- `page_title` (`string`, optional): SEO page title. Example: Hoodies | My Store.
- `parent_id` (`string`, optional): ID of the parent category; leave empty for a top-level category. Example: 3.
- `url_handle` (`string`, optional): URL slug; generated from the name if empty. Example: hoodies.

Example input: `{"id":"<id>"}`

### `cloudcart_customer_create`

Create Customer · Write

Create a CloudCart customer account.
Returns the created customer with its ID.
Use this to add a customer, optionally into a customer group.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email` (`string`, required): Email address, unique (required). Example: jane@example.com.
- `accepts_marketing` (`boolean`, optional): True if the customer opted in to marketing emails. Example: true.
- `company` (`string`, optional): Company name. Example: Acme Ltd.
- `first_name` (`string`, optional): First name. Example: Jane.
- `group_id` (`string`, optional): ID of the customer group, from cloudcart_customer_groups_list. Example: 2.
- `last_name` (`string`, optional): Last name. Example: Doe.
- `note` (`string`, optional): Internal staff note. Example: Wholesale lead.
- `phone` (`string`, optional): Phone number. Example: +359888123456.

Example input: `{"email":"<email>"}`

### `cloudcart_customer_group_create`

Create Customer Group · Write

Create a CloudCart customer group with an optional discount for all its members.
Returns the created group with its ID.
Use this for wholesale or VIP pricing tiers.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Group name, unique. Example: Wholesale.
- `discount_percent` (`string`, optional): Discount for all members as a decimal string. Example: 10.00.

Example input: `{"name":"<name>"}`

### `cloudcart_customer_update`

Update Customer · Write

Update a CloudCart customer's name, email, phone, company, marketing opt-in, note or group.
Returns the updated customer.
Use this to edit a customer or move them to another group.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the customer, from cloudcart_customers_list. Example: 1042.
- `accepts_marketing` (`boolean`, optional): True if the customer opted in to marketing emails. Example: true.
- `company` (`string`, optional): Company name. Example: Acme Ltd.
- `email` (`string`, optional): Email address, unique. Example: jane@example.com.
- `first_name` (`string`, optional): First name. Example: Jane.
- `group_id` (`string`, optional): ID of the customer group, from cloudcart_customer_groups_list. Example: 2.
- `last_name` (`string`, optional): Last name. Example: Doe.
- `note` (`string`, optional): Internal staff note. Example: Wholesale lead.
- `phone` (`string`, optional): Phone number. Example: +359888123456.

Example input: `{"id":"<id>"}`

### `cloudcart_discount_code_create`

Create Discount Code · Write

Create a CloudCart percentage discount code customers enter at checkout.
Returns the created code.
Use this for a single code. Use cloudcart_discount_codes_generate for many unique codes.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `active` (`integer`, required): 1 active or 0 disabled. Example: 1. One of: `0`, `1`.
- `code` (`string`, required): Code, letters and digits only, up to 20 characters, unique. Example: SPRING20.
- `value` (`integer`, required): Percentage in hundredths, 1 to 10000 (2000 = 20%). Example: 2000.

Example input: `{"active":1,"code":"<code>","value":2000}`

### `cloudcart_discount_codes_generate`

Generate Discount Codes · Write

Generate up to 1,000 unique random CloudCart percentage discount codes at once.
Returns the generated codes.
Use this for gift cards or one-time promo codes.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `count` (`integer`, required): Number of codes to generate, 1 to 1000. Example: 50.
- `value` (`integer`, required): Percentage in hundredths for all codes, 1 to 10000 (1000 = 10%). Example: 1000.

Example input: `{"count":50,"value":1000}`

### `cloudcart_discount_create`

Create Discount · Write

Create a CloudCart discount campaign: fixed prices, a percentage, a flat amount or free shipping, for all products, categories, vendors, products or orders over an amount.
Returns the created discount with its ID.
Use this for sales and promotions. Use cloudcart_discount_code_create for a simple percentage code.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `date_start` (`string`, required): Start date, YYYY-MM-DD. Example: 2026-11-27.
- `discount_type` (`string`, required): fixed, percent, flat, shipping or code-pro. Example: percent. One of: `fixed`, `percent`, `flat`, `shipping`, `code-pro`.
- `name` (`string`, required): Discount name, 2 to 191 characters. Example: Black Friday 20%.
- `active` (`string`, optional): yes or no. Example: yes. One of: `yes`, `no`.
- `code` (`string`, optional): Discount code customers enter, letters and digits, up to 20 characters; not allowed with fixed. Example: BF2026.
- `date_end` (`string`, optional): End date, YYYY-MM-DD; empty for no end. Example: 2026-11-30.
- `max_uses` (`integer`, optional): Maximum number of uses. Example: 500.
- `order_over` (`integer`, optional): Minimum order amount in cents, with target type order_over. Example: 5000.
- `target` (`object`, optional): What the discount applies to: an object with type (all, product, category, vendor, category_vendor or order_over) and the matching products, categories or vendors ID arrays. Required for percent, flat and shipping. Example: {"type": "category", "categories": [10]}
- `type_value` (`integer`, optional): Value: for percent in hundredths of a percent (2000 = 20%), for flat in cents. Required for percent and flat. Example: 2000.

Example input: `{"date_start":"<date_start>","discount_type":"fixed","name":"<name>"}`

### `cloudcart_order_fulfill`

Fulfill Order · Write

Mark a CloudCart order as fulfilled, which runs the store's fulfillment workflows and notifications.
Returns the updated order.
Use this when the whole order has shipped. Use cloudcart_order_fulfillment_create to record tracking details.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the order, from cloudcart_orders_list. Example: 1042.

Example input: `{"id":"<id>"}`

### `cloudcart_order_fulfillment_create`

Create Order Fulfillment · Write

Record a shipment for a CloudCart order with its tracking number, link, carrier and dates.
Returns the created fulfillment.
Use this when an order ships. Use cloudcart_order_update to change its status too.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `order_id` (`string`, required): ID of the order that shipped. Example: 5012.
- `shipping_tracking_number` (`string`, required): Tracking number. Example: ECN-BG-1234567890.
- `shipping_date_delivery` (`string`, optional): Expected delivery date, YYYY-MM-DD. Example: 2026-11-19.
- `shipping_date_expedition` (`string`, optional): Dispatch date, YYYY-MM-DD. Example: 2026-11-17.
- `shipping_tracking_company` (`string`, optional): Carrier name. Example: Econt.
- `shipping_tracking_url` (`string`, optional): Tracking page URL. Example: https://www.econt.com/services/track-shipment?id=1234567890.

Example input: `{"order_id":"<order_id>","shipping_tracking_number":"<shipping_tracking_number>"}`

### `cloudcart_order_return_create`

Create Order Return · Write

Record a full or partial return for a CloudCart order.
Returns the created return with status pending.
Use this when a customer sends goods back; give line_selections for a partial return.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `order_id` (`string`, required): ID of the order the return comes from. Example: 5012.
- `line_selections` (`object`, optional): Lines to return as an object of order line item ID to quantity, from cloudcart_order_products_list. Example: {"88001": 1}
- `reason` (`string`, optional): Reason for the return. Example: Wrong size.
- `refund_method` (`string`, optional): How the money goes back: card, bank, wallet, voucher or none. Example: card. One of: `card`, `bank`, `wallet`, `voucher`, `none`.
- `return_type` (`string`, optional): full or partial; defaults to partial when line_selections is given. Example: partial. One of: `full`, `partial`.

Example input: `{"order_id":"<order_id>"}`

### `cloudcart_order_update`

Update Order · Write

Update a CloudCart order's status, internal note, invoice number (write-once) or shipping dates.
Returns the updated order.
Use this to move an order to another status. Use cloudcart_order_statuses_list for status IDs.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the order, from cloudcart_orders_list. Example: 1042.
- `invoice_number` (`string`, optional): Invoice number; can be set only once and must be unique. Example: INV-2026-0042.
- `note` (`string`, optional): Internal staff note, not shown to the customer. Example: Packed by Maria.
- `shipping_date` (`string`, optional): Actual shipping date, YYYY-MM-DD HH:MM:SS. Example: 2026-11-17 10:00:00.
- `status` (`string`, optional): New order status ID, from cloudcart_order_statuses_list; transitions are validated. Example: 5.

Example input: `{"id":"<id>"}`

### `cloudcart_product_create`

Create Product · Write

Create a CloudCart product in a category; prices, SKUs and stock live on variants.
Returns the created product with its ID.
Use this, then cloudcart_variant_create to add at least one purchasable variant with a price.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `category_id` (`string`, required): ID of the product's primary category, from cloudcart_categories_list (required on create). Example: 10.
- `name` (`string`, required): Product title, at least 2 characters. Example: Organic Cotton Hoodie.
- `active` (`string`, optional): yes publishes the product in the storefront. Example: yes. One of: `yes`, `no`.
- `continue_selling` (`string`, optional): yes allows orders when out of stock. Example: no. One of: `yes`, `no`.
- `description` (`string`, optional): Full description, HTML allowed. Example: Soft organic cotton hoodie.
.
- `digital` (`string`, optional): yes for a digital product that skips shipping. Example: no. One of: `yes`, `no`.
- `draft` (`string`, optional): yes keeps the product as a draft. Example: no. One of: `yes`, `no`.
- `new` (`string`, optional): yes shows the new badge. Example: yes. One of: `yes`, `no`.
- `sale` (`string`, optional): yes shows the sale badge. Example: no. One of: `yes`, `no`.
- `shipping` (`string`, optional): yes if the product needs shipping. Example: yes. One of: `yes`, `no`.
- `sort_order` (`integer`, optional): Position in category listings; lower comes first. Example: 10.
- `tracking` (`string`, optional): yes turns on inventory tracking. Example: yes. One of: `yes`, `no`.
- `url_handle` (`string`, optional): URL slug (letters, digits, dashes, underscores); generated from the name if empty. Example: organic-cotton-hoodie.
- `vendor_id` (`string`, optional): ID of the product's vendor (brand), from cloudcart_vendors_list. Example: 7.

Example input: `{"category_id":"<category_id>","name":"<name>"}`

### `cloudcart_product_update`

Update Product · Write

Update a CloudCart product's name, description, flags (active, draft, sale, new), category or vendor.
Returns the updated product.
Use this to publish, hide or edit a product. Use cloudcart_variant_update to change price or stock.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the product, from cloudcart_products_list. Example: 1042.
- `active` (`string`, optional): yes publishes the product in the storefront. Example: yes. One of: `yes`, `no`.
- `category_id` (`string`, optional): ID of the product's primary category, from cloudcart_categories_list. Example: 10.
- `continue_selling` (`string`, optional): yes allows orders when out of stock. Example: no. One of: `yes`, `no`.
- `description` (`string`, optional): Full description, HTML allowed. Example: Soft organic cotton hoodie.
.
- `digital` (`string`, optional): yes for a digital product that skips shipping. Example: no. One of: `yes`, `no`.
- `draft` (`string`, optional): yes keeps the product as a draft. Example: no. One of: `yes`, `no`.
- `name` (`string`, optional): Product title, at least 2 characters. Example: Organic Cotton Hoodie.
- `new` (`string`, optional): yes shows the new badge. Example: yes. One of: `yes`, `no`.
- `sale` (`string`, optional): yes shows the sale badge. Example: no. One of: `yes`, `no`.
- `shipping` (`string`, optional): yes if the product needs shipping. Example: yes. One of: `yes`, `no`.
- `sort_order` (`integer`, optional): Position in category listings; lower comes first. Example: 10.
- `tracking` (`string`, optional): yes turns on inventory tracking. Example: yes. One of: `yes`, `no`.
- `url_handle` (`string`, optional): URL slug (letters, digits, dashes, underscores); generated from the name if empty. Example: organic-cotton-hoodie.
- `vendor_id` (`string`, optional): ID of the product's vendor (brand), from cloudcart_vendors_list. Example: 7.

Example input: `{"id":"<id>"}`

### `cloudcart_redirect_create`

Create Redirect · Write

Create a CloudCart URL redirect from an old path to a new URL.
Returns the created redirect.
Use this after renaming or removing pages.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `new_url` (`string`, required): Path or full URL to redirect to. Example: /category/hoodies.
- `old_url` (`string`, required): Old path to redirect from, unique. Example: /old-hoodies.
- `redirect_type` (`string`, required): Target type: manual (new_url is a path) or external (new_url is a full URL). Example: manual. One of: `manual`, `external`.

Example input: `{"new_url":"<new_url>","old_url":"<old_url>","redirect_type":"manual"}`

### `cloudcart_subscriber_create`

Create Subscriber · Write

Add a newsletter subscriber to a CloudCart store.
Returns the created subscriber with its ID.
Use this to sign someone up for marketing.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `country` (`string`, required): Country code or name. Example: BG.
- `email` (`string`, optional): Email address. Example: jane@example.com.
- `first_name` (`string`, optional): First name. Example: Jane.
- `last_name` (`string`, optional): Last name. Example: Doe.
- `phone` (`string`, optional): Phone number. Example: +359888123456.
- `subscribed_from` (`string`, optional): Source of the subscription; API if empty. Example: Website popup.

Example input: `{"country":"<country>"}`

### `cloudcart_variant_create`

Create Variant · Write

Create a variant (a purchasable SKU with price and stock) for a CloudCart product.
Returns the created variant with its ID.
Use this after cloudcart_product_create; a product with variant parameters needs option values on each variant.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `product_id` (`string`, required): ID of the parent product (required on create). Example: 1042.
- `barcode` (`string`, optional): Barcode (EAN, UPC, ISBN). Example: 5901234123457.
- `delivery_price` (`integer`, optional): Delivery surcharge in cents. Example: 0.
- `option1_id` (`string`, optional): ID of the first variant option value (such as size M), from the product's variant parameters. Example: 301.
- `price` (`integer`, optional): Price in cents, such as 2999 for 29.99. Example: 2999.
- `quantity` (`number`, optional): Available stock. Example: 70.
- `sku` (`string`, optional): Stock keeping unit. Example: CWS-TEE-M.
- `weight` (`integer`, optional): Weight in grams. Example: 250.

Example input: `{"product_id":"<product_id>"}`

### `cloudcart_variant_update`

Update Variant · Write

Update a CloudCart variant's SKU, price, stock, weight or barcode.
Returns the updated variant.
Use this to change prices or stock levels.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the variant, from cloudcart_variants_list. Example: 1042.
- `barcode` (`string`, optional): Barcode (EAN, UPC, ISBN). Example: 5901234123457.
- `delivery_price` (`integer`, optional): Delivery surcharge in cents. Example: 0.
- `option1_id` (`string`, optional): ID of the first variant option value (such as size M), from the product's variant parameters. Example: 301.
- `price` (`integer`, optional): Price in cents, such as 2999 for 29.99. Example: 2999.
- `quantity` (`number`, optional): Available stock. Example: 70.
- `sku` (`string`, optional): Stock keeping unit. Example: CWS-TEE-M.
- `weight` (`integer`, optional): Weight in grams. Example: 250.

Example input: `{"id":"<id>"}`

### `cloudcart_vendor_create`

Create Vendor · Write

Create a CloudCart vendor (brand).
Returns the created vendor with its ID.
Use this before linking products to a brand.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Vendor or brand name, at least 2 characters. Example: Patagonia.
- `description` (`string`, optional): Vendor description, HTML allowed. Example: Outdoor clothing brand.
- `image_url` (`string`, optional): Public URL of the vendor logo; CloudCart downloads and hosts it. Example: https://example.com/img/brand.png.

Example input: `{"name":"<name>"}`

### `cloudcart_category_delete`

Delete Category · Destructive

Delete a CloudCart category.
Returns an empty success response.
Use this to remove an empty category.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the category, from cloudcart_categories_list. Example: 1042.

Example input: `{"id":"<id>"}`

### `cloudcart_customer_delete`

Delete Customer · Destructive

Delete a CloudCart customer account.
Returns an empty success response.
Use this to remove a customer for good.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the customer, from cloudcart_customers_list. Example: 1042.

Example input: `{"id":"<id>"}`

### `cloudcart_discount_code_delete`

Delete Discount Code · Destructive

Delete a CloudCart discount code.
Returns an empty success response.
Use this to retire a code.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the discount code, from cloudcart_discount_codes_list. Example: 1042.

Example input: `{"id":"<id>"}`

### `cloudcart_discount_delete`

Delete Discount · Destructive

Delete a CloudCart discount campaign.
Returns an empty success response.
Use this to end and remove a promotion.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the discount, from cloudcart_discounts_list. Example: 1042.

Example input: `{"id":"<id>"}`

### `cloudcart_product_delete`

Delete Product · Destructive

Delete a CloudCart product and its variants.
Returns an empty success response.
Use this to remove a product for good. Use cloudcart_product_update with active no to hide it instead.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the product, from cloudcart_products_list. Example: 1042.

Example input: `{"id":"<id>"}`

### `cloudcart_redirect_delete`

Delete Redirect · Destructive

Delete a CloudCart URL redirect.
Returns an empty success response.
Use this to remove a redirect.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the redirect, from cloudcart_redirects_list. Example: 1042.

Example input: `{"id":"<id>"}`

### `cloudcart_subscriber_delete`

Delete Subscriber · Destructive

Delete a CloudCart newsletter subscriber.
Returns an empty success response.
Use this to remove someone from marketing.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the subscriber, from cloudcart_subscribers_list. Example: 1042.

Example input: `{"id":"<id>"}`

### `cloudcart_variant_delete`

Delete Variant · Destructive

Delete a CloudCart variant.
Returns an empty success response.
Use this to remove a size or color that is no longer sold.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the variant, from cloudcart_variants_list. Example: 1042.

Example input: `{"id":"<id>"}`

### `cloudcart_vendor_delete`

Delete Vendor · Destructive

Delete a CloudCart vendor.
Returns an empty success response.
Use this to remove a brand.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the vendor, from cloudcart_vendors_list. Example: 1042.

Example input: `{"id":"<id>"}`

## Related

Other CRM & Sales connectors ([all 174](/agentkit/connectors/?category=crm-sales)):

- [Salesforce](/agentkit/connectors/salesforce/): Scalekit connector, OAuth, 74 tools
- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [Close](/agentkit/connectors/close/): Scalekit connector, OAuth, 103 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
