# Cloudcart

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

- **Category:** ecommerce
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 150
- **Triggers:** 0
- **Slug:** `CLOUDCART`
- **Version:** 20260316_00

## Tools

### Add Category Properties

**Slug:** `CLOUDCART_ADD_CATEGORY_PROPERTIES`

Tool to add properties to a category relationship. Use when you need to associate one or more properties with a category for filtering or organization purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | string | Yes | The unique identifier of the category to add properties to |
| `property_ids` | array | Yes | List of property IDs to associate with the category |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add to Cart

**Slug:** `CLOUDCART_ADD_TO_CART`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quantity` | integer | Yes | The number of units of the product to add, must be at least 1. |
| `product_id` | integer | Yes | The unique identifier of the product to be added to the cart. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clear Cart

**Slug:** `CLOUDCART_CLEAR_CART`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Blog Category

**Slug:** `CLOUDCART_CREATE_BLOG_CATEGORY`

Tool to create a new blog category in CloudCart. Use when you need to organize blog posts into categories. Requires a category name and optionally accepts an image URL for visual representation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | A human readable name for this blog category |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Blog Post

**Slug:** `CLOUDCART_CREATE_BLOG_POST`

Tool to create a new blog post in CloudCart. Use when you need to publish blog content to your store. Requires post title, content, blog ID, and author ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Title of the blog post. |
| `blog_id` | string | Yes | ID of the blog to associate this post with. Required to publish the post to a specific blog. |
| `content` | string | Yes | Content/body text of the blog post. Supports HTML formatting. |
| `tag_ids` | array | No | List of tag IDs to associate with this post for categorization and filtering. |
| `author_id` | string | Yes | ID of the author to assign to this post. Required to attribute the post to an author. |
| `image_url` | string | No | URL of the featured image for the blog post. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Blog Tag

**Slug:** `CLOUDCART_CREATE_BLOG_TAGS`

Tool to create a new blog tag in CloudCart. Use when you need to add tags for organizing blog content. Tags help categorize and filter blog posts for better content discovery.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data wrapper for create blog tag request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Category

**Slug:** `CLOUDCART_CREATE_CATEGORY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Title of the category |
| `position` | integer | No | Sorting position of the category (0 = first) |
| `meta_title` | string | No | SEO meta title |
| `description` | string | No | Detailed description of the category |
| `meta_keywords` | string | No | Comma-separated SEO keywords |
| `meta_description` | string | No | SEO meta description |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer

**Slug:** `CLOUDCART_CREATE_CUSTOMER`

Tool to create a new customer in CloudCart. Use when you need to register a new customer profile. Provide validated customer details (first name, last name, email, and password). Returns the created customer with their unique ID and timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Customer's email address. |
| `password` | string | Yes | Password for the customer's account. Must be at least 8 characters. |
| `last_name` | string | Yes | Last name of the customer. |
| `first_name` | string | Yes | First name of the customer. |
| `alternative_phone` | string | No | Phone number of the customer. Optional. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer Billing Address

**Slug:** `CLOUDCART_CREATE_CUSTOMER_BILLING_ADDRESS`

Tool to create a new customer billing address. Use when you need to add a billing address for an existing customer. Requires customer ID and address details (name, country, city, street).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phone` | string | No | Phone number |
| `city_name` | string | Yes | City designation |
| `last_name` | string | Yes | Customer's surname |
| `post_code` | string | No | Postal code |
| `first_name` | string | Yes | Customer's given name |
| `customer_id` | string | Yes | Unique identifier of the existing customer to associate this billing address with |
| `street_name` | string | Yes | Street designation |
| `country_iso2` | string | Yes | Official ISO Country Code (2-letter) |
| `street_number` | string | No | Street number |
| `phone_country_iso2` | string | No | Phone country code (2-letter ISO code) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer Groups

**Slug:** `CLOUDCART_CREATE_CUSTOMER_GROUPS`

Tool to create a new customer group in CloudCart. Use when you need to organize customers into categories or segments for targeted marketing, pricing, or permissions. The group name must be unique.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data wrapper for create customer groups request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer Shipping Address

**Slug:** `CLOUDCART_CREATE_CUSTOMER_SHIPPING_ADDRESS`

Tool to create a customer shipping address in CloudCart. Use when you need to add a new delivery address for an existing customer. Requires customer ID and complete address details (name, phone, country, city, street, postal code).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | No | Optional note for delivery instructions |
| `phone` | string | Yes | Customer's telephone number |
| `city_name` | string | Yes | City of the address |
| `last_name` | string | Yes | Customer's surname |
| `post_code` | string | Yes | Postal code |
| `first_name` | string | Yes | Customer's given name |
| `customer_id` | string | Yes | ID of the customer this address belongs to |
| `street_name` | string | Yes | Street designation |
| `country_iso2` | string | Yes | ISO 3166-1 alpha-2 country code for the address location |
| `street_number` | string | Yes | Building number |
| `phone_country_iso2` | string | Yes | ISO 3166-1 alpha-2 country code for phone validation |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer Tag

**Slug:** `CLOUDCART_CREATE_CUSTOMER_TAGS`

Tool to create a new customer tag in CloudCart. Use when you need to add tags for organizing and categorizing customers. Tags can be used for filtering, grouping, or marketing purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | Yes | The tag label to be created for customers |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Discount

**Slug:** `CLOUDCART_CREATE_DISCOUNT`

Tool to create a new discount in CloudCart. Use when you need to add promotional discounts, sales, or special offers. Supports various discount types (fixed, percent, flat, shipping) and flexible targeting (all products, specific products, categories, or customers).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Optional discount code that customers can use to apply the discount. |
| `name` | string | Yes | Name of the discount for identification purposes. |
| `active` | string | No | Discount active status. Use 'yes' to activate or 'no' to keep inactive. |
| `target` | object | Yes | Target configuration specifying what the discount applies to. |
| `date_end` | string | No | End date of the discount in YYYY-MM-DD format. If not provided, discount has no end date. |
| `max_uses` | integer | No | Maximum number of times this discount can be used in total. |
| `date_start` | string | Yes | Start date of the discount in YYYY-MM-DD format. |
| `order_over` | integer | No | Minimum order amount required for the discount to apply (in smallest currency unit). |
| `type_value` | integer | Yes | Value of the discount. For 'percent' type, use basis points (e.g., 1000 = 10%). For 'fixed' type, use the amount in smallest currency unit (e.g., cents). |
| `discount_type` | string ("fixed" | "percent" | "flat" | "shipping") | Yes | Type of discount to apply. 'fixed' for fixed amount, 'percent' for percentage, 'flat' for flat discount, 'shipping' for shipping discount. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Discount Code

**Slug:** `CLOUDCART_CREATE_DISCOUNT_CODE`

Create a new discount code in CloudCart. Use when you need to add promotional discount codes to the store. The value represents the discount percentage multiplied by 100 (e.g., 1500 = 15% off).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Unique discount code string (alphanumeric characters recommended) |
| `value` | integer | Yes | Discount percentage multiplied by 100. Example: 10% discount = 1000, 15% discount = 1500 |
| `active` | integer | Yes | Status of the discount code: 1 for active, 0 for inactive |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Image

**Slug:** `CLOUDCART_CREATE_IMAGES`

Tool to create a new image for a product. Use when you need to add an image to an existing product by providing the image URL and product ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `src` | string | Yes | The URL for an image to upload. Must be a valid HTTP/HTTPS URL pointing to an image file. |
| `product_id` | string | Yes | The ID of the product to associate the image with. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Linked Products

**Slug:** `CLOUDCART_CREATE_LINKED_PRODUCTS`

Tool to create linked product relationships in CloudCart. Use when you need to associate related products together, such as complementary items or product bundles. Supports bidirectional linking where linked products reference each other.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | string | Yes | The ID of the source product to add linked products to. |
| `linked_products` | array | Yes | List of products to link. Each item specifies a product ID and optionally whether the link should be bidirectional (two_way=1) or unidirectional (two_way=0). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Order

**Slug:** `CLOUDCART_CREATE_ORDER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | List of line items for the order |
| `currency` | string | No | ISO 4217 currency code |
| `customer_id` | integer | Yes | ID of the customer placing the order |
| `payment_method` | string ("credit_card" | "paypal" | "bank_transfer") | No | Payment method code; if omitted, default store method applies |
| `billing_address` | object | No | Billing address; if omitted, same as shipping_address |
| `shipping_address` | object | No | Shipping address; if omitted, uses customer's default address |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Product

