The CloudCart connector lets your AI agent act in each user's CloudCart account. Each user connects their own CloudCart API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 58 tools.
- Tools
- 58
- What they doRead · write · destructive
- 30 · 19 · 930 read19 write9 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the CloudCart connection
In AgentKit > Connections, create a CloudCart connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'cloudcart'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize CloudCart:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'cloudcart_categories_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "cloudcart"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize CloudCart:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="cloudcart_categories_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their CloudCart credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolcloudcart_categories_listList the product categories of a CloudCart store.Read-onlyList Categories
List the product categories of a CloudCart store. Returns categories with name, slug, description, order and parent ID. Use this to find category IDs for products and discounts.
Inputs
filter_parent_idstring- Only children of this category ID. Example: 3.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
sortstring- Sort field, with a leading - for descending. Allowed: name, order, id. Example: -name.
cloudcart_category_getGet one CloudCart category.Read-onlyGet Category
Get one CloudCart category. Returns the category's name, slug, description, image and parent. Use this for a category's details.
Inputs
idstringrequired- ID of the category, from cloudcart_categories_list. Example: 1042.
cloudcart_customer_getGet one CloudCart customer.Read-onlyGet Customer
Get one CloudCart customer. Returns the customer's details; include adds orders, addresses and group. Use this for a customer's details.
Inputs
idstringrequired- ID of the customer, from cloudcart_customers_list. Example: 1042.
includestring- Related resources to include, comma-separated: orders, shipping-addresses, billing-addresses, group. Example: orders.
cloudcart_customer_groups_listList the customer groups of a CloudCart store.Read-onlyList Customer Groups
List the customer groups of a CloudCart store. Returns groups with name and discount percent. Use this to find group IDs.
Inputs
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
cloudcart_customer_shipping_addresses_listList saved customer shipping addresses in CloudCart, optionally for one customer.Read-onlyList Customer Shipping Addresses
List saved customer shipping addresses in CloudCart, optionally for one customer. Returns addresses with name, phone, street, city, postcode and country. Use this to read a customer's addresses.
Inputs
filter_customer_idstring- Only addresses of this customer ID. Example: 1201.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
cloudcart_customers_listList the customers of a CloudCart store, filtered by any column such as email.Read-onlyList Customers
List the customers of a CloudCart store, filtered by any column such as email. Returns customers with name, email, phone, company, marketing opt-in and dates. Use this to find a customer.
Inputs
filter_emailstring- Exact email address. Example: jane@example.com.
includestring- Related resources to include, comma-separated: orders, shipping-addresses, billing-addresses, group. Example: orders.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
sortstring- Sort field, with a leading - for descending. Allowed: date_added, id. Example: -date_added.
cloudcart_discount_codes_listList the percentage discount codes of a CloudCart store.Read-onlyList Discount Codes
List the percentage discount codes of a CloudCart store. Returns codes with code, value (10000 = 100%) and active flag. Use this to review codes.
Inputs
filter_codestring- Exact code. Example: SPRING20.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
cloudcart_discount_getGet one CloudCart discount campaign.Read-onlyGet Discount
Get one CloudCart discount campaign. Returns the discount's type, value, target, dates, code, limits and uses. Use this for a discount's details.
Inputs
idstringrequired- ID of the discount, from cloudcart_discounts_list. Example: 1042.
cloudcart_discounts_listList the discount campaigns of a CloudCart store.Read-onlyList Discounts
List the discount campaigns of a CloudCart store. Returns discounts with name, type, value, target, dates, code and uses. Use this to review promotions.
Inputs
filter_activestring- yes for active discounts only. Example: yes.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
cloudcart_order_fulfillments_listList CloudCart order fulfillments (shipments with tracking), optionally for one order.Read-onlyList Order Fulfillments
List CloudCart order fulfillments (shipments with tracking), optionally for one order. Returns fulfillments with tracking number, URL, company and dates. Use this to check what has shipped.
Inputs
filter_order_idstring- Only fulfillments of this order ID. Example: 5012.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
cloudcart_order_getGet one CloudCart order.Read-onlyGet Order
Get one CloudCart order. Returns the order with status, customer, invoice and shipping data; include adds line items, payment, totals and addresses. Use this for an order's details.
Inputs
idstringrequired- ID of the order, from cloudcart_orders_list. Example: 1042.
includestring- Related resources to include, comma-separated: products, payment, totals, shipping, shipping-address, billing-address, discounts, taxes. Example: products.
cloudcart_order_payments_listList CloudCart order payment records, usually for one order.Read-onlyList Order Payments
List CloudCart order payment records, usually for one order. Returns payments with provider, status, amount and transaction details. Order sub-resources are read-only; filter them by order with filter_order_id.
Inputs
filter_order_idstring- Only the payment of this order ID. Example: 5012.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
cloudcart_order_products_listList CloudCart order line items, usually for one order.Read-onlyList Order Line Items
List CloudCart order line items, usually for one order. Returns line items with product, variant, SKU, quantity and prices. Order sub-resources are read-only; filter them by order with filter_order_id.
Inputs
filter_order_idstring- Only line items of this order ID. Example: 5012.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
cloudcart_order_return_getGet one CloudCart order return.Read-onlyGet Order Return
Get one CloudCart order return. Returns the return's lines, totals, refund details, status and history. Use this for a return's details.
Inputs
idstringrequired- ID of the return, from cloudcart_order_returns_list. Example: 1042.
cloudcart_order_returns_listList CloudCart order returns, optionally by status or order.Read-onlyList Order Returns
List CloudCart order returns, optionally by status or order. Returns returns with type, status, refund method and amount, and dates. Use this to track returns and refunds.
Inputs
filter_order_idstring- Only returns of this order ID. Example: 5012.
filter_statusstring- pending, returned or cancelled. Example: pending.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
cloudcart_order_shipping_addresses_listList CloudCart order shipping addresses, usually for one order.Read-onlyList Order Shipping Addresses
List CloudCart order shipping addresses, usually for one order. Returns the delivery address with name, phone, street, city, postcode and country. Order sub-resources are read-only; filter them by order with filter_order_id.
Inputs
filter_order_idstring- Only the address of this order ID. Example: 5012.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
cloudcart_order_shipping_listList CloudCart order shipping records, usually for one order.Read-onlyList Order Shipping
List CloudCart order shipping records, usually for one order. Returns the shipping provider, method and price. Order sub-resources are read-only; filter them by order with filter_order_id.
Inputs
filter_order_idstring- Only the shipping of this order ID. Example: 5012.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
cloudcart_order_statuses_listList the order statuses configured in the CloudCart store.Read-onlyList Order Statuses
List the order statuses configured in the CloudCart store. Returns statuses with ID and name. Use this to get valid status IDs; they differ per store.
Inputs
This tool takes no inputs.
cloudcart_orders_listList the orders of a CloudCart store, filtered by status, customer or date range, with sorting and related data.Read-onlyList Orders
List the orders of a CloudCart store, filtered by status, customer or date range, with sorting and related data. Returns orders with status, fulfillment status, customer details, currency, invoice data and dates. Use this to find orders. Use include=products,totals for line items and totals.
Inputs
filter_customer_idstring- Only orders of this customer ID. Example: 1201.
filter_end_datestring- Orders placed on or before this date, YYYY-MM-DD. Example: 2026-11-30.
filter_start_datestring- Orders placed on or after this date, YYYY-MM-DD. Example: 2026-11-01.
filter_statusstring- Order status ID, from cloudcart_order_statuses_list. Example: 5.
filter_status_fulfillmentstring- unfulfilled, partial or fulfilled. Example: unfulfilled.
includestring- Related resources to include, comma-separated: products, payment, totals, shipping, shipping-address, billing-address, discounts, taxes. Example: products.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
sortstring- Sort field, with a leading - for descending. Allowed: date_added, id. Example: -date_added.
cloudcart_payment_providers_listList the payment providers configured in the CloudCart store.Read-onlyList Payment Providers
List the payment providers configured in the CloudCart store. Returns providers with key, name and status. Use this to see how customers can pay.
Inputs
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
cloudcart_posts_listList the blog posts of a CloudCart store.Read-onlyList Blog Posts
List the blog posts of a CloudCart store. Returns posts with title, slug, content summary, blog and dates. Use this to review store content.
Inputs
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
cloudcart_product_getGet one CloudCart product.Read-onlyGet Product
Get one CloudCart product. Returns the product with name, description, flags, price range and relationships; include=variants adds SKUs, prices and stock. Use this for a product's details.
Inputs
idstringrequired- ID of the product, from cloudcart_products_list. Example: 1042.
includestring- Related resources to include, comma-separated: variants, images, variants.images, property-options, product-to-discount. Example: variants.
cloudcart_products_listList the products of a CloudCart store, with filtering by any column, SKU or barcode, sorting and related data.Read-onlyList Products
List the products of a CloudCart store, with filtering by any column, SKU or barcode, sorting and related data. Returns products with name, flags, price range and relationship IDs, plus meta.total_count and paging links. Use this to find products. Use include=variants for SKUs, prices and stock.
Inputs
filter_activestring- yes for published products only, no for unpublished. Example: yes.
filter_barcodestring- Only the product that has a variant with this barcode. Example: 5901234123457.
filter_skustring- Only the product that has a variant with this SKU. Example: CWS-TEE-S.
filter_url_handlestring- Look up a product by URL slug. Example: organic-cotton-hoodie.
includestring- Related resources to include, comma-separated: variants, images, variants.images, property-options. Example: variants.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
sortstring- Sort field, with a leading - for descending. Allowed: date_added, name, date_modified, sort_order, views, id. Example: -date_added.
cloudcart_redirects_listList the URL redirects of a CloudCart store.Read-onlyList Redirects
List the URL redirects of a CloudCart store. Returns redirects with old URL, new URL and type. Use this to review redirects.
Inputs
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
cloudcart_segments_listList the customer segments (regular and automated) of a CloudCart store.Read-onlyList Segments
List the customer segments (regular and automated) of a CloudCart store. Returns segments with name and type. Use this to see audience segments.
Inputs
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
cloudcart_shipping_providers_listList the shipping providers configured in the CloudCart store.Read-onlyList Shipping Providers
List the shipping providers configured in the CloudCart store. Returns providers with key, name and status. Use this to see available carriers.
Inputs
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
cloudcart_subscribers_listList the newsletter subscribers of a CloudCart store.Read-onlyList Subscribers
List the newsletter subscribers of a CloudCart store. Returns subscribers with name, email, phone, country, source and email stats. Use this to read the marketing audience.
Inputs
filter_emailstring- Exact email address. Example: jane@example.com.
includestring- Related resources to include, comma-separated: channels, tags. Example: channels.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
cloudcart_variant_getGet one CloudCart variant.Read-onlyGet Variant
Get one CloudCart variant. Returns the variant's SKU, price in cents, quantity, weight, barcode and option values. Use this for a variant's details.
Inputs
idstringrequired- ID of the variant, from cloudcart_variants_list. Example: 1042.
cloudcart_variants_listList CloudCart product variants (the purchasable items with SKU, price and stock), optionally for one product or SKU.Read-onlyList Variants
List CloudCart product variants (the purchasable items with SKU, price and stock), optionally for one product or SKU. Returns variants with SKU, price in cents, quantity, weight, barcode and option values. Use this to check stock and prices.
Inputs
filter_item_idstring- Only variants of this product ID. Example: 1042.
filter_skustring- Only the variant with this SKU. Example: CWS-TEE-M.
includestring- Related resources to include, comma-separated: product, images. Example: product.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
cloudcart_vendors_listList the vendors (brands) of a CloudCart store.Read-onlyList Vendors
List the vendors (brands) of a CloudCart store. Returns vendors with name, slug, description and image. Use this to find vendor IDs.
Inputs
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page, up to 100. Example: 25.
sortstring- Sort field, with a leading - for descending. Allowed: name, id. Example: -name.
cloudcart_category_createCreate a CloudCart product category, optionally under a parent category.WriteCreate Category
Create a CloudCart product category, optionally under a parent category. Returns the created category with its ID. Use this to organize products.
Inputs
namestringrequired- Category name, at least 2 characters. Example: Hoodies.
descriptionstring- Category description, HTML allowed. Example: Warm hoodies for every season.
image_urlstring- Public URL of a category image; CloudCart downloads and hosts it. Example: https://example.com/img/hoodies.jpg.
meta_descriptionstring- SEO meta description. Example: Shop organic cotton hoodies.
orderinteger- Sort position among sibling categories. Example: 1.
page_titlestring- SEO page title. Example: Hoodies | My Store.
parent_idstring- ID of the parent category; leave empty for a top-level category. Example: 3.
url_handlestring- URL slug; generated from the name if empty. Example: hoodies.
cloudcart_category_updateUpdate a CloudCart category's name, description, slug, image, SEO fields or parent.WriteUpdate Category
Update a CloudCart category's name, description, slug, image, SEO fields or parent. Returns the updated category. Use this to edit or move a category.
- Idempotent
Inputs
idstringrequired- ID of the category, from cloudcart_categories_list. Example: 1042.
descriptionstring- Category description, HTML allowed. Example: Warm hoodies for every season.
image_urlstring- Public URL of a category image; CloudCart downloads and hosts it. Example: https://example.com/img/hoodies.jpg.
meta_descriptionstring- SEO meta description. Example: Shop organic cotton hoodies.
namestring- Category name, at least 2 characters. Example: Hoodies.
orderinteger- Sort position among sibling categories. Example: 1.
page_titlestring- SEO page title. Example: Hoodies | My Store.
parent_idstring- ID of the parent category; leave empty for a top-level category. Example: 3.
url_handlestring- URL slug; generated from the name if empty. Example: hoodies.
cloudcart_customer_createCreate a CloudCart customer account.WriteCreate Customer
Create a CloudCart customer account. Returns the created customer with its ID. Use this to add a customer, optionally into a customer group.
Inputs
emailstringrequired- Email address, unique (required). Example: jane@example.com.
accepts_marketingboolean- True if the customer opted in to marketing emails. Example: true.
companystring- Company name. Example: Acme Ltd.
first_namestring- First name. Example: Jane.
group_idstring- ID of the customer group, from cloudcart_customer_groups_list. Example: 2.
last_namestring- Last name. Example: Doe.
notestring- Internal staff note. Example: Wholesale lead.
phonestring- Phone number. Example: +359888123456.
cloudcart_customer_group_createCreate a CloudCart customer group with an optional discount for all its members.WriteCreate Customer Group
Create a CloudCart customer group with an optional discount for all its members. Returns the created group with its ID. Use this for wholesale or VIP pricing tiers.
Inputs
namestringrequired- Group name, unique. Example: Wholesale.
discount_percentstring- Discount for all members as a decimal string. Example: 10.00.
cloudcart_customer_updateUpdate a CloudCart customer's name, email, phone, company, marketing opt-in, note or group.WriteUpdate Customer
Update a CloudCart customer's name, email, phone, company, marketing opt-in, note or group. Returns the updated customer. Use this to edit a customer or move them to another group.
- Idempotent
Inputs
idstringrequired- ID of the customer, from cloudcart_customers_list. Example: 1042.
accepts_marketingboolean- True if the customer opted in to marketing emails. Example: true.
companystring- Company name. Example: Acme Ltd.
emailstring- Email address, unique. Example: jane@example.com.
first_namestring- First name. Example: Jane.
group_idstring- ID of the customer group, from cloudcart_customer_groups_list. Example: 2.
last_namestring- Last name. Example: Doe.
notestring- Internal staff note. Example: Wholesale lead.
phonestring- Phone number. Example: +359888123456.
cloudcart_discount_code_createCreate a CloudCart percentage discount code customers enter at checkout.WriteCreate Discount Code
Create a CloudCart percentage discount code customers enter at checkout. Returns the created code. Use this for a single code. Use cloudcart_discount_codes_generate for many unique codes.
Inputs
activeintegerrequired- 1 active or 0 disabled. Example: 1.one of
01 codestringrequired- Code, letters and digits only, up to 20 characters, unique. Example: SPRING20.
valueintegerrequired- Percentage in hundredths, 1 to 10000 (2000 = 20%). Example: 2000.
cloudcart_discount_codes_generateGenerate up to 1,000 unique random CloudCart percentage discount codes at once.WriteGenerate Discount Codes
Generate up to 1,000 unique random CloudCart percentage discount codes at once. Returns the generated codes. Use this for gift cards or one-time promo codes.
Inputs
countintegerrequired- Number of codes to generate, 1 to 1000. Example: 50.
valueintegerrequired- Percentage in hundredths for all codes, 1 to 10000 (1000 = 10%). Example: 1000.
cloudcart_discount_createCreate a CloudCart discount campaign: fixed prices, a percentage, a flat amount or free shipping, for all products, categories, vendors, products or orders over an amount.WriteCreate Discount
Create a CloudCart discount campaign: fixed prices, a percentage, a flat amount or free shipping, for all products, categories, vendors, products or orders over an amount. Returns the created discount with its ID. Use this for sales and promotions. Use cloudcart_discount_code_create for a simple percentage code.
Inputs
date_startstringrequired- Start date, YYYY-MM-DD. Example: 2026-11-27.
discount_typestringrequired- fixed, percent, flat, shipping or code-pro. Example: percent.one of
fixedpercentflatshippingcode-pro namestringrequired- Discount name, 2 to 191 characters. Example: Black Friday 20%.
activestring- yes or no. Example: yes.one of
yesno codestring- Discount code customers enter, letters and digits, up to 20 characters; not allowed with fixed. Example: BF2026.
date_endstring- End date, YYYY-MM-DD; empty for no end. Example: 2026-11-30.
max_usesinteger- Maximum number of uses. Example: 500.
order_overinteger- Minimum order amount in cents, with target type order_over. Example: 5000.
targetobject- What the discount applies to: an object with type (all, product, category, vendor, category_vendor or order_over) and the matching products, categories or vendors ID arrays. Required for percent, flat and shipping. Example: {"type": "category", "categories": [10]}
type_valueinteger- Value: for percent in hundredths of a percent (2000 = 20%), for flat in cents. Required for percent and flat. Example: 2000.
cloudcart_order_fulfillMark a CloudCart order as fulfilled, which runs the store's fulfillment workflows and notifications.WriteFulfill Order
Mark a CloudCart order as fulfilled, which runs the store's fulfillment workflows and notifications. Returns the updated order. Use this when the whole order has shipped. Use cloudcart_order_fulfillment_create to record tracking details.
- Idempotent
Inputs
idstringrequired- ID of the order, from cloudcart_orders_list. Example: 1042.
cloudcart_order_fulfillment_createRecord a shipment for a CloudCart order with its tracking number, link, carrier and dates.WriteCreate Order Fulfillment
Record a shipment for a CloudCart order with its tracking number, link, carrier and dates. Returns the created fulfillment. Use this when an order ships. Use cloudcart_order_update to change its status too.
Inputs
order_idstringrequired- ID of the order that shipped. Example: 5012.
shipping_tracking_numberstringrequired- Tracking number. Example: ECN-BG-1234567890.
shipping_date_deliverystring- Expected delivery date, YYYY-MM-DD. Example: 2026-11-19.
shipping_date_expeditionstring- Dispatch date, YYYY-MM-DD. Example: 2026-11-17.
shipping_tracking_companystring- Carrier name. Example: Econt.
shipping_tracking_urlstring- Tracking page URL. Example: https://www.econt.com/services/track-shipment?id=1234567890.
cloudcart_order_return_createRecord a full or partial return for a CloudCart order.WriteCreate Order Return
Record a full or partial return for a CloudCart order. Returns the created return with status pending. Use this when a customer sends goods back; give line_selections for a partial return.
Inputs
order_idstringrequired- ID of the order the return comes from. Example: 5012.
line_selectionsobject- Lines to return as an object of order line item ID to quantity, from cloudcart_order_products_list. Example: {"88001": 1}
reasonstring- Reason for the return. Example: Wrong size.
refund_methodstring- How the money goes back: card, bank, wallet, voucher or none. Example: card.one of
cardbankwalletvouchernone return_typestring- full or partial; defaults to partial when line_selections is given. Example: partial.one of
fullpartial
cloudcart_order_updateUpdate a CloudCart order's status, internal note, invoice number (write-once) or shipping dates.WriteUpdate Order
Update a CloudCart order's status, internal note, invoice number (write-once) or shipping dates. Returns the updated order. Use this to move an order to another status. Use cloudcart_order_statuses_list for status IDs.
- Idempotent
Inputs
idstringrequired- ID of the order, from cloudcart_orders_list. Example: 1042.
invoice_numberstring- Invoice number; can be set only once and must be unique. Example: INV-2026-0042.
notestring- Internal staff note, not shown to the customer. Example: Packed by Maria.
shipping_datestring- Actual shipping date, YYYY-MM-DD HH:MM:SS. Example: 2026-11-17 10:00:00.
statusstring- New order status ID, from cloudcart_order_statuses_list; transitions are validated. Example: 5.
cloudcart_product_createCreate a CloudCart product in a category; prices, SKUs and stock live on variants.WriteCreate Product
Create a CloudCart product in a category; prices, SKUs and stock live on variants. Returns the created product with its ID. Use this, then cloudcart_variant_create to add at least one purchasable variant with a price.
Inputs
category_idstringrequired- ID of the product's primary category, from cloudcart_categories_list (required on create). Example: 10.
namestringrequired- Product title, at least 2 characters. Example: Organic Cotton Hoodie.
activestring- yes publishes the product in the storefront. Example: yes.one of
yesno continue_sellingstring- yes allows orders when out of stock. Example: no.one of
yesno descriptionstring- Full description, HTML allowed. Example: <p>Soft organic cotton hoodie.</p>.
digitalstring- yes for a digital product that skips shipping. Example: no.one of
yesno draftstring- yes keeps the product as a draft. Example: no.one of
yesno newstring- yes shows the new badge. Example: yes.one of
yesno salestring- yes shows the sale badge. Example: no.one of
yesno shippingstring- yes if the product needs shipping. Example: yes.one of
yesno sort_orderinteger- Position in category listings; lower comes first. Example: 10.
trackingstring- yes turns on inventory tracking. Example: yes.one of
yesno url_handlestring- URL slug (letters, digits, dashes, underscores); generated from the name if empty. Example: organic-cotton-hoodie.
vendor_idstring- ID of the product's vendor (brand), from cloudcart_vendors_list. Example: 7.
cloudcart_product_updateUpdate a CloudCart product's name, description, flags (active, draft, sale, new), category or vendor.WriteUpdate Product
Update a CloudCart product's name, description, flags (active, draft, sale, new), category or vendor. Returns the updated product. Use this to publish, hide or edit a product. Use cloudcart_variant_update to change price or stock.
- Idempotent
Inputs
idstringrequired- ID of the product, from cloudcart_products_list. Example: 1042.
activestring- yes publishes the product in the storefront. Example: yes.one of
yesno category_idstring- ID of the product's primary category, from cloudcart_categories_list. Example: 10.
continue_sellingstring- yes allows orders when out of stock. Example: no.one of
yesno descriptionstring- Full description, HTML allowed. Example: <p>Soft organic cotton hoodie.</p>.
digitalstring- yes for a digital product that skips shipping. Example: no.one of
yesno draftstring- yes keeps the product as a draft. Example: no.one of
yesno namestring- Product title, at least 2 characters. Example: Organic Cotton Hoodie.
newstring- yes shows the new badge. Example: yes.one of
yesno salestring- yes shows the sale badge. Example: no.one of
yesno shippingstring- yes if the product needs shipping. Example: yes.one of
yesno sort_orderinteger- Position in category listings; lower comes first. Example: 10.
trackingstring- yes turns on inventory tracking. Example: yes.one of
yesno url_handlestring- URL slug (letters, digits, dashes, underscores); generated from the name if empty. Example: organic-cotton-hoodie.
vendor_idstring- ID of the product's vendor (brand), from cloudcart_vendors_list. Example: 7.
cloudcart_redirect_createCreate a CloudCart URL redirect from an old path to a new URL.WriteCreate Redirect
Create a CloudCart URL redirect from an old path to a new URL. Returns the created redirect. Use this after renaming or removing pages.
Inputs
new_urlstringrequired- Path or full URL to redirect to. Example: /category/hoodies.
old_urlstringrequired- Old path to redirect from, unique. Example: /old-hoodies.
redirect_typestringrequired- Target type: manual (new_url is a path) or external (new_url is a full URL). Example: manual.one of
manualexternal
cloudcart_subscriber_createAdd a newsletter subscriber to a CloudCart store.WriteCreate Subscriber
Add a newsletter subscriber to a CloudCart store. Returns the created subscriber with its ID. Use this to sign someone up for marketing.
Inputs
countrystringrequired- Country code or name. Example: BG.
emailstring- Email address. Example: jane@example.com.
first_namestring- First name. Example: Jane.
last_namestring- Last name. Example: Doe.
phonestring- Phone number. Example: +359888123456.
subscribed_fromstring- Source of the subscription; API if empty. Example: Website popup.
cloudcart_variant_createCreate a variant (a purchasable SKU with price and stock) for a CloudCart product.WriteCreate Variant
Create a variant (a purchasable SKU with price and stock) for a CloudCart product. Returns the created variant with its ID. Use this after cloudcart_product_create; a product with variant parameters needs option values on each variant.
Inputs
product_idstringrequired- ID of the parent product (required on create). Example: 1042.
barcodestring- Barcode (EAN, UPC, ISBN). Example: 5901234123457.
delivery_priceinteger- Delivery surcharge in cents. Example: 0.
option1_idstring- ID of the first variant option value (such as size M), from the product's variant parameters. Example: 301.
priceinteger- Price in cents, such as 2999 for 29.99. Example: 2999.
quantitynumber- Available stock. Example: 70.
skustring- Stock keeping unit. Example: CWS-TEE-M.
weightinteger- Weight in grams. Example: 250.
cloudcart_variant_updateUpdate a CloudCart variant's SKU, price, stock, weight or barcode.WriteUpdate Variant
Update a CloudCart variant's SKU, price, stock, weight or barcode. Returns the updated variant. Use this to change prices or stock levels.
- Idempotent
Inputs
idstringrequired- ID of the variant, from cloudcart_variants_list. Example: 1042.
barcodestring- Barcode (EAN, UPC, ISBN). Example: 5901234123457.
delivery_priceinteger- Delivery surcharge in cents. Example: 0.
option1_idstring- ID of the first variant option value (such as size M), from the product's variant parameters. Example: 301.
priceinteger- Price in cents, such as 2999 for 29.99. Example: 2999.
quantitynumber- Available stock. Example: 70.
skustring- Stock keeping unit. Example: CWS-TEE-M.
weightinteger- Weight in grams. Example: 250.
cloudcart_vendor_createCreate a CloudCart vendor (brand).WriteCreate Vendor
Create a CloudCart vendor (brand). Returns the created vendor with its ID. Use this before linking products to a brand.
Inputs
namestringrequired- Vendor or brand name, at least 2 characters. Example: Patagonia.
descriptionstring- Vendor description, HTML allowed. Example: Outdoor clothing brand.
image_urlstring- Public URL of the vendor logo; CloudCart downloads and hosts it. Example: https://example.com/img/brand.png.
cloudcart_category_deleteDelete a CloudCart category.DestructiveDelete Category
Delete a CloudCart category. Returns an empty success response. Use this to remove an empty category.
- Idempotent
Inputs
idstringrequired- ID of the category, from cloudcart_categories_list. Example: 1042.
cloudcart_customer_deleteDelete a CloudCart customer account.DestructiveDelete Customer
Delete a CloudCart customer account. Returns an empty success response. Use this to remove a customer for good.
- Idempotent
Inputs
idstringrequired- ID of the customer, from cloudcart_customers_list. Example: 1042.
cloudcart_discount_code_deleteDelete a CloudCart discount code.DestructiveDelete Discount Code
Delete a CloudCart discount code. Returns an empty success response. Use this to retire a code.
- Idempotent
Inputs
idstringrequired- ID of the discount code, from cloudcart_discount_codes_list. Example: 1042.
cloudcart_discount_deleteDelete a CloudCart discount campaign.DestructiveDelete Discount
Delete a CloudCart discount campaign. Returns an empty success response. Use this to end and remove a promotion.
- Idempotent
Inputs
idstringrequired- ID of the discount, from cloudcart_discounts_list. Example: 1042.
cloudcart_product_deleteDelete a CloudCart product and its variants.DestructiveDelete Product
Delete a CloudCart product and its variants. Returns an empty success response. Use this to remove a product for good. Use cloudcart_product_update with active no to hide it instead.
- Idempotent
Inputs
idstringrequired- ID of the product, from cloudcart_products_list. Example: 1042.
cloudcart_redirect_deleteDelete a CloudCart URL redirect.DestructiveDelete Redirect
Delete a CloudCart URL redirect. Returns an empty success response. Use this to remove a redirect.
- Idempotent
Inputs
idstringrequired- ID of the redirect, from cloudcart_redirects_list. Example: 1042.
cloudcart_subscriber_deleteDelete a CloudCart newsletter subscriber.DestructiveDelete Subscriber
Delete a CloudCart newsletter subscriber. Returns an empty success response. Use this to remove someone from marketing.
- Idempotent
Inputs
idstringrequired- ID of the subscriber, from cloudcart_subscribers_list. Example: 1042.
cloudcart_variant_deleteDelete a CloudCart variant.DestructiveDelete Variant
Delete a CloudCart variant. Returns an empty success response. Use this to remove a size or color that is no longer sold.
- Idempotent
Inputs
idstringrequired- ID of the variant, from cloudcart_variants_list. Example: 1042.
cloudcart_vendor_deleteDelete a CloudCart vendor.DestructiveDelete Vendor
Delete a CloudCart vendor. Returns an empty success response. Use this to remove a brand.
- Idempotent
Inputs
idstringrequired- ID of the vendor, from cloudcart_vendors_list. Example: 1042.
No tools match.