Skip to main content
Cloudcart logo
  • Category: ecommerce
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 150
  • Triggers: 0
  • Slug: CLOUDCART
  • Version: 20261101_00

Tools

Slug: CLOUDCART_ADD_CATEGORY_PROPERTIESTool 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

string
required
The unique identifier of the category to add properties to
array
required
List of property IDs to associate with the category

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_ADD_TO_CARTTool to add an item to the cart. Use after confirming a product selection with desired quantity.

Input Parameters

integer
required
The number of units of the product to add, must be at least 1.
integer
required
The unique identifier of the product to be added to the cart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CLEAR_CARTRemove all items from the cart to empty it before adding new items or starting over.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_BLOG_CATEGORYCreate a new blog category in CloudCart using a category name, to organize blog posts into categories.

Input Parameters

string
required
A human readable name for this blog category

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_BLOG_POSTTool 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

string
required
Title of the blog post.
string
required
ID of the blog to associate this post with. Required to publish the post to a specific blog.
string
required
Content/body text of the blog post. Supports HTML formatting.
array
List of tag IDs to associate with this post for categorization and filtering.
string
required
ID of the author to assign to this post. Required to attribute the post to an author.
string
URL of the featured image for the blog post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_BLOG_TAGSTool 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

object
required
Data wrapper for create blog tag request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_CATEGORYTool to create a new category. Use when you need to add organizational structure to your product catalog.

Input Parameters

string
required
Title of the category
integer
Sorting position of the category (0 = first)
string
SEO meta title
string
Detailed description of the category
string
Comma-separated SEO keywords
string
SEO meta description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_CUSTOMERTool 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

string
required
Customer’s email address.
string
required
Password for the customer’s account. Must be at least 8 characters.
string
required
Last name of the customer.
string
required
First name of the customer.
string
Phone number of the customer. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_CUSTOMER_BILLING_ADDRESSTool 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

string
Phone number
string
required
City designation
string
required
Customer’s surname
string
Postal code
string
required
Customer’s given name
string
required
Unique identifier of the existing customer to associate this billing address with
string
required
Street designation
string
required
Official ISO Country Code (2-letter)
string
Street number
string
Phone country code (2-letter ISO code)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_CUSTOMER_GROUPSTool 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

object
required
Data wrapper for create customer groups request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_CUSTOMER_SHIPPING_ADDRESSTool 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

string
Optional note for delivery instructions
string
required
Customer’s telephone number
string
required
City of the address
string
required
Customer’s surname
string
required
Postal code
string
required
Customer’s given name
string
required
ID of the customer this address belongs to
string
required
Street designation
string
required
ISO 3166-1 alpha-2 country code for the address location
string
required
Building number
string
required
ISO 3166-1 alpha-2 country code for phone validation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_CUSTOMER_TAGSTool 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

string
required
The tag label to be created for customers

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_DISCOUNTCreate a new CloudCart discount for promotions, sales, or special offers. Supports fixed, percent, flat, and shipping discount types, with targeting options including all products, specific products, categories, and vendors.

Input Parameters

string
Optional discount code that customers can use to apply the discount.
string
required
Name of the discount for identification purposes.
string
Discount active status. Use ‘yes’ to activate or ‘no’ to keep inactive.
object
required
Target configuration specifying what the discount applies to.
string
End date of the discount in YYYY-MM-DD format. If not provided, discount has no end date.
integer
Maximum number of times this discount can be used in total.
string
required
Start date of the discount in YYYY-MM-DD format.
integer
Minimum order amount required for the discount to apply (in smallest currency unit).
integer
required
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).
string ("fixed" | "percent" | "flat" | "shipping")
required
Type of discount to apply. ‘fixed’ for fixed amount, ‘percent’ for percentage, ‘flat’ for flat discount, ‘shipping’ for shipping discount.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_DISCOUNT_CODECreate 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

string
required
Unique discount code string (alphanumeric characters recommended)
integer
required
Discount percentage multiplied by 100. Example: 10% discount = 1000, 15% discount = 1500
integer
required
Status of the discount code: 1 for active, 0 for inactive

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_IMAGESTool 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

string
required
The URL for an image to upload. Must be a valid HTTP/HTTPS URL pointing to an image file.
string
required
The ID of the product to associate the image with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_LINKED_PRODUCTSTool 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

string
required
The ID of the source product to add linked products to.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_ORDERTool to create a new order. Use after assembling customer ID, cart items, and optional addresses/payment info.

Input Parameters

array
required
List of line items for the order
string
ISO 4217 currency code
integer
required
ID of the customer placing the order
string ("credit_card" | "paypal" | "bank_transfer")
Payment method code; if omitted, default store method applies
object
Billing address; if omitted, same as shipping_address
object
Shipping address; if omitted, uses customer’s default address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_PRODUCTCreates 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

string
Stock keeping unit identifier.
string
required
Name of the product.
array
List of tags.
number
required
Price of the product; must be non-negative.
array
List of image URLs.
string
Status of the product (e.g., active, draft).
string
ID of the vendor to associate.
number
Weight in kilograms; must be non-negative.
string
Barcode (e.g., UPC/EAN).
integer
Available quantity; must be non-negative.
array
required
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.
string
Description of the product (HTML allowed).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_PRODUCTS_PROPERTY_OPTIONSTool 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

string
required
The unique identifier of the product to add property options to
array
required
List of property option IDs to associate with the product

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_PRODUCT_TO_DISCOUNTTool 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

number
Optional discounted price for the product variant in currency units (e.g., dollars). Will be converted to cents internally. Must be non-negative.
string
required
ID of the product to associate with the discount.
string
required
ID of the product variant to associate with the discount.
string
required
ID of the discount to associate with the product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_PROPERTIESTool 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

string
required
A human readable name for this property
integer
Sort order for displaying the property
integer
Active status: 1 for active, 0 for inactive
integer
Visibility flag: 1 for visible, 0 for hidden
string
A human readable slug value. Must be unique
string ("checkbox" | "select" | "radio" | "range")
required
Display type for the property

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_PROPERTY_OPTIONTool 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

integer
Sort order ranking for displaying the option
string
required
A human readable name for this property option
string
SEO Title for the option
string
required
A human readable slug value. Must be unique
string
Description of the property option. Can be HTML
string
required
The unique identifier of the property to associate this option with
string
SEO Description for the option

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_REDIRECTSCreate 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

object
Relationship to an item (product, category, or vendor)
string
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).
string
required
Old URL path to redirect from (must be unique). Include the leading slash.
string ("product" | "category" | "vendor" | "manual" | "external")
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_SUBSCRIBERSTool 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

string
required
Two-letter ISO 3166-1 alpha-2 country code (e.g., ‘US’ for United States, ‘BG’ for Bulgaria).
string
required
The subscriber’s family name.
string
required
The subscriber’s given name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_SUBSCRIBERS_CHANNELSTool 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

string ("0" | "1")
required
Bounce status indicator: ‘0’ (not bounced) or ‘1’ (bounced).
string ("Email" | "Phone")
required
Communication channel type: either ‘Email’ or ‘Phone’.
string ("0" | "1")
required
Verification status: ‘0’ (not verified) or ‘1’ (verified).
string ("0" | "1")
required
Marketing consent flag: ‘0’ (no consent) or ‘1’ (consent given).
string
required
The subscriber’s unique identifier.
string
required
The actual contact value (email address or phone number) for the specified channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_SUBSCRIBERS_TAGSTool 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

string
required
Unique identifier of the customer tag to associate with the subscriber
string
required
Unique identifier of the subscriber to associate with the tag

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_VARIANTTool 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

string
required
SKU of the new variant
number
required
Price of the variant in currency units (will be converted to smallest unit/cents internally)
number
Weight of the variant in kilograms (will be converted to grams internally)
integer
Stock quantity for the variant
string
required
ID of the product to which the variant belongs
array
List of option values objects, each with product_option_id and value_id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_VARIANT_OPTIONTool 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

string
required
Name of the variant option
number
Price difference for this option
integer
The order of the option among siblings
boolean
Whether this is the default option
integer
required
ID of the product to which the variant belongs
integer
required
ID of the variant for which to create an option

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_VARIANT_OPTIONSTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_VARIANT_PARAMETERTool 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

string
required
Name of the parameter (e.g., ‘color’, ‘size’).
string ("text" | "number" | "boolean" | "date")
Type of the parameter. One of ‘text’, ‘number’, ‘boolean’, or ‘date’.
string
required
Value of the parameter (e.g., ‘red’, ‘XL’).
string
required
The ID of the product.
string
required
The ID of the product variant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_VARIANT_PARAMETERSTool 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

string
required
A unique, human-readable name for the variant parameter (e.g., ‘Size’, ‘Color’, ‘Material’)
string ("select" | "radio" | "image" | "color" | "2d" | "numeric_alpha")
required
How the variant parameter appears to users in the interface

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_VENDORCreate 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

object
required
Data wrapper for create vendor request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_CREATE_WEBHOOKSTool 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