**Slug:** `CLOUDCART_CREATE_PRODUCT`

Creates a new product in CloudCart catalog. Requires product name, price, and at least one category ID. Supports optional fields like SKU, description (HTML allowed), quantity, weight, barcode, status, tags, and images. Use this when you need to add a new product to the store inventory.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sku` | string | No | Stock keeping unit identifier. |
| `name` | string | Yes | Name of the product. |
| `tags` | array | No | List of tags. |
| `price` | number | Yes | Price of the product; must be non-negative. |
| `images` | array | No | List of image URLs. |
| `status` | string | No | Status of the product (e.g., active, draft). |
| `vendor` | string | No | ID of the vendor to associate. |
| `weight` | number | No | Weight in kilograms; must be non-negative. |
| `barcode` | string | No | Barcode (e.g., UPC/EAN). |
| `quantity` | integer | No | Available quantity; must be non-negative. |
| `categories` | array | Yes | List of category IDs to associate (required by API). Note: API currently only supports a single category; providing multiple categories may result in errors. IDs must be numeric integers; use CLOUDCART_GET_CATEGORIES to retrieve valid IDs. Category names or slugs are invalid. |
| `description` | string | No | Description of the product (HTML allowed). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Products Property Options

**Slug:** `CLOUDCART_CREATE_PRODUCTS_PROPERTY_OPTIONS`

Tool to add property options to a product relationship. Use when you need to associate one or more property options with a product for configuration or customization purposes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | string | Yes | The unique identifier of the product to add property options to |
| `property_option_ids` | array | Yes | List of property option IDs to associate with the product |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Product to Discount

**Slug:** `CLOUDCART_CREATE_PRODUCT_TO_DISCOUNT`

Tool to create a product to discount relationship in CloudCart. Use when you need to associate a product variant with a discount and optionally set a discounted price.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `price` | number | No | Optional discounted price for the product variant in currency units (e.g., dollars). Will be converted to cents internally. Must be non-negative. |
| `product_id` | string | Yes | ID of the product to associate with the discount. |
| `variant_id` | string | Yes | ID of the product variant to associate with the discount. |
| `discount_id` | string | Yes | ID of the discount to associate with the product. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Property

**Slug:** `CLOUDCART_CREATE_PROPERTIES`

Tool to create a new property in CloudCart. Properties are attributes that can be assigned to products (e.g., color, size, material). Use when you need to define new product characteristics or attributes for your catalog.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | A human readable name for this property |
| `sort` | integer | No | Sort order for displaying the property |
| `active` | integer | No | Active status: 1 for active, 0 for inactive |
| `is_visible` | integer | No | Visibility flag: 1 for visible, 0 for hidden |
| `url_handle` | string | No | A human readable slug value. Must be unique |
| `display_type` | string ("checkbox" | "select" | "radio" | "range") | Yes | Display type for the property |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Property Option

**Slug:** `CLOUDCART_CREATE_PROPERTY_OPTION`

Tool to create a new property option. Use when you need to add a new option value to a product property (e.g., adding "Red" to a "Color" property or "Large" to a "Size" property).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | integer | No | Sort order ranking for displaying the option |
| `value` | string | Yes | A human readable name for this property option |
| `seo_title` | string | No | SEO Title for the option |
| `url_handle` | string | Yes | A human readable slug value. Must be unique |
| `description` | string | No | Description of the property option. Can be HTML |
| `property_id` | string | Yes | The unique identifier of the property to associate this option with |
| `seo_description` | string | No | SEO Description for the option |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Redirect

**Slug:** `CLOUDCART_CREATE_REDIRECTS`

Create a new URL redirect in CloudCart. Supports five redirect types: 'manual' for custom paths, 'external' for external URLs, and 'product', 'category', or 'vendor' to link to specific store items. Use when you need to redirect old URLs to new locations or specific store resources.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item` | object | No | Relationship to an item (product, category, or vendor) |
| `new_url` | string | No | New URL path or external URL to redirect to. Required for 'manual' and 'external' redirect types. Not used for 'product', 'category', or 'vendor' types (those use item relationship instead). |
| `old_url` | string | Yes | Old URL path to redirect from (must be unique). Include the leading slash. |
| `redirect_type` | string ("product" | "category" | "vendor" | "manual" | "external") | Yes | Type of redirect: 'product' links to a product, 'category' links to a category, 'vendor' links to a vendor, 'manual' is a custom redirect path, 'external' is an external URL redirect |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Subscriber

**Slug:** `CLOUDCART_CREATE_SUBSCRIBERS`

Tool to create a new subscriber in CloudCart. Use when you need to add a subscriber to the mailing list. Provide the subscriber's first name, last name, and two-letter country code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | Yes | Two-letter ISO 3166-1 alpha-2 country code (e.g., 'US' for United States, 'BG' for Bulgaria). |
| `last_name` | string | Yes | The subscriber's family name. |
| `first_name` | string | Yes | The subscriber's given name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Subscriber Channel

**Slug:** `CLOUDCART_CREATE_SUBSCRIBERS_CHANNELS`

Tool to create a new subscriber channel in CloudCart. Use when you need to add a communication channel (email or phone) for a subscriber. Provide the subscriber ID, channel type, contact identifier, and consent flags.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bounced` | string ("0" | "1") | Yes | Bounce status indicator: '0' (not bounced) or '1' (bounced). |
| `channel` | string ("Email" | "Phone") | Yes | Communication channel type: either 'Email' or 'Phone'. |
| `verified` | string ("0" | "1") | Yes | Verification status: '0' (not verified) or '1' (verified). |
| `marketing` | string ("0" | "1") | Yes | Marketing consent flag: '0' (no consent) or '1' (consent given). |
| `subscriber_id` | string | Yes | The subscriber's unique identifier. |
| `channel_identifier` | string | Yes | The actual contact value (email address or phone number) for the specified channel. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Subscriber Tag

**Slug:** `CLOUDCART_CREATE_SUBSCRIBERS_TAGS`

Tool to create a new subscriber-tag association in CloudCart. Use when you need to associate a tag with a subscriber for organizing, categorizing, or filtering subscribers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | Unique identifier of the customer tag to associate with the subscriber |
| `subscriber_id` | string | Yes | Unique identifier of the subscriber to associate with the tag |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Variant

**Slug:** `CLOUDCART_CREATE_VARIANT`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sku` | string | Yes | SKU of the new variant |
| `price` | number | Yes | Price of the variant in currency units (will be converted to smallest unit/cents internally) |
| `weight` | number | No | Weight of the variant in kilograms (will be converted to grams internally) |
| `quantity` | integer | No | Stock quantity for the variant |
| `productId` | string | Yes | ID of the product to which the variant belongs |
| `option_values` | array | No | List of option values objects, each with product_option_id and value_id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Variant Option

**Slug:** `CLOUDCART_CREATE_VARIANT_OPTION`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the variant option |
| `price` | number | No | Price difference for this option |
| `position` | integer | No | The order of the option among siblings |
| `is_default` | boolean | No | Whether this is the default option |
| `product_id` | integer | Yes | ID of the product to which the variant belongs |
| `variant_id` | integer | Yes | ID of the variant for which to create an option |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Variant Options

**Slug:** `CLOUDCART_CREATE_VARIANT_OPTIONS`

Tool to create a new variant option. Use when you need to add a new option (e.g., 'Medium', 'Blue') to an existing variant parameter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | A unique, human-readable name for the variant option |
| `sort` | integer | No | Sort order for displaying this variant option |
| `color` | string | No | Display color for this variant option (e.g., hex color code) |
| `visible` | integer ("0" | "1") | No | Visibility flag: 1 for visible, 0 for hidden |
| `parameter_id` | string | Yes | The ID of the associated variant parameter |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Variant Parameter

**Slug:** `CLOUDCART_CREATE_VARIANT_PARAMETER`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the parameter (e.g., 'color', 'size'). |
| `type` | string ("text" | "number" | "boolean" | "date") | No | Type of the parameter. One of 'text', 'number', 'boolean', or 'date'. |
| `value` | string | Yes | Value of the parameter (e.g., 'red', 'XL'). |
| `productId` | string | Yes | The ID of the product. |
| `variantId` | string | Yes | The ID of the product variant. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Variant Parameter

**Slug:** `CLOUDCART_CREATE_VARIANT_PARAMETERS`

Tool to create a new variant parameter definition. Use when you need to define a new product attribute type (e.g., Size, Color, Material) that can be used across products.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | A unique, human-readable name for the variant parameter (e.g., 'Size', 'Color', 'Material') |
| `display_type` | string ("select" | "radio" | "image" | "color" | "2d" | "numeric_alpha") | Yes | How the variant parameter appears to users in the interface |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Vendor

**Slug:** `CLOUDCART_CREATE_VENDOR`

Create a new vendor in your CloudCart store. Vendors represent brands, manufacturers, or suppliers. The image_url is optional - if not provided, a default placeholder will be used. If provided, it must be a valid, publicly accessible image URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data wrapper for create vendor request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Webhook

**Slug:** `CLOUDCART_CREATE_WEBHOOKS`

Tool to create a new webhook subscription in CloudCart. Use when you need to register a webhook URL for receiving real-time event notifications (e.g., order.created, order.updated). CloudCart will send HTTP POST requests to your webhook URL when the specified event occurs. Retry policy: up to 6 attempts at 60, 120, 180, 240, 300 second intervals.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL endpoint where webhook events will be sent. Must be a valid HTTPS URL. |
| `event` | string | Yes | The event that triggers the webhook. Common events include 'order.created' and 'order.updated', but other events may be supported. |
| `headers` | object | No | Optional custom headers to append to webhook HTTP requests as key-value pairs. |
| `new_version` | integer | No | New version of the orders webhook. Only applies to 'order.created' and 'order.updated' events. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Blog Category

**Slug:** `CLOUDCART_DELETE_BLOG_CATEGORY`

Tool to delete a blog category by its ID. Use after confirming the correct ID to permanently remove it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the blog category to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Blog Post

**Slug:** `CLOUDCART_DELETE_BLOG_POST`

Tool to delete a blog post by its ID. Use after confirming the correct ID to permanently remove the blog post.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the blog post to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Blog Tag

**Slug:** `CLOUDCART_DELETE_BLOG_TAG`

Tool to delete a blog tag by its ID. Use after confirming the correct ID to permanently remove the tag. The API returns 204 No Content on successful deletion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the blog tag to delete. This is a numeric ID represented as a string (e.g., '1', '2', '123'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Category

**Slug:** `CLOUDCART_DELETE_CATEGORY`

Tool to delete a category by its ID. Use after confirming the correct ID to permanently remove it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the category to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer

**Slug:** `CLOUDCART_DELETE_CUSTOMER`

Tool to delete a customer. Use when you need to remove a customer by their ID. Example: "Delete customer with ID 123".

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | integer | Yes | ID of the customer to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer Billing Address

**Slug:** `CLOUDCART_DELETE_CUSTOMER_BILLING_ADDRESS`

Tool to delete a customer billing address by its ID. Use when you need to remove a billing address from a customer's account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the customer billing address to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer Group

**Slug:** `CLOUDCART_DELETE_CUSTOMER_GROUP`

Tool to delete a customer group by its ID. Use when you need to permanently remove a customer group from the store.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The identifier of the group intended for removal |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer Shipping Address

**Slug:** `CLOUDCART_DELETE_CUSTOMER_SHIPPING_ADDRESS`

Tool to delete a customer shipping address. Use when you need to remove a customer's shipping address by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the customer shipping address to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer Tag

**Slug:** `CLOUDCART_DELETE_CUSTOMER_TAG`

Tool to delete a customer tag by its ID. Use after confirming the tag exists to permanently remove it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the customer tag to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Discount

**Slug:** `CLOUDCART_DELETE_DISCOUNT`

Tool to delete a discount by its ID. Use after confirming the discount exists to permanently remove it from the store.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the discount to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Discount Code

**Slug:** `CLOUDCART_DELETE_DISCOUNT_CODE`

Tool to delete a discount code by its ID. Use after confirming the discount code exists to permanently remove it from the store.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the discount code to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Image

**Slug:** `CLOUDCART_DELETE_IMAGE`

Tool to delete an image by its ID. Use when you need to remove an image permanently from the CloudCart store.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the image to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Order

**Slug:** `CLOUDCART_DELETE_ORDER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | The unique identifier of the order to be deleted |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Product

**Slug:** `CLOUDCART_DELETE_PRODUCT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | string | Yes | The unique identifier of the product to delete (numeric ID as string). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Linked Products

**Slug:** `CLOUDCART_DELETE_PRODUCTS_LINKED_PRODUCTS`

Tool to delete linked product relationships in CloudCart. Use when you need to remove associations between related products. This removes the link but does not delete the products themselves.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | string | Yes | The ID of the parent product from which to remove linked products. |
| `linked_products` | array | Yes | List of linked products to remove. Each item specifies a product ID that should be unlinked from the parent product. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Product To Discount

**Slug:** `CLOUDCART_DELETE_PRODUCT_TO_DISCOUNT`

Tool to delete a product-to-discount relationship by its ID. Use to remove the association between a product and a discount.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the product-to-discount relationship to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Property

**Slug:** `CLOUDCART_DELETE_PROPERTY`

Tool to delete a property by its ID. Use after confirming the correct property ID to permanently remove it from the store.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the property you wish to delete. This is a numeric ID represented as a string (e.g., '3', '15'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Property Options

**Slug:** `CLOUDCART_DELETE_PROPERTY_OPTIONS`

Tool to delete a property option by its ID. Use when you need to remove obsolete property options or clean up test data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the property option to delete (numeric ID as string). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Redirect

**Slug:** `CLOUDCART_DELETE_REDIRECT`

Tool to delete a redirect by its ID. Use this when you need to remove obsolete redirects or clean up redirect rules in the CloudCart store.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `redirect_id` | string | Yes | The unique identifier of the redirect to delete. This is a numeric ID represented as a string (e.g., '2', '15', '123'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Subscriber

**Slug:** `CLOUDCART_DELETE_SUBSCRIBER`

Tool to delete a subscriber by their ID. Use when you need to remove a subscriber from the mailing list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscriber_id` | string | Yes | The unique identifier of the subscriber to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Subscribers Channel

**Slug:** `CLOUDCART_DELETE_SUBSCRIBERS_CHANNEL`

Tool to delete a subscriber channel by ID. Use when you need to remove a subscriber channel from the system. The API returns 204 No Content on successful deletion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the subscriber channel to delete. This is a numeric ID represented as a string (e.g., '12', '15'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Subscriber Tag

**Slug:** `CLOUDCART_DELETE_SUBSCRIBERS_TAG`

Tool to delete a subscriber tag by its ID. Use after confirming the tag exists to permanently remove it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the subscriber tag to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Variant

**Slug:** `CLOUDCART_DELETE_VARIANT`

Tool to delete a variant by its ID. Use when you need to permanently remove a product variant from the catalog.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `variant_id` | string | Yes | The unique identifier of the variant to delete. This is a numeric ID represented as a string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Variant Option

**Slug:** `CLOUDCART_DELETE_VARIANT_OPTION`

Tool to delete a variant option by its ID. Use when you need to permanently remove a variant option from a product variant in the CloudCart store.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the variant option to delete (numeric ID as string). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Variant Parameter

**Slug:** `CLOUDCART_DELETE_VARIANT_PARAMETER`

Tool to delete a variant parameter by its ID. Use when you need to permanently remove a variant parameter from the CloudCart store. The API returns 204 No Content on successful deletion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the variant parameter you wish to delete. This is a numeric ID represented as a string (e.g., '5', '10'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Vendor

**Slug:** `CLOUDCART_DELETE_VENDOR`

Delete a vendor by its ID from the CloudCart store. This operation permanently removes the vendor record. The API returns 204 No Content on successful deletion. Use this tool when you need to remove obsolete vendors, clean up test data, or manage vendor records in your store.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vendor_id` | string | Yes | Unique identifier of the vendor to delete. This is a numeric ID represented as a string (e.g., '15', '20'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Webhook

**Slug:** `CLOUDCART_DELETE_WEBHOOK`

Tool to delete a webhook by its ID from the CloudCart store. Use when you need to remove webhooks that are no longer needed or to clean up webhook subscriptions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | The unique identifier of the webhook to delete. This is a numeric ID represented as a string (e.g., '1', '5', '42'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Discount Codes

**Slug:** `CLOUDCART_GENERATE_DISCOUNT_CODES`

Tool to generate multiple discount codes with a specified discount percentage. Use when you need to create multiple promotional codes with the same discount value. The discount value is multiplied by 100 (e.g., 1000 = 10%, 2500 = 25%).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | Yes | Number of discount codes to generate. Must be at least 1. |
| `value` | integer | Yes | The percent of discount for each code (multiplied by 100). Example: 10% discount is represented as 1000, 25% as 2500. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Blog Author

**Slug:** `CLOUDCART_GET_BLOG_AUTHOR`

Tool to retrieve details of a specific blog author by ID. Use when you need information about a blog author.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the blog author to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Blog Category

**Slug:** `CLOUDCART_GET_BLOG_CATEGORY`

Tool to retrieve details of a specific blog category by ID. Use when you need information about a particular blog category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID for the requested blog category |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Blog Post

**Slug:** `CLOUDCART_GET_BLOG_POST`

Tool to retrieve a single blog post by its ID. Use when you need detailed information about a specific blog post including title, content, author, publish date, and images.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the blog post to retrieve |
| `fields` | array | No | Allows filtering of post attributes. Specify which fields to include in the response (e.g., ['name', 'content', 'author_id']) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Blog Tag

**Slug:** `CLOUDCART_GET_BLOG_TAG`

Tool to retrieve details of a specific blog tag by ID. Use when you need to fetch information about a particular tag.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the blog tag to retrieve |
| `fields` | array | No | Filter tag attributes to return only specified fields (respects the Fields filtering mechanism) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Cart

**Slug:** `CLOUDCART_GET_CART`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cart_id` | string | No | The unique identifier of the cart. If not provided, retrieves the current session cart. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Categories

**Slug:** `CLOUDCART_GET_CATEGORIES`

Tool to retrieve a list of all categories. Use when you need to list available categories for selection. Returns numeric category IDs; use these IDs directly (not names or slugs) when setting categories in other tools like CLOUDCART_CREATE_PRODUCT.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Category Properties

**Slug:** `CLOUDCART_GET_CATEGORIES_PROPERTIES`

Tool to retrieve properties relationship for a category. Use when you need to get the list of properties assigned to a specific category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The category ID to retrieve properties for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Category

**Slug:** `CLOUDCART_GET_CATEGORY`

Tool to retrieve details of a specific category by ID. Use when you need information about a single category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | string | Yes | Unique identifier of the category to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer

**Slug:** `CLOUDCART_GET_CUSTOMER`

Tool to retrieve details of a specific customer by ID. Use when you need information about a single customer.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID for the requested Customer |
| `fields` | string | No | Enables filtering of customer attributes returned. Comma-separated list of field names |
| `include` | string | No | Allows you to include customer relationships in response (e.g., 'group') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer Billing Address

**Slug:** `CLOUDCART_GET_CUSTOMER_BILLING_ADDRESS`

Tool to retrieve a specific customer billing address by its ID. Use when you need to fetch details of a particular billing address including country, state, city, street information, and contact details. Optionally include related customer data using the 'include' parameter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the billing address to retrieve |
| `fields` | string | No | Comma-separated list of specific address attributes to return. If not specified, all fields are returned |
| `include` | string | No | Comma-separated list of relationships to include in the response (e.g., 'customer' to load associated customer data) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer Group

**Slug:** `CLOUDCART_GET_CUSTOMER_GROUP`

Tool to retrieve details of a specific customer group by ID. Use when you need to fetch information about a particular customer group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_group_id` | string | Yes | Unique identifier of the customer group to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer Groups Customers

**Slug:** `CLOUDCART_GET_CUSTOMER_GROUPS_CUSTOMERS`

Tool to retrieve customers from a specific customer group. Use when you need to list all customers belonging to a particular group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The customer group ID to retrieve customers from |
| `sort` | string | No | Sort order by field name. Prefix with '-' for descending order (e.g., '-id' for newest first) |
| `page_size` | integer | No | Number of items per page for pagination |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customers

**Slug:** `CLOUDCART_GET_CUSTOMERS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order by field name. Prefix with '-' for descending order (e.g., '-date_added' for newest first) |
| `page_size` | integer | No | Number of items per page for pagination |
| `page_number` | integer | No | Page number for pagination, starting from 1 |
| `filter_email` | string | No | Filter customers by email address |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer Shipping Address

**Slug:** `CLOUDCART_GET_CUSTOMER_SHIPPING_ADDRESS`

Tool to retrieve a single customer shipping address by ID. Use when you need details about a specific shipping address. Optionally include related customer data or filter specific fields to return only needed attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | No | Enables filtering of specific address attributes to return. Specify field names to limit the response. |
| `include` | string | No | Allows including associated customer relationship data. Use 'customer' to include related customer details. |
| `address_id` | string | Yes | Unique identifier of the customer shipping address to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer Tag

**Slug:** `CLOUDCART_GET_CUSTOMER_TAG`

Tool to retrieve details of a specific customer tag. Use when you have the customer tag ID and need to get its details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the customer tag to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Image

**Slug:** `CLOUDCART_GET_IMAGE`

Tool to retrieve details of a specific image by ID. Use when you need information about a single image including its dimensions, URLs, thumbnails, and related product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the image to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Orders

**Slug:** `CLOUDCART_GET_ORDERS`

Retrieve a paginated list of orders from your CloudCart store. Returns order details including order ID, status, total amount, currency, and creation/update timestamps. Supports pagination through page[number] (starting from 1) and page[size] (items per page) parameters. Use this action to list all orders, check order statuses, retrieve order histories, or process orders programmatically. The response includes pagination metadata (current page, total orders, total pages) and navigation links for easy pagination handling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of items per page for pagination. Defaults to 20 if not specified. |
| `page_number` | integer | No | Page number for pagination, starting from 1. Defaults to 1 if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Payment Methods

**Slug:** `CLOUDCART_GET_PAYMENT_METHODS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Products

**Slug:** `CLOUDCART_GET_PRODUCTS`

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).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number of results to fetch (1-based). |
| `limit` | integer | No | Number of products to return per page. |
| `search` | string | No | Text to search for in product names and descriptions. |
| `brand_id` | integer | No | Filter products by brand ID. |
| `max_price` | number | No | Maximum price filter (inclusive). |
| `min_price` | number | No | Minimum price filter (inclusive). |
| `category_id` | integer | No | Filter products by category ID. |
| `with_hidden` | boolean | No | Include hidden products when true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Products Linked Product

**Slug:** `CLOUDCART_GET_PRODUCTS_LINKED_PRODUCT`

Tool to retrieve linked products for a specific product. Use when you need to get related or complementary products that are associated with a main product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The product ID to get linked products for |
| `page` | integer | No | Page number of results to fetch (1-based) |
| `limit` | integer | No | Number of linked products to return per page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Products Linked Products

**Slug:** `CLOUDCART_GET_PRODUCTS_LINKED_PRODUCTS`

Tool to retrieve linked products for a specific product. Use when you need to find products that are associated or related to a given product, such as complementary items or product recommendations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier for the parent product |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product With Relations

**Slug:** `CLOUDCART_GET_PRODUCT_WITH_RELATIONS`

Retrieves detailed information about a specific product including its relationships (category, vendor, variants). Use this action when you need comprehensive product details after obtaining a product ID from the Get Products action. Returns product attributes (name, description, pricing, status) and related entity references.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | string | Yes | Unique identifier of the product to retrieve (numeric ID as string). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Property

**Slug:** `CLOUDCART_GET_PROPERTY`

Tool to retrieve details of a specific property by ID. Use when you need information about a single property.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier for the property to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Property Option

**Slug:** `CLOUDCART_GET_PROPERTY_OPTION`

Tool to retrieve details of a specific property option by ID. Use when you need information about a single property option.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier for the property option to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Property Options Relationship

**Slug:** `CLOUDCART_GET_PROPERTY_OPTIONS_RELATIONSHIP`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | integer | Yes | ID of the product whose property options relationships to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Shipping Methods

**Slug:** `CLOUDCART_GET_SHIPPING_METHODS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Subscriber

**Slug:** `CLOUDCART_GET_SUBSCRIBER`

Tool to retrieve details of a specific subscriber by ID. Use when you need information about a single subscriber including their engagement metrics and subscription details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID for the requested Subscriber |
| `fields` | string | No | Filter subscriber attributes returned. Comma-separated list of field names |
| `include` | string | No | Include subscriber relationships in response (e.g., 'channels') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Subscribers Channel

**Slug:** `CLOUDCART_GET_SUBSCRIBERS_CHANNEL`

Tool to retrieve a single subscriber channel by its ID. Use when you need details about a specific subscriber's communication channel. Returns channel information including type, identifier, verification status, and marketing preferences.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier for the requested subscriber channel. |
| `fields` | string | No | Comma-separated list of specific channel attributes to include in the response. |
| `include` | string | No | Include related subscriber channel relationships (e.g., 'subscriber'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Subscriber Tag

**Slug:** `CLOUDCART_GET_SUBSCRIBERS_TAG`

Tool to retrieve details of a specific subscriber tag by ID. Use when you need to get information about a subscriber tag association.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the subscriber tag to retrieve |
| `fields` | string | No | Restricts response to specified subscriber tag attributes (comma-separated) |
| `include` | string | No | Enables relationship data retrieval for subscriber tags (comma-separated) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Variant

**Slug:** `CLOUDCART_GET_VARIANT`

Tool to retrieve details of a specific variant by ID. Use when you need information about a single product variant.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `variant_id` | string | Yes | Unique identifier of the variant to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Variant Option

**Slug:** `CLOUDCART_GET_VARIANT_OPTION`

Tool to retrieve a specific variant option by its ID. Use when you need details about a particular variant option such as its name, sort order, color, visibility, or associated parameter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier for the variant option resource |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Variant Parameter

**Slug:** `CLOUDCART_GET_VARIANT_PARAMETER`

Tool to retrieve details of a specific variant parameter by ID. Use when you need information about a single variant parameter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier for the variant parameter to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Vendor

**Slug:** `CLOUDCART_GET_VENDOR`

Tool to retrieve details of a specific vendor. Use when you have the vendor ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vendor_id` | string | Yes | Unique identifier of the vendor to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhook

**Slug:** `CLOUDCART_GET_WEBHOOK`

Tool to retrieve details of a specific webhook by ID. Use when you need information about a webhook configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID for the requested Webhook |
| `fields` | string | No | Filter webhook attributes returned. Comma-separated list of field names |
| `include` | string | No | Include webhook relationships in response |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Blog Categories

**Slug:** `CLOUDCART_LIST_BLOG_CATEGORIES`

Tool to retrieve all blog categories with optional pagination, sorting, and filtering. Use when you need to list blog categories or get blog category information for content organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort field. Prefix with '-' for descending order (e.g., '-date_modified'). |
| `fields` | string | No | Comma-separated list of fields to include in response. |
| `filter` | string | No | Filter criteria in format 'field:value'. |
| `page_size` | integer | No | Number of blog categories per page. |
| `page_number` | integer | No | Page number for pagination (1-based). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Blog Posts

**Slug:** `CLOUDCART_LIST_BLOG_POSTS`

Tool to retrieve a list of all blog posts. Use when you need a paginated list of blog posts with optional filtering and sorting. Example: "List recent blog posts on page 1."

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (1-based). |
| `sort` | string | No | Sort the results by field name. Prefix with '-' for descending order. |
| `limit` | integer | No | Number of blog posts per page. |
| `fields` | string | No | Filter blog post attributes to return. Comma-separated field names. |
| `filter` | string | No | Filter the results by field values. Format: field:value |
| `include` | string | No | Include related resources like authors or blogs. Comma-separated values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Blog Tags

**Slug:** `CLOUDCART_LIST_BLOG_TAGS`

Tool to retrieve all blog tags from CloudCart. Use when you need to list available blog tags for filtering or selection. Supports pagination, sorting, and filtering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sorting configuration. Prefix with '-' for descending order (e.g., '-created_at'). |
| `fields` | array | No | Filter tag attributes to include in response. Array of field names. |
| `filter` | array | No | Filtering options. Array of filter expressions. |
| `page_size` | integer | No | Items per page for pagination. |
| `page_number` | integer | No | Current page number (1-based). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Billing Addresses

**Slug:** `CLOUDCART_LIST_CUSTOMER_BILLING_ADDRESS`

Tool to retrieve a list of all customer billing addresses. Use when you need to access billing address information for customers. The response is paginated; use page[number] and page[size] parameters to control pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order by field name. Prefix with '-' for descending order (e.g., '-id' for newest first) |
| `include` | string | No | Related resources to include in response (e.g., 'customer' to include customer data) |
| `page_size` | integer | No | Number of items per page for pagination |
| `page_number` | integer | No | Page number for pagination, starting from 1 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Groups

**Slug:** `CLOUDCART_LIST_CUSTOMER_GROUPS`

Tool to retrieve all customer groups. Use when you need to display or process customer group information. The response is paginated; use page[number] and page[size] to control pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of items per page for pagination |
| `page_number` | integer | No | Page number for pagination, starting from 1 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Shipping Addresses

**Slug:** `CLOUDCART_LIST_CUSTOMER_SHIPPING_ADDRESSES`

Tool to retrieve a paginated list of customer shipping addresses. Use when you need to list all shipping addresses or filter by customer ID or country. Supports pagination and sorting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order by field name. Prefix with '-' for descending order (e.g., '-id' for newest first) |
| `include` | string | No | Include related resources (e.g., 'customer' to include customer data) |
| `page_size` | integer | No | Number of items per page for pagination |
| `page_number` | integer | No | Page number for pagination, starting from 1 |
| `filter_customer_id` | integer | No | Filter addresses by customer ID |
| `filter_country_iso2` | string | No | Filter addresses by country ISO2 code (e.g., 'US', 'GB') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Tags

**Slug:** `CLOUDCART_LIST_CUSTOMER_TAGS`

Tool to retrieve all customer tags. Use when you need to list available tags for customer categorization or filtering.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Discount Codes

**Slug:** `CLOUDCART_LIST_DISCOUNT_CODES`

Tool to retrieve all discount codes from your CloudCart store. Use when you need to list available discount codes, check their status, or manage promotions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort results by specified criteria. Prefix with '-' for descending order. |
| `fields` | string | No | Limit returned resource attributes (comma-separated list of field names). |
| `filter` | string | No | Filter results based on conditions (e.g., 'active:1' for active codes only). |
| `include` | string | No | Include related resource relationships (comma-separated list). |
| `page_size` | integer | No | Number of items per page for pagination. Defaults to API default if not specified. |
| `page_number` | integer | No | Page number for pagination, starting from 1. Defaults to 1 if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Images

**Slug:** `CLOUDCART_LIST_IMAGES`

Tool to retrieve all images from CloudCart. Use when you need a paginated list of images.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (1-based). |
| `limit` | integer | No | Number of images per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Order Billing Addresses

**Slug:** `CLOUDCART_LIST_ORDER_BILLING_ADDRESS`

Tool to retrieve order billing addresses (read-only). Use when you need to access billing address information associated with orders. The response is paginated; use page[number] and page[size] parameters to control pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order by field name. Prefix with '-' for descending order (e.g., '-id' for newest first) |
| `include` | string | No | Related resources to include in response (e.g., 'order' to include order data) |
| `page_size` | integer | No | Number of items per page for pagination |
| `page_number` | integer | No | Page number for pagination, starting from 1 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Order Payments

**Slug:** `CLOUDCART_LIST_ORDER_PAYMENT`

Retrieve payment information from orders. Since CloudCart API does not have a dedicated payments endpoint, this action fetches orders and extracts payment-related data. Use when you need to view payment status, methods, and amounts for orders.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (1-based). |
| `limit` | integer | No | Number of orders to retrieve per page (max 100). |
| `order_id` | integer | No | Filter by a specific order ID. If provided, retrieves payment info for that order only. |
| `payment_status` | string | No | Filter orders by payment status (e.g., 'paid', 'pending', 'failed', 'refunded'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Order Payment V2

**Slug:** `CLOUDCART_LIST_ORDER_PAYMENT2`

Tool to retrieve order payment data from the CloudCart order-payment endpoint. Use when you need to access payment transaction details including payment IDs, provider references, amounts, and statuses.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of items per page for pagination. Defaults to 20 if not specified. |
| `page_number` | integer | No | Page number for pagination, starting from 1. Defaults to 1 if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Order Products

**Slug:** `CLOUDCART_LIST_ORDER_PRODUCTS`

Retrieve all order products from your CloudCart store (read-only). Returns order product details including product ID, attributes, and relationships to orders and product options. Supports pagination through page[number] and page[size] parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of items per page for pagination. Defaults to 20 if not specified. |
| `page_number` | integer | No | Page number for pagination, starting from 1. Defaults to 1 if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Order Products Options

**Slug:** `CLOUDCART_LIST_ORDER_PRODUCTS_OPTIONS`

Tool to retrieve order products options (read-only). Use when you need to list custom field options associated with products in orders.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Order Shipping

**Slug:** `CLOUDCART_LIST_ORDER_SHIPPING`

Tool to retrieve order shipping data. Use when you need to list shipping information for orders.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of items per page for pagination |
| `page_number` | integer | No | Page number for pagination, starting from 1 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Order Shipping Addresses

**Slug:** `CLOUDCART_LIST_ORDER_SHIPPING_ADDRESS`

Tool to retrieve a paginated list of order shipping addresses. Use when you need to view shipping addresses associated with orders, filter by order ID, or export address data. Supports pagination and sorting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include` | string | No | Include related resources (e.g., 'order' to include order data) |
| `page_size` | integer | No | Number of items per page for pagination |
| `page_number` | integer | No | Page number for pagination, starting from 1 |
| `filter_order_id` | integer | No | Filter addresses by order ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Order Status

**Slug:** `CLOUDCART_LIST_ORDER_STATUS`

Tool to retrieve all available order statuses from CloudCart. Returns status codes, names, translations, and types (order, payment, or shipping). Use when you need to view available order statuses for filtering orders or displaying status options.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Payment Providers

**Slug:** `CLOUDCART_LIST_PAYMENT_PROVIDERS`

Tool to retrieve all payment providers (read-only). Use when you need to view configured payment providers in the store.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Properties

**Slug:** `CLOUDCART_LIST_PROPERTIES`

Tool to retrieve all properties with optional pagination. Use when you need to list available properties or get property information for product configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of properties per page. |
| `page_number` | integer | No | Page number for pagination (1-based). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Property Options

**Slug:** `CLOUDCART_LIST_PROPERTY_OPTIONS`

Tool to retrieve all property options with optional filtering and pagination. Use when you need to list property options or filter by property ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of records per page (default: 20). |
| `page_number` | integer | No | Page number for pagination (1-based). |
| `filter_property_id` | string | No | Filter property options by property ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Redirects

**Slug:** `CLOUDCART_LIST_REDIRECTS`

Tool to retrieve all redirects from CloudCart. Use when you need to view URL redirects configured in the store.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (1-based). |
| `limit` | integer | No | Number of redirects per page. |
| `item_id` | string | No | Filter redirects by item ID. |
| `item_type` | string | No | Filter redirects by item type (product, category, vendor, manual, external). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Shipping Providers

**Slug:** `CLOUDCART_LIST_SHIPPING_PROVIDERS`

Tool to retrieve all shipping providers (read-only). Use when you need to view configured shipping providers in the store.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Subscribers

**Slug:** `CLOUDCART_LIST_SUBSCRIBERS`

Tool to retrieve all subscribers from the store. Use when you need to display or process subscriber information with engagement metrics like open rates and click rates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order by field name. Prefix with '-' for descending order (e.g., '-created_at' for newest first) |
| `page_size` | integer | No | Number of items per page for pagination (default 20, max 100) |
| `page_number` | integer | No | Page number for pagination, starting from 1 |
| `filter_customer_id` | integer | No | Filter subscribers by customer ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Subscribers Channels

**Slug:** `CLOUDCART_LIST_SUBSCRIBERS_CHANNELS`

Tool to retrieve all subscriber channels. Use when you need to list available channels for subscriber management or filtering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort the results. Prefix with '-' for descending order |
| `fields` | string | No | Filter subscribers channels attributes to return specific fields |
| `filter` | string | No | Filter data based on specific criteria |
| `include` | string | No | Include subscribers channels relationships |
| `page_size` | integer | No | Number of items to return per page |
| `page_number` | integer | No | The current page number |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Subscribers Tags

**Slug:** `CLOUDCART_LIST_SUBSCRIBERS_TAGS`

Tool to retrieve all subscriber tags. Use when you need to list tag associations for subscribers with flexible organization through customizable labeling. Supports pagination, filtering, and sorting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort the results by field name. Prefix with '-' for descending order |
| `fields` | string | No | Filter subscriber tag attributes to return only specified fields |
| `filter` | string | No | Filter the results based on specific criteria |
| `include` | string | No | Include subscriber tag relationships in the response |
| `page_size` | integer | No | The number of items to return per page for pagination |
| `page_number` | integer | No | The number of the current page for pagination, starting from 1 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Variant Options

**Slug:** `CLOUDCART_LIST_VARIANT_OPTIONS`

Tool to retrieve all variant options. Use when you need to list available variant options with optional pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (1-based). |
| `limit` | integer | No | Number of records per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Variant Parameters

**Slug:** `CLOUDCART_LIST_VARIANT_PARAMETERS`

Tool to retrieve all variant parameters with pagination support. Use when you need to list product variant configuration options like size, color, or other custom attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (1-based). |
| `limit` | integer | No | Number of records per page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Variants

**Slug:** `CLOUDCART_LIST_VARIANTS`

Tool to retrieve all product variants with optional pagination and filtering. Use when you need to list variants across products or filter by specific item ID or SKU.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sku` | string | No | Filter variants by SKU. |
| `page` | integer | No | Page number for pagination (1-based). |
| `limit` | integer | No | Number of records per page. |
| `item_id` | integer | No | Filter variants by product item ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Vendors

**Slug:** `CLOUDCART_LIST_VENDORS`

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."

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (1-based). |
| `limit` | integer | No | Number of records per page. |
| `search` | string | No | Filter vendors by name or other searchable fields. |
| `status` | string | No | Filter vendors by status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhooks

**Slug:** `CLOUDCART_LIST_WEBHOOKS`

Tool to retrieve all webhooks. Use when you need to view configured webhooks, check webhook events, or manage webhook subscriptions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order by field name. Prefix with '-' for descending order |
| `fields` | string | No | Filter webhook attributes to return (comma-separated field names) |
| `filter` | string | No | Filter the results by specific criteria |
| `include` | string | No | Include webhook relationships in response (comma-separated) |
| `page_size` | integer | No | Number of items per page for pagination |
| `page_number` | integer | No | Page number for pagination, starting from 1 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove from Cart

**Slug:** `CLOUDCART_REMOVE_FROM_CART`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | integer | Yes | The unique identifier of the product to be removed from the cart. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Blog Category

**Slug:** `CLOUDCART_UPDATE_BLOG_CATEGORY`

Tool to update an existing blog category. Use when you need to modify blog category details such as name, SEO settings, or image.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the blog category to update |
| `name` | string | No | Name of the blog category |
| `image` | string | No | Image URL for the blog category |
| `comments` | string | No | Comments or notes about the blog category |
| `seo_title` | string | No | SEO title for the blog category |
| `url_handle` | string | No | URL handle/slug for the blog category |
| `seo_description` | string | No | SEO description for the blog category |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Blog Post

**Slug:** `CLOUDCART_UPDATE_BLOG_POST`

Tool to update an existing blog post. Use when you need to modify the title or content of a blog post. Requires the blog post ID and at least one field to update (name or content).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the blog post to update |
| `name` | string | No | Updated title of the blog post |
| `content` | string | No | Updated content/body of the blog post (supports HTML) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Blog Tag

**Slug:** `CLOUDCART_UPDATE_BLOG_TAG`

Tool to update an existing blog tag. Use when you need to modify a blog tag's name or label.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the blog tag to update |
| `tag` | string | Yes | The updated tag name/label for the blog tag |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Cart Item

**Slug:** `CLOUDCART_UPDATE_CART_ITEM`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `quantity` | integer | Yes | The new quantity for the product in the cart; must be at least 1. |
| `product_id` | integer | Yes | The unique identifier of the product to update in the cart. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Category

**Slug:** `CLOUDCART_UPDATE_CATEGORY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the category to update |
| `title` | string | No | Title of the category |
| `position` | integer | No | Sorting position of the category (0 = first) |
| `meta_title` | string | No | SEO meta title |
| `description` | string | No | Detailed description of the category |
| `meta_keywords` | string | No | SEO meta keywords, comma-separated |
| `meta_description` | string | No | SEO meta description |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customer

**Slug:** `CLOUDCART_UPDATE_CUSTOMER`

Updates an existing customer's information in CloudCart. You can modify customer details such as first name, last name, email, password, and alternative phone number. All update fields are optional - only provide the fields you want to update.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Customer's email address. Optional. |
| `password` | string | No | Password for the customer's account. Must be at least 8 characters. Optional. |
| `last_name` | string | No | Last name of the customer. Optional. |
| `first_name` | string | No | First name of the customer. Optional. |
| `customer_id` | integer | Yes | ID of the customer to update |
| `alternative_phone` | string | No | Alternative phone number of the customer. Optional. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customer Billing Address

**Slug:** `CLOUDCART_UPDATE_CUSTOMER_BILLING_ADDRESS`

Tool to update an existing customer billing address in CloudCart. Use when you need to modify billing address details such as phone, location, or contact information. All update fields are optional - only provide the fields you want to update.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the billing address to update |
| `note` | string | No | Additional notes or instructions for the billing address |
| `phone` | string | No | Phone number for the billing address |
| `city_name` | string | No | Name of the city for the billing address |
| `last_name` | string | No | Last name for the billing address contact |
| `post_code` | string | No | Postal/ZIP code for the billing address |
| `first_name` | string | No | First name for the billing address contact |
| `company_vat` | string | No | Company VAT number for the billing address |
| `street_name` | string | No | Street name for the billing address |
| `company_name` | string | No | Company name for the billing address |
| `country_iso2` | string | No | ISO2 country code for the billing address (e.g., 'US', 'GB') |
| `phone_country_iso2` | string | No | ISO2 country code for the phone number (e.g., 'US', 'GB') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customer Group

**Slug:** `CLOUDCART_UPDATE_CUSTOMER_GROUP`

Tool to update an existing customer group's name. Use when you need to modify a customer group's details after reviewing its current values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the customer group you wish to update |
| `name` | string | Yes | The name of the customer group. Must be unique. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customer Shipping Address

**Slug:** `CLOUDCART_UPDATE_CUSTOMER_SHIPPING_ADDRESS`

Tool to update an existing customer shipping address in CloudCart. Use when you need to modify address details such as phone, name, or location fields. All update fields are optional - only provide the fields you want to change.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the shipping address to update |
| `note` | string | No | Additional notes or delivery instructions for the shipping address |
| `phone` | string | No | Customer's phone number. Must be valid for the country specified in phone_country_iso2 |
| `city_name` | string | No | Name of the city for the shipping address |
| `last_name` | string | No | Customer's last name for the shipping address |
| `post_code` | string | No | Postal code / ZIP code of the shipping address |
| `first_name` | string | No | Customer's first name for the shipping address |
| `street_name` | string | No | Street name of the shipping address |
| `country_iso2` | string | No | Two-letter ISO country code for the shipping address (e.g., 'US', 'BG', 'GB') |
| `street_number` | string | No | Street number of the shipping address |
| `phone_country_iso2` | string | No | Two-letter ISO country code for phone number validation (e.g., 'US', 'BG', 'GB') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customer Tag

**Slug:** `CLOUDCART_UPDATE_CUSTOMER_TAG`

Tool to update an existing customer tag in CloudCart. Use when you need to rename or modify a customer tag's label.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the customer tag to update |
| `tag` | string | Yes | The new tag label/name to assign to this customer tag |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Discount Code

**Slug:** `CLOUDCART_UPDATE_DISCOUNT_CODE`

Tool to update an existing discount code in CloudCart. Use when you need to modify discount code properties such as the code value, discount amount, or activation status. At least one optional field must be provided to perform an update.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the discount code to update |
| `code` | string | No | The promotional code identifier. Must contain only letters and numbers (alphanumeric). Optional. |
| `value` | integer | No | Discount percentage multiplied by 100. Example: 10% discount = 1000, 15% discount = 1500. Must be at least 1. Optional. |
| `active` | integer | No | Status flag: 0 = inactive, 1 = active. Optional. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Linked Product

**Slug:** `CLOUDCART_UPDATE_LINKED_PRODUCT`

Updates linked product relationships for a specific product in CloudCart. This replaces all existing linked products with the provided list. Use when you need to establish product recommendations or cross-sell relationships. The two_way parameter controls bidirectional linking.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | string | Yes | The unique identifier of the product whose linked products you want to update. |
| `linked_products` | array | Yes | List of products to link. Each entry specifies a product ID and optionally whether the link is bidirectional. Replaces existing linked products. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Order

**Slug:** `CLOUDCART_UPDATE_ORDER`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | Unique identifier of the order to update |
| `attributes` | object | Yes | Order fields to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Product

**Slug:** `CLOUDCART_UPDATE_PRODUCT`

Updates an existing product in CloudCart. Provide the product_id and at least one field to update. Returns updated product details. For variant-based products, price and stock are managed at the variant level and will return 0 in the response. Use GET_PRODUCTS or GET_PRODUCT_WITH_RELATIONS to retrieve current product details first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Updated product name to display to customers. |
| `price` | number | No | Updated individual product price (non-negative). Note: For variant-based products, price may need to be set at variant level. |
| `stock` | integer | No | Updated stock quantity (non-negative). Note: For variant-based products, stock may need to be managed at variant level. |
| `images` | array | No | List of full image URLs for product photos. Replaces existing images. |
| `product_id` | string | Yes | The unique numeric identifier of the product to update (as a string). |
| `description` | string | No | Updated product description; supports plain text or HTML markup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Property

**Slug:** `CLOUDCART_UPDATE_PROPERTY`

Tool to update an existing property. Use when you need to modify property details such as display type, name, or visibility settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the property to update |
| `name` | string | No | Name of the property |
| `sort` | integer | No | Sort order for the property (0 = first) |
| `active` | boolean | No | Whether the property is active |
| `is_visible` | boolean | No | Whether the property is visible |
| `url_handle` | string | No | URL-friendly handle for the property |
| `display_type` | string | No | Display type for the property (e.g., 'radio', 'select', 'checkbox') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Property Option

**Slug:** `CLOUDCART_UPDATE_PROPERTY_OPTION`

Tool to update an existing property option. Use when you need to modify an option value of a product property (e.g., changing "Red" to "Crimson Red" in a "Color" property).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the property option you wish to update |
| `sort` | integer | No | Sort order ranking for displaying the option |
| `value` | string | Yes | A human readable name for this property option |
| `seo_title` | string | No | SEO Title for the option |
| `url_handle` | string | Yes | A human readable slug value. Must be unique |
| `description` | string | No | Description of the property option. Can be HTML |
| `seo_description` | string | No | SEO Description for the option |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Subscriber

**Slug:** `CLOUDCART_UPDATE_SUBSCRIBER`

Tool to update an existing subscriber in CloudCart. Use when you need to modify subscriber details like first name, last name, or country code. Provide the subscriber ID and the updated attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | Yes | Two-letter ISO 3166-1 alpha-2 country code (e.g., 'US' for United States, 'BG' for Bulgaria) |
| `last_name` | string | Yes | Last name of the subscriber |
| `first_name` | string | Yes | First name of the subscriber |
| `subscriber_id` | string | Yes | The ID of the subscriber to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Subscribers Channel

**Slug:** `CLOUDCART_UPDATE_SUBSCRIBERS_CHANNEL`

Tool to update an existing subscriber channel in CloudCart. Use when you need to modify a subscriber's communication channel details such as contact information, marketing preferences, or verification status. All update fields are optional - only provide the fields you want to update.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the subscriber channel to update. |
| `bounced` | string ("0" | "1") | No | Enumeration for boolean flags represented as strings (0 or 1). |
| `channel` | string ("Email" | "Phone") | No | Enumeration of valid channel types for subscriber channels. |
| `verified` | string ("0" | "1") | No | Enumeration for boolean flags represented as strings (0 or 1). |
| `marketing` | string ("0" | "1") | No | Enumeration for boolean flags represented as strings (0 or 1). |
| `subscriber_id` | string | No | The subscriber's unique identifier. Optional. |
| `channel_identifier` | string | No | The actual contact value (email address or phone number) for the specified channel. Optional. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Subscriber Tag

**Slug:** `CLOUDCART_UPDATE_SUBSCRIBER_TAG`

Tool to update an existing subscriber tag association in CloudCart. Use when you need to modify which subscriber or tag is associated in a subscribers-tags relationship.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the subscribers-tags relationship to update |
| `tag_id` | string | Yes | The identifier of the tag to associate with the subscriber |
| `subscriber_id` | string | Yes | The identifier of the subscriber to associate with the tag |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Variant

**Slug:** `CLOUDCART_UPDATE_VARIANT`

Tool to update an existing product variant. Use when you need to modify variant details such as quantity, price, SKU, or other attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the variant to update |
| `v1` | string | No | Variant parameter 1 value |
| `v2` | string | No | Variant parameter 2 value |
| `v3` | string | No | Variant parameter 3 value |
| `sku` | string | No | Stock Keeping Unit code |
| `price` | integer | No | Price in cents (smallest currency unit) |
| `v1_id` | integer | No | Variant parameter 1 ID |
| `v2_id` | integer | No | Variant parameter 2 ID |
| `v3_id` | integer | No | Variant parameter 3 ID |
| `weight` | integer | No | Weight in grams |
| `barcode` | string | No | Product barcode |
| `item_id` | integer | No | The product item ID |
| `minimum` | integer | No | Minimum order quantity |
| `unit_id` | integer | No | Unit ID |
| `quantity` | integer | No | Stock quantity to update |
| `status_id` | integer | No | Status ID |
| `unit_value` | number | No | Unit value |
| `delivery_price` | integer | No | Delivery price in cents |
| `out_of_stock_id` | integer | No | Out of stock status ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Variant Option

**Slug:** `CLOUDCART_UPDATE_VARIANT_OPTION`

Tool to update an existing variant option. Use when you need to modify a variant option's name, sort order, color, or visibility.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The ID of the variant option to update |
| `name` | string | No | A human readable name for this variant option |
| `sort` | integer | No | Sort order for this variant option |
| `color` | string | No | Display color for this variant option (hex code or color name) |
| `visible` | integer | No | Visibility status (1 = visible, 0 = hidden) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Variant Parameter

**Slug:** `CLOUDCART_UPDATE_VARIANT_PARAMETER`

Tool to update an existing variant parameter for a product variant. Use when you need to modify attributes like display_type, name, sort order, or visibility.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the variant parameter to update. |
| `name` | string | No | Name of the variant parameter. |
| `sort` | integer | No | Sort order for displaying the parameter. |
| `visible` | boolean | No | Whether the parameter is visible to customers. |
| `display_type` | string | No | Display type for the variant parameter (e.g., 'radio', 'select', 'checkbox'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Vendor

**Slug:** `CLOUDCART_UPDATE_VENDOR`

Updates an existing vendor's information in CloudCart. Use this to modify a vendor's name or image URL. You can update one or both fields. Requires a valid vendor ID - obtain this from Create Vendor or List Vendors actions first. This is a partial update (PATCH) operation, so you only need to provide the fields you want to change.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data wrapper for update vendor request following JSON:API specification. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Webhook

**Slug:** `CLOUDCART_UPDATE_WEBHOOK`

Tool to update an existing webhook configuration in CloudCart. Use when you need to modify the webhook URL or custom request headers for webhook notifications. At least one optional field (url or request_headers) must be provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The webhook identifier to be updated |
| `url` | string | No | Webhook destination URL. Must be a valid HTTPS URL. |
| `request_headers` | object | No | Custom headers to include in webhook requests. Provide as key-value pairs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