string
required
The URL endpoint where webhook events will be sent. Must be a valid HTTPS URL.
string
required
The event that triggers the webhook. Common events include ‘order.created’ and ‘order.updated’, but other events may be supported.
object
Optional custom headers to append to webhook HTTP requests as key-value pairs.
integer
New version of the orders webhook. Only applies to ‘order.created’ and ‘order.updated’ events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_BLOG_CATEGORYTool to delete a blog category by its ID. Use after confirming the correct ID to permanently remove it.

Input Parameters

string
required
Unique identifier of the blog category to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_BLOG_POSTTool to delete a blog post by its ID. Use after confirming the correct ID to permanently remove the blog post.

Input Parameters

string
required
The unique identifier of the blog post to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_BLOG_TAGTool 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

string
required
Unique identifier of the blog tag to delete. This is a numeric ID represented as a string (e.g., ‘1’, ‘2’, ‘123’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_CATEGORYTool to delete a category by its ID. Use after confirming the correct ID to permanently remove it.

Input Parameters

string
required
Unique identifier of the category to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_CUSTOMERTool to delete a customer. Use when you need to remove a customer by their ID. Example: “Delete customer with ID 123”.

Input Parameters

integer
required
ID of the customer to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_CUSTOMER_BILLING_ADDRESSTool 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

string
required
The ID of the customer billing address to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_CUSTOMER_GROUPTool to delete a customer group by its ID. Use when you need to permanently remove a customer group from the store.

Input Parameters

string
required
The identifier of the group intended for removal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_CUSTOMER_SHIPPING_ADDRESSTool to delete a customer shipping address. Use when you need to remove a customer’s shipping address by its ID.

Input Parameters

integer
required
The ID of the customer shipping address to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_CUSTOMER_TAGTool to delete a customer tag by its ID. Use after confirming the tag exists to permanently remove it.

Input Parameters

string
required
The unique identifier of the customer tag to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_DISCOUNTTool to delete a discount by its ID. Use after confirming the discount exists to permanently remove it from the store.

Input Parameters

string
required
The unique identifier of the discount to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_DISCOUNT_CODETool to delete a discount code by its ID. Use after confirming the discount code exists to permanently remove it from the store.

Input Parameters

string
required
The ID of the discount code to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_IMAGETool to delete an image by its ID. Use when you need to remove an image permanently from the CloudCart store.

Input Parameters

string
required
The unique identifier of the image to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_ORDERTool to delete an order. Use after confirming the order exists.

Input Parameters

string
required
The unique identifier of the order to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_PRODUCTTool to delete a product by its ID. Use after confirming the product exists to permanently remove it from the catalog.

Input Parameters

string
required
The unique identifier of the product to delete (numeric ID as string).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_PRODUCTS_LINKED_PRODUCTSTool 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

string
required
The ID of the parent product from which to remove linked products.
array
required
List of linked products to remove. Each item specifies a product ID that should be unlinked from the parent product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_PRODUCT_TO_DISCOUNTTool to delete a product-to-discount relationship by its ID. Use to remove the association between a product and a discount.

Input Parameters

string
required
The unique identifier of the product-to-discount relationship to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_PROPERTYTool to delete a property by its ID. Use after confirming the correct property ID to permanently remove it from the store.

Input Parameters

string
required
The ID of the property you wish to delete. This is a numeric ID represented as a string (e.g., ‘3’, ‘15’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_PROPERTY_OPTIONSTool to delete a property option by its ID. Use when you need to remove obsolete property options or clean up test data.

Input Parameters

string
required
The unique identifier of the property option to delete (numeric ID as string).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_REDIRECTTool 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

string
required
The unique identifier of the redirect to delete. This is a numeric ID represented as a string (e.g., ‘2’, ‘15’, ‘123’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_SUBSCRIBERTool to delete a subscriber by their ID. Use when you need to remove a subscriber from the mailing list.

Input Parameters

string
required
The unique identifier of the subscriber to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_SUBSCRIBERS_CHANNELTool 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

string
required
The ID of the subscriber channel to delete. This is a numeric ID represented as a string (e.g., ‘12’, ‘15’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_SUBSCRIBERS_TAGTool to delete a subscriber tag by its ID. Use after confirming the tag exists to permanently remove it.

Input Parameters

string
required
The unique identifier of the subscriber tag to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_VARIANTTool to delete a variant by its ID. Use when you need to permanently remove a product variant from the catalog.

Input Parameters

string
required
The unique identifier of the variant to delete. This is a numeric ID represented as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_VARIANT_OPTIONTool 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

string
required
The unique identifier of the variant option to delete (numeric ID as string).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_VARIANT_PARAMETERTool 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

string
required
The ID of the variant parameter you wish to delete. This is a numeric ID represented as a string (e.g., ‘5’, ‘10’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_VENDORDelete 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

string
required
Unique identifier of the vendor to delete. This is a numeric ID represented as a string (e.g., ‘15’, ‘20’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_DELETE_WEBHOOKTool 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

string
required
The unique identifier of the webhook to delete. This is a numeric ID represented as a string (e.g., ‘1’, ‘5’, ‘42’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GENERATE_DISCOUNT_CODESTool 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

integer
required
Number of discount codes to generate. Must be at least 1.
integer
required
The percent of discount for each code (multiplied by 100). Example: 10% discount is represented as 1000, 25% as 2500.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_BLOG_AUTHORTool to retrieve details of a specific blog author by ID. Use when you need information about a blog author.

Input Parameters

string
required
The ID of the blog author to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_BLOG_CATEGORYTool to retrieve details of a specific blog category by ID. Use when you need information about a particular blog category.

Input Parameters

string
required
The ID for the requested blog category

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_BLOG_POSTTool 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

string
required
The ID of the blog post to retrieve
array
Allows filtering of post attributes. Specify which fields to include in the response (e.g., [‘name’, ‘content’, ‘author_id’])

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_BLOG_TAGTool to retrieve details of a specific blog tag by ID. Use when you need to fetch information about a particular tag.

Input Parameters

string
required
The ID of the blog tag to retrieve
array
Filter tag attributes to return only specified fields (respects the Fields filtering mechanism)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_CARTRetrieve a shopping cart, optionally by cart ID, to view or verify its contents before checkout.

Input Parameters

string
The unique identifier of the cart. If not provided, retrieves the current session cart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_CATEGORIESRetrieve available categories for selection. Category IDs are returned as strings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_CATEGORIES_PROPERTIESTool to retrieve properties relationship for a category. Use when you need to get the list of properties assigned to a specific category.

Input Parameters

integer
required
The category ID to retrieve properties for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_CATEGORYTool to retrieve details of a specific category by ID. Use when you need information about a single category.

Input Parameters

string
required
Unique identifier of the category to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_CUSTOMERTool to retrieve details of a specific customer by ID. Use when you need information about a single customer.

Input Parameters

string
required
The ID for the requested Customer
string
Enables filtering of customer attributes returned. Comma-separated list of field names
string
Allows you to include customer relationships in response (e.g., ‘group’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_CUSTOMER_BILLING_ADDRESSTool 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

string
required
The unique identifier of the billing address to retrieve
string
Comma-separated list of specific address attributes to return. If not specified, all fields are returned
string
Comma-separated list of relationships to include in the response (e.g., ‘customer’ to load associated customer data)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_CUSTOMER_GROUPTool to retrieve details of a specific customer group by ID. Use when you need to fetch information about a particular customer group.

Input Parameters

string
required
Unique identifier of the customer group to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_CUSTOMER_GROUPS_CUSTOMERSRetrieve a paginated list of customers belonging to a specific customer group. Supports page size and sorting.

Input Parameters

integer
required
The customer group ID to retrieve customers from
string
Sort order by field name. Prefix with ’-’ for descending order (e.g., ‘-id’ for newest first)
integer
Number of items per page for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_CUSTOMERSTool 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

string
Sort order by field name. Prefix with ’-’ for descending order (e.g., ‘-date_added’ for newest first)
integer
Number of items per page for pagination
integer
Page number for pagination, starting from 1
string
Filter customers by email address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_CUSTOMER_SHIPPING_ADDRESSTool 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

array
Enables filtering of specific address attributes to return. Specify field names to limit the response.
string
Allows including associated customer relationship data. Use ‘customer’ to include related customer details.
string
required
Unique identifier of the customer shipping address to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_CUSTOMER_TAGTool to retrieve details of a specific customer tag. Use when you have the customer tag ID and need to get its details.

Input Parameters

string
required
Unique identifier of the customer tag to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_IMAGETool 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

string
required
Unique identifier of the image to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_ORDERSRetrieve 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

integer
Number of items per page for pagination. Defaults to 20 if not specified.
integer
Page number for pagination, starting from 1. Defaults to 1 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_PAYMENT_METHODSTool to retrieve all available payment methods. Use when you need to list supported payment options before checkout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_PRODUCTSTool 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

integer
Page number of results to fetch (1-based).
integer
Number of products to return per page.
Text to search for in product names and descriptions.
integer
Filter products by brand ID.
number
Maximum price filter (inclusive).
number
Minimum price filter (inclusive).
integer
Filter products by category ID.
boolean
Include hidden products when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_PRODUCTS_LINKED_PRODUCTTool 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

string
required
The product ID to get linked products for
integer
Page number of results to fetch (1-based)
integer
Number of linked products to return per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_PRODUCTS_LINKED_PRODUCTSRetrieves linked-product relationship references for a specified product. Returns linked product IDs and resource types, with pagination metadata when available.

Input Parameters

string
required
The unique identifier for the parent product

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_PRODUCT_WITH_RELATIONSRetrieves 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

string
required
Unique identifier of the product to retrieve (numeric ID as string).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_PROPERTYTool to retrieve details of a specific property by ID. Use when you need information about a single property.

Input Parameters

string
required
The unique identifier for the property to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_PROPERTY_OPTIONTool to retrieve details of a specific property option by ID. Use when you need information about a single property option.

Input Parameters

string
required
The unique identifier for the property option to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_PROPERTY_OPTIONS_RELATIONSHIPTool 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

integer
required
ID of the product whose property options relationships to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_SHIPPING_METHODSTool to retrieve all available shipping methods. Use when you need to list shipping options before checkout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_SUBSCRIBERTool 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

string
required
The ID for the requested Subscriber
string
Filter subscriber attributes returned. Comma-separated list of field names
string
Include subscriber relationships in response (e.g., ‘channels’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_SUBSCRIBERS_CHANNELTool 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

string
required
The unique identifier for the requested subscriber channel.
string
Comma-separated list of specific channel attributes to include in the response.
string
Include related subscriber channel relationships (e.g., ‘subscriber’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_SUBSCRIBERS_TAGTool to retrieve details of a specific subscriber tag by ID. Use when you need to get information about a subscriber tag association.

Input Parameters

string
required
Unique identifier of the subscriber tag to retrieve
string
Restricts response to specified subscriber tag attributes (comma-separated)
string
Enables relationship data retrieval for subscriber tags (comma-separated)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_VARIANTTool to retrieve details of a specific variant by ID. Use when you need information about a single product variant.

Input Parameters

string
required
Unique identifier of the variant to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_VARIANT_OPTIONTool 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

string
required
The unique identifier for the variant option resource

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_VARIANT_PARAMETERTool to retrieve details of a specific variant parameter by ID. Use when you need information about a single variant parameter.

Input Parameters

string
required
The unique identifier for the variant parameter to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_VENDORTool to retrieve details of a specific vendor. Use when you have the vendor ID.

Input Parameters

string
required
Unique identifier of the vendor to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_GET_WEBHOOKTool to retrieve details of a specific webhook by ID. Use when you need information about a webhook configuration.

Input Parameters

string
required
The ID for the requested Webhook
string
Filter webhook attributes returned. Comma-separated list of field names
string
Include webhook relationships in response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_BLOG_CATEGORIESTool 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

string
Sort field. Prefix with ’-’ for descending order (e.g., ‘-date_modified’).
string
Comma-separated list of fields to include in response.
string
Filter criteria in format ‘field:value’.
integer
Number of blog categories per page.
integer
Page number for pagination (1-based).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_BLOG_POSTSTool 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

integer
Page number for pagination (1-based).
string
Sort the results by field name. Prefix with ’-’ for descending order.
integer
Number of blog posts per page.
string
Filter blog post attributes to return. Comma-separated field names.
string
Filter the results by field values. Format: field:value
string
Include related resources like authors or blogs. Comma-separated values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_BLOG_TAGSTool 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

string
Sorting configuration. Prefix with ’-’ for descending order (e.g., ‘-created_at’).
array
Filter tag attributes to include in response. Array of field names.
array
Filtering options. Array of filter expressions.
integer
Items per page for pagination.
integer
Current page number (1-based).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_CUSTOMER_BILLING_ADDRESSTool 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

string
Sort order by field name. Prefix with ’-’ for descending order (e.g., ‘-id’ for newest first)
string
Related resources to include in response (e.g., ‘customer’ to include customer data)
integer
Number of items per page for pagination
integer
Page number for pagination, starting from 1

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_CUSTOMER_GROUPSTool 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

integer
Number of items per page for pagination
integer
Page number for pagination, starting from 1

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_CUSTOMER_SHIPPING_ADDRESSESTool 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

string
Sort order by field name. Prefix with ’-’ for descending order (e.g., ‘-id’ for newest first)
string
Include related resources (e.g., ‘customer’ to include customer data)
integer
Number of items per page for pagination
integer
Page number for pagination, starting from 1
integer
Filter addresses by customer ID
string
Filter addresses by country ISO2 code (e.g., ‘US’, ‘GB’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_CUSTOMER_TAGSTool to retrieve all customer tags. Use when you need to list available tags for customer categorization or filtering.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_DISCOUNT_CODESList discount codes from your CloudCart store to check their status or manage promotions. Results are paginated, with optional filtering and sorting.

Input Parameters

string
Sort results by specified criteria. Prefix with ’-’ for descending order.
string
Limit returned resource attributes (comma-separated list of field names).
string
Filter results based on conditions (e.g., ‘active:1’ for active codes only).
string
Include related resource relationships (comma-separated list).
integer
Number of items per page for pagination. Defaults to API default if not specified.
integer
Page number for pagination, starting from 1. Defaults to 1 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_IMAGESTool to retrieve all images from CloudCart. Use when you need a paginated list of images.

Input Parameters

integer
Page number for pagination (1-based).
integer
Number of images per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_ORDER_BILLING_ADDRESSTool 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

string
Sort order by field name. Prefix with ’-’ for descending order (e.g., ‘-id’ for newest first)
string
Related resources to include in response (e.g., ‘order’ to include order data)
integer
Number of items per page for pagination
integer
Page number for pagination, starting from 1

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_ORDER_PAYMENTRetrieve 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

integer
Page number for pagination (1-based).
integer
Number of orders to retrieve per page (max 100).
integer
Filter by a specific order ID. If provided, retrieves payment info for that order only.
string
Filter orders by payment status (e.g., ‘paid’, ‘pending’, ‘failed’, ‘refunded’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_ORDER_PAYMENT2Tool 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

integer
Number of items per page for pagination. Defaults to 20 if not specified.
integer
Page number for pagination, starting from 1. Defaults to 1 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_ORDER_PRODUCTSRetrieve 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

integer
Number of items per page for pagination. Defaults to 20 if not specified.
integer
Page number for pagination, starting from 1. Defaults to 1 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_ORDER_PRODUCTS_OPTIONSTool to retrieve order products options (read-only). Use when you need to list custom field options associated with products in orders.

Input Parameters

integer
Number of items per page for pagination. Defaults to API default if not specified.
integer
Page number for pagination, starting from 1. Defaults to 1 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_ORDER_SHIPPINGTool to retrieve order shipping data. Use when you need to list shipping information for orders.

Input Parameters

integer
Number of items per page for pagination
integer
Page number for pagination, starting from 1

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_ORDER_SHIPPING_ADDRESSRetrieve a paginated list of order shipping addresses from CloudCart. Filter by order ID to view or export addresses associated with an order.

Input Parameters

string
Include related resources (e.g., ‘order’ to include order data)
integer
Number of items per page for pagination
integer
Page number for pagination, starting from 1
integer
Filter addresses by order ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_ORDER_STATUSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_PAYMENT_PROVIDERSTool to retrieve all payment providers (read-only). Use when you need to view configured payment providers in the store.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_PROPERTIESLists CloudCart properties with optional pagination and returns property information and pagination metadata.

Input Parameters

integer
Number of properties per page.
integer
Page number for pagination (1-based).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_PROPERTY_OPTIONSTool 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

integer
Number of records per page (default: 20).
integer
Page number for pagination (1-based).
string
Filter property options by property ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_REDIRECTSList CloudCart URL redirects with optional pagination and filters for related item type and ID. Results include pagination metadata and links.

Input Parameters

integer
Page number for pagination (1-based).
integer
Number of redirects per page.
string
Filter redirects by item ID.
string
Filter redirects by item type (product, category, vendor, manual, external).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_SHIPPING_PROVIDERSList configured CloudCart shipping providers. The response may include pagination metadata and links.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_SUBSCRIBERSRetrieve a page of store subscribers, with optional customer filtering and sorting. Subscriber information may include engagement metrics such as open and click rates.

Input Parameters

string
Sort order by field name. Prefix with ’-’ for descending order (e.g., ‘-created_at’ for newest first)
integer
Number of items per page for pagination (default 20, max 100)
integer
Page number for pagination, starting from 1
integer
Filter subscribers by customer ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_SUBSCRIBERS_CHANNELSRetrieve a page of subscriber channels, with optional filtering and sorting. Returned channel attributes are limited to name, description, and timestamps.

Input Parameters

string
Sort the results. Prefix with ’-’ for descending order
string
Filter subscribers channels attributes to return specific fields
string
Filter data based on specific criteria
string
Include subscribers channels relationships
integer
Number of items to return per page
integer
The current page number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_SUBSCRIBERS_TAGSRetrieve a page of subscriber tag associations. Supports pagination, filtering, and sorting.

Input Parameters

string
Sort the results by field name. Prefix with ’-’ for descending order
string
Filter subscriber tag attributes to return only specified fields
string
Filter the results based on specific criteria
string
Include subscriber tag relationships in the response
integer
The number of items to return per page for pagination
integer
The number of the current page for pagination, starting from 1

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_VARIANT_OPTIONSTool to retrieve all variant options. Use when you need to list available variant options with optional pagination.

Input Parameters

integer
Page number for pagination (1-based).
integer
Number of records per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_VARIANT_PARAMETERSTool 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

integer
Page number for pagination (1-based).
integer
Number of records per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_VARIANTSTool 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

string
Filter variants by SKU.
integer
Page number for pagination (1-based).
integer
Number of records per page.
integer
Filter variants by product item ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_VENDORSTool 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

integer
Page number for pagination (1-based).
integer
Number of records per page.
string
Filter vendors by name or other searchable fields.
string
Filter vendors by status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_LIST_WEBHOOKSRetrieve a paginated list of webhooks to view configured subscriptions and their events, with optional filtering and sorting.

Input Parameters

string
Sort order by field name. Prefix with ’-’ for descending order
string
Filter webhook attributes to return (comma-separated field names)
string
Filter the results by specific criteria
string
Include webhook relationships in response (comma-separated)
integer
Number of items per page for pagination
integer
Page number for pagination, starting from 1

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_REMOVE_FROM_CARTTool to remove an item from the cart. Use after confirming the product exists in the cart to delete it.

Input Parameters

integer
required
The unique identifier of the product to be removed from the cart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_BLOG_CATEGORYTool to update an existing blog category. Use when you need to modify blog category details such as name, SEO settings, or image.

Input Parameters

string
required
Unique identifier of the blog category to update
string
Name of the blog category
string
Image URL for the blog category
string
Comments or notes about the blog category
string
SEO title for the blog category
string
URL handle/slug for the blog category
string
SEO description for the blog category

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_BLOG_POSTTool 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

string
required
The unique identifier of the blog post to update
string
Updated title of the blog post
string
Updated content/body of the blog post (supports HTML)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_BLOG_TAGTool to update an existing blog tag. Use when you need to modify a blog tag’s name or label.

Input Parameters

string
required
The unique identifier of the blog tag to update
string
required
The updated tag name/label for the blog tag

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_CART_ITEMTool 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

integer
required
The new quantity for the product in the cart; must be at least 1.
integer
required
The unique identifier of the product to update in the cart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_CATEGORYTool to update an existing category. Use when you need to modify category details after reviewing its current values.

Input Parameters

string
required
Unique identifier of the category to update
string
Title of the category
integer
Sorting position of the category (0 = first)
string
SEO meta title
string
Detailed description of the category
string
SEO meta keywords, comma-separated
string
SEO meta description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_CUSTOMERUpdates 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

string
Customer’s email address. Optional.
string
Password for the customer’s account. Must be at least 8 characters. Optional.
string
Last name of the customer. Optional.
string
First name of the customer. Optional.
integer
required
ID of the customer to update
string
Alternative phone number of the customer. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_CUSTOMER_BILLING_ADDRESSTool 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

string
required
The ID of the billing address to update
string
Additional notes or instructions for the billing address
string
Phone number for the billing address
string
Name of the city for the billing address
string
Last name for the billing address contact
string
Postal/ZIP code for the billing address
string
First name for the billing address contact
string
Company VAT number for the billing address
string
Street name for the billing address
string
Company name for the billing address
string
ISO2 country code for the billing address (e.g., ‘US’, ‘GB’)
string
ISO2 country code for the phone number (e.g., ‘US’, ‘GB’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_CUSTOMER_GROUPTool 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

string
required
The ID of the customer group you wish to update
string
required
The name of the customer group. Must be unique.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_CUSTOMER_SHIPPING_ADDRESSTool 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

string
required
The unique identifier of the shipping address to update
string
Additional notes or delivery instructions for the shipping address
string
Customer’s phone number. Must be valid for the country specified in phone_country_iso2
string
Name of the city for the shipping address
string
Customer’s last name for the shipping address
string
Postal code / ZIP code of the shipping address
string
Customer’s first name for the shipping address
string
Street name of the shipping address
string
Two-letter ISO country code for the shipping address (e.g., ‘US’, ‘BG’, ‘GB’)
string
Street number of the shipping address
string
Two-letter ISO country code for phone number validation (e.g., ‘US’, ‘BG’, ‘GB’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_CUSTOMER_TAGTool to update an existing customer tag in CloudCart. Use when you need to rename or modify a customer tag’s label.

Input Parameters

string
required
The unique identifier of the customer tag to update
string
required
The new tag label/name to assign to this customer tag

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_DISCOUNT_CODETool 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

string
required
The unique identifier of the discount code to update
string
The promotional code identifier. Must contain only letters and numbers (alphanumeric). Optional.
integer
Discount percentage multiplied by 100. Example: 10% discount = 1000, 15% discount = 1500. Must be at least 1. Optional.
integer
Status flag: 0 = inactive, 1 = active. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_LINKED_PRODUCTUpdates 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

string
required
The unique identifier of the product whose linked products you want to update.
array
required
List of products to link. Each entry specifies a product ID and optionally whether the link is bidirectional. Replaces existing linked products.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_ORDERTool 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

string
required
Unique identifier of the order to update
object
required
Order fields to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_PRODUCTUpdates an existing CloudCart product by ID and returns product details. Returned price and stock come from the product response and default to zero when absent; variant-level values may need separate management.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_PROPERTYTool to update an existing property. Use when you need to modify property details such as display type, name, or visibility settings.

Input Parameters

string
required
The ID of the property to update
string
Name of the property
integer
Sort order for the property (0 = first)
boolean
Whether the property is active
boolean
Whether the property is visible
string
URL-friendly handle for the property
string
Display type for the property (e.g., ‘radio’, ‘select’, ‘checkbox’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_PROPERTY_OPTIONUpdate an existing property option by ID. The update requires and sends both its value and URL handle, with optional description, sort, and SEO fields.

Input Parameters

string
required
The ID of the property option you wish to update
integer
Sort order ranking for displaying the option
string
required
A human readable name for this property option
string
SEO Title for the option
string
required
A human readable slug value. Must be unique
string
Description of the property option. Can be HTML
string
SEO Description for the option

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_SUBSCRIBERUpdate an existing CloudCart subscriber by ID. The update requires and sends the subscriber’s first name, last name, and two-letter country code together.

Input Parameters

string
required
Two-letter ISO 3166-1 alpha-2 country code (e.g., ‘US’ for United States, ‘BG’ for Bulgaria)
string
required
Last name of the subscriber
string
required
First name of the subscriber
string
required
The ID of the subscriber to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_SUBSCRIBERS_CHANNELTool 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

string
required
The unique identifier of the subscriber channel to update.
string ("0" | "1")
Enumeration for boolean flags represented as strings (0 or 1).
string ("Email" | "Phone")
Enumeration of valid channel types for subscriber channels.
string ("0" | "1")
Enumeration for boolean flags represented as strings (0 or 1).
string ("0" | "1")
Enumeration for boolean flags represented as strings (0 or 1).
string
The subscriber’s unique identifier. Optional.
string
The actual contact value (email address or phone number) for the specified channel. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_SUBSCRIBER_TAGTool 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

string
required
The unique identifier of the subscribers-tags relationship to update
string
required
The identifier of the tag to associate with the subscriber
string
required
The identifier of the subscriber to associate with the tag

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_VARIANTTool to update an existing product variant. Use when you need to modify variant details such as quantity, price, SKU, or other attributes.

Input Parameters

string
required
The ID of the variant to update
string
Variant parameter 1 value
string
Variant parameter 2 value
string
Variant parameter 3 value
string
Stock Keeping Unit code
integer
Price in cents (smallest currency unit)
integer
Variant parameter 1 ID
integer
Variant parameter 2 ID
integer
Variant parameter 3 ID
integer
Weight in grams
string
Product barcode
integer
The product item ID
integer
Minimum order quantity
integer
Unit ID
integer
Stock quantity to update
integer
Status ID
number
Unit value
integer
Delivery price in cents
integer
Out of stock status ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_VARIANT_OPTIONTool to update an existing variant option. Use when you need to modify a variant option’s name, sort order, color, or visibility.

Input Parameters

integer
required
The ID of the variant option to update
string
A human readable name for this variant option
integer
Sort order for this variant option
string
Display color for this variant option (hex code or color name)
integer
Visibility status (1 = visible, 0 = hidden)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_VARIANT_PARAMETERTool 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

string
required
The ID of the variant parameter to update.
string
Name of the variant parameter.
integer
Sort order for displaying the parameter.
boolean
Whether the parameter is visible to customers.
string
Display type for the variant parameter (e.g., ‘radio’, ‘select’, ‘checkbox’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_VENDORUpdates 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

object
required
Data wrapper for update vendor request following JSON:API specification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLOUDCART_UPDATE_WEBHOOKTool 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

string
required
The webhook identifier to be updated
string
Webhook destination URL. Must be a valid HTTPS URL.
object
Custom headers to include in webhook requests. Provide as key-value pairs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not