Cloudcart
cloudcartCloudCart is an e-commerce platform that enables businesses to create and manage online stores efficiently.
Acciones disponibles (34)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add to CartCLOUDCART_ADD_TO_CARTAcciónTool to add an item to the cart. use after confirming a product selection with desired quantity.
CLOUDCART_ADD_TO_CARTAcciónTool to add an item to the cart. use after confirming a product selection with desired quantity.
Parámetros de entrada
quantityintegerObligatorioThe number of units of the product to add, must be at least 1.
product_idintegerObligatorioThe unique identifier of the product to be added to the cart.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Clear CartCLOUDCART_CLEAR_CARTAcciónTool to remove all items from the specified cart. use when you need to empty the cart before adding new items or starting over.
CLOUDCART_CLEAR_CARTAcciónTool to remove all items from the specified cart. use when you need to empty the cart before adding new items or starting over.
Parámetros de entrada
cart_idstringObligatorioThe unique identifier of the cart to clear.
Parámetros de salida
dataobjectContains the cart details after clearing.
errorstringError if any occurred during the execution of the action
messagestringAdditional information about the result.
successbooleanObligatorioIndicates if the cart was cleared successfully.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create CategoryCLOUDCART_CREATE_CATEGORYAcciónTool to create a new category. use when you need to add organizational structure to your product catalog.
CLOUDCART_CREATE_CATEGORYAcciónTool to create a new category. use when you need to add organizational structure to your product catalog.
Parámetros de entrada
imagestringAbsolute URL to a category image
titlestringObligatorioTitle of the category
positionintegerSorting position of the category (0 = first)
parent_idintegerID of the parent category to nest under; omit for top-level
meta_titlestringSEO meta title
descriptionstringDetailed description of the category
meta_keywordsstringComma-separated SEO keywords
meta_descriptionstringSEO meta description
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create CustomerCLOUDCART_CREATE_CUSTOMERAcciónTool to create a new customer in cloudcart. use when you need to register a new customer profile. provide validated customer details (name, email, and password).
CLOUDCART_CREATE_CUSTOMERAcciónTool to create a new customer in cloudcart. use when you need to register a new customer profile. provide validated customer details (name, email, and password).
Parámetros de entrada
namestringObligatorioFull name of the customer.
emailstringObligatorioemailCustomer's email address.
phonestringPhone number of the customer. Optional.
addressstringPhysical address of the customer. Optional.
passwordstringObligatorioPassword for the customer's account. Must be at least 8 characters.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create OrderCLOUDCART_CREATE_ORDERAcciónTool to create a new order. use after assembling customer id, cart items, and optional addresses/payment info.
CLOUDCART_CREATE_ORDERAcciónTool to create a new order. use after assembling customer id, cart items, and optional addresses/payment info.
Parámetros de entrada
itemsobject[]ObligatorioList of line items for the order
currencyanyISO 4217 currency code
customer_idintegerObligatorioID of the customer placing the order
payment_methodstringenumPayment method code; if omitted, default store method applies
credit_cardpaypalbank_transferbilling_addressobjectBilling address; if omitted, same as shipping_address
shipping_addressobjectShipping address; if omitted, uses customer's default address
Parámetros de salida
dataobjectObligatorioCreated order resource object
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ProductCLOUDCART_CREATE_PRODUCTAcciónTool to create a new product. use when you have all details and want to add it to cloudcart.
CLOUDCART_CREATE_PRODUCTAcciónTool to create a new product. use when you have all details and want to add it to cloudcart.
Parámetros de entrada
skustringStock keeping unit identifier.
namestringObligatorioName of the product.
tagsstring[]List of tags.
pricenumberObligatorioPrice of the product; must be non-negative.
imagesstring[]List of image URLs.
statusstringStatus of the product (e.g., active, draft).
vendorstringID of the vendor to associate.
weightnumberWeight in kilograms; must be non-negative.
barcodestringBarcode (e.g., UPC/EAN).
quantityintegerAvailable quantity; must be non-negative.
categoriesinteger[]List of category IDs to associate.
descriptionstringDescription of the product (HTML allowed).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create VariantCLOUDCART_CREATE_VARIANTAcciónTool to create a new product variant for a given product. use when you need to add a variant with specific sku, price, and options.
CLOUDCART_CREATE_VARIANTAcciónTool to create a new product variant for a given product. use when you need to add a variant with specific sku, price, and options.
Parámetros de entrada
skustringObligatorioSKU of the new variant
pricenumberObligatorioPrice of the variant
weightnumberWeight of the variant
quantityintegerStock quantity for the variant
productIdstringObligatorioID of the product to which the variant belongs
option_valuesobject[]List of option values objects, each with product_option_id and value_id
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Variant OptionCLOUDCART_CREATE_VARIANT_OPTIONAcciónTool 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.
CLOUDCART_CREATE_VARIANT_OPTIONAcciónTool 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.
Parámetros de entrada
namestringObligatorioName of the variant option
pricenumberPrice difference for this option
positionintegerThe order of the option among siblings
is_defaultbooleanWhether this is the default option
product_idintegerObligatorioID of the product to which the variant belongs
variant_idintegerObligatorioID of the variant for which to create an option
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Variant ParameterCLOUDCART_CREATE_VARIANT_PARAMETERAcciónTool 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.
CLOUDCART_CREATE_VARIANT_PARAMETERAcciónTool 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.
Parámetros de entrada
namestringObligatorioName of the parameter (e.g., 'color', 'size').
typestringenumType of the parameter. One of 'text', 'number', 'boolean', or 'date'.
textnumberbooleandatevaluestringObligatorioValue of the parameter (e.g., 'red', 'XL').
productIdstringObligatorioThe ID of the product.
variantIdstringObligatorioThe ID of the product variant.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create VendorCLOUDCART_CREATE_VENDORAcciónTool to create a new vendor via cloudcart api. use when adding a new brand or partner entity to your store.
CLOUDCART_CREATE_VENDORAcciónTool to create a new vendor via cloudcart api. use when adding a new brand or partner entity to your store.
Parámetros de entrada
dataobjectObligatorioData wrapper for create vendor request
Parámetros de salida
dataobjectObligatorioData wrapper for create vendor response
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete CategoryCLOUDCART_DELETE_CATEGORYAcciónTool to delete a category by its id. use after confirming the correct id to permanently remove it.
CLOUDCART_DELETE_CATEGORYAcciónTool to delete a category by its id. use after confirming the correct id to permanently remove it.
Parámetros de entrada
idstringObligatorioUnique identifier of the category to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete CustomerCLOUDCART_DELETE_CUSTOMERAcciónTool to delete a customer. use when you need to remove a customer by their id. example: "delete customer with id 123".
CLOUDCART_DELETE_CUSTOMERAcciónTool to delete a customer. use when you need to remove a customer by their id. example: "delete customer with id 123".
Parámetros de entrada
customer_idintegerObligatorioID of the customer to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete OrderCLOUDCART_DELETE_ORDERAcciónTool to delete an order. use after confirming the order exists.
CLOUDCART_DELETE_ORDERAcciónTool to delete an order. use after confirming the order exists.
Parámetros de entrada
order_idstringObligatorioThe unique identifier of the order to be deleted
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ProductCLOUDCART_DELETE_PRODUCTAcciónTool to delete a product by its id. use after confirming the product exists to permanently remove it from the catalog.
CLOUDCART_DELETE_PRODUCTAcciónTool to delete a product by its id. use after confirming the product exists to permanently remove it from the catalog.
Parámetros de entrada
product_idstringObligatorioThe unique identifier of the product to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete VendorCLOUDCART_DELETE_VENDORAcciónTool to delete a vendor by its id. use when removing an obsolete vendor from the store.
CLOUDCART_DELETE_VENDORAcciónTool to delete a vendor by its id. use when removing an obsolete vendor from the store.
Parámetros de entrada
vendor_idstringObligatorioUnique identifier of the vendor to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get CartCLOUDCART_GET_CARTAcciónTool to retrieve the current shopping cart. use when you need to view or verify the cart contents before checkout.
CLOUDCART_GET_CARTAcciónTool to retrieve the current shopping cart. use when you need to view or verify the cart contents before checkout.
Parámetros de entrada
cart_idstringThe unique identifier of the cart. If not provided, retrieves the current session cart.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get CategoriesCLOUDCART_GET_CATEGORIESAcciónTool to retrieve a list of all categories. use when you need to list available categories for selection.
CLOUDCART_GET_CATEGORIESAcciónTool to retrieve a list of all categories. use when you need to list available categories for selection.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get CustomersCLOUDCART_GET_CUSTOMERSAcciónTool 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.
CLOUDCART_GET_CUSTOMERSAcciónTool 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.
Parámetros de entrada
sortstringSort order, prefix field with '-' for descending
page[size]integerNumber of items per page for pagination
filter[name]stringFilter customers by full name
page[number]integerPage number for pagination, starting from 1
filter[email]stringemailFilter customers by email address
Parámetros de salida
dataobject[]ObligatorioList of customer resources
metaobjectObligatorioMetadata including pagination info
errorstringError if any occurred during the execution of the action
linksobjectPagination links
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get OrdersCLOUDCART_GET_ORDERSAcciónTool to retrieve a list of all orders. use when you need to collect orders for processing. returns json api order resources including id, type, and attributes. ensure authentication before calling.
CLOUDCART_GET_ORDERSAcciónTool to retrieve a list of all orders. use when you need to collect orders for processing. returns json api order resources including id, type, and attributes. ensure authentication before calling.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobject[]ObligatorioList of order resource objects
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Payment MethodsCLOUDCART_GET_PAYMENT_METHODSAcciónTool to retrieve all available payment methods. use when you need to list supported payment options before checkout.
CLOUDCART_GET_PAYMENT_METHODSAcciónTool to retrieve all available payment methods. use when you need to list supported payment options before checkout.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ProductsCLOUDCART_GET_PRODUCTSAcciónTool 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).
CLOUDCART_GET_PRODUCTSAcciónTool 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).
Parámetros de entrada
pageintegerPage number of results to fetch (1-based).
limitintegerNumber of products to return per page.
searchstringText to search for in product names and descriptions.
brand_idintegerFilter products by brand ID.
max_pricenumberMaximum price filter (inclusive).
min_pricenumberMinimum price filter (inclusive).
category_idintegerFilter products by category ID.
with_hiddenbooleanInclude hidden products when true.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Product With RelationsCLOUDCART_GET_PRODUCT_WITH_RELATIONSAcciónTool to retrieve a product with related entities. use when detailed product information is needed after obtaining its id.
CLOUDCART_GET_PRODUCT_WITH_RELATIONSAcciónTool to retrieve a product with related entities. use when detailed product information is needed after obtaining its id.
Parámetros de entrada
product_idstringObligatorioUnique identifier of the product to retrieve.
Parámetros de salida
dataobjectObligatorioProduct resource object including related entities.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Property Options RelationshipCLOUDCART_GET_PROPERTY_OPTIONS_RELATIONSHIPAcciónTool 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.
CLOUDCART_GET_PROPERTY_OPTIONS_RELATIONSHIPAcciónTool 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.
Parámetros de entrada
product_idintegerObligatorioID of the product whose property options relationships to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Shipping MethodsCLOUDCART_GET_SHIPPING_METHODSAcciónTool to retrieve all available shipping methods. use when you need to list shipping options before checkout.
CLOUDCART_GET_SHIPPING_METHODSAcciónTool to retrieve all available shipping methods. use when you need to list shipping options before checkout.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get VendorCLOUDCART_GET_VENDORAcciónTool to retrieve details of a specific vendor. use when you have the vendor id.
CLOUDCART_GET_VENDORAcciónTool to retrieve details of a specific vendor. use when you have the vendor id.
Parámetros de entrada
vendor_idstringObligatorioUnique identifier of the vendor to retrieve
Parámetros de salida
dataobjectObligatorioEnvelope object for a vendor resource.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Order PaymentCLOUDCART_LIST_ORDER_PAYMENTAcciónTool to retrieve a list of order payments. use when you need to view payments for orders, optionally filtered by order id or status. useful after creating or updating orders to inspect their payment history.
CLOUDCART_LIST_ORDER_PAYMENTAcciónTool to retrieve a list of order payments. use when you need to view payments for orders, optionally filtered by order id or status. useful after creating or updating orders to inspect their payment history.
Parámetros de entrada
pageintegerPage number for pagination (1-based).
limitintegerMaximum number of results per page.
statusstringFilter payments by status, e.g., 'paid', 'pending', 'failed'.
order_idintegerFilter payments by a specific order's ID.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List VendorsCLOUDCART_LIST_VENDORSAcciónTool 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."
CLOUDCART_LIST_VENDORSAcciónTool 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."
Parámetros de entrada
pageintegerPage number for pagination (1-based).
limitintegerNumber of records per page.
searchstringFilter vendors by name or other searchable fields.
statusstringFilter vendors by status.
Parámetros de salida
dataobject[]ObligatorioList of vendor objects.
pageintegerObligatorioCurrent page number.
errorstringError if any occurred during the execution of the action
limitintegerObligatorioNumber of records per page.
totalintegerObligatorioTotal number of vendor records.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove from CartCLOUDCART_REMOVE_FROM_CARTAcciónTool to remove an item from the cart. use after confirming the product exists in the cart to delete it.
CLOUDCART_REMOVE_FROM_CARTAcciónTool to remove an item from the cart. use after confirming the product exists in the cart to delete it.
Parámetros de entrada
product_idintegerObligatorioThe unique identifier of the product to be removed from the cart.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Cart ItemCLOUDCART_UPDATE_CART_ITEMAcciónTool to update the quantity of an item in the cart. use when you need to adjust item quantities in the cart before checkout.
CLOUDCART_UPDATE_CART_ITEMAcciónTool to update the quantity of an item in the cart. use when you need to adjust item quantities in the cart before checkout.
Parámetros de entrada
quantityintegerObligatorioThe new quantity for the product in the cart; must be at least 1.
product_idintegerObligatorioThe unique identifier of the product to update in the cart.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update CategoryCLOUDCART_UPDATE_CATEGORYAcciónTool to update an existing category. use when you need to modify category details after reviewing its current values.
CLOUDCART_UPDATE_CATEGORYAcciónTool to update an existing category. use when you need to modify category details after reviewing its current values.
Parámetros de entrada
idstringObligatorioUnique identifier of the category to update
imagestringAbsolute URL to the category image
titlestringTitle of the category
positionintegerSorting position of the category (0 = first)
parent_idintegerID of the parent category; omit or null for top-level
meta_titlestringSEO meta title
descriptionstringDetailed description of the category
meta_keywordsstringSEO meta keywords, comma-separated
meta_descriptionstringSEO meta description
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update CustomerCLOUDCART_UPDATE_CUSTOMERAcciónTool to update an existing customer. use when modifying customer details like name, email, or address.
CLOUDCART_UPDATE_CUSTOMERAcciónTool to update an existing customer. use when modifying customer details like name, email, or address.
Parámetros de entrada
namestringFull name of the customer. Optional.
emailstringemailCustomer's email address. Optional.
phonestringPhone number of the customer. Optional.
addressstringPhysical address of the customer. Optional.
passwordstringPassword for the customer's account. Must be at least 8 characters. Optional.
customer_idintegerObligatorioID of the customer to update
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update OrderCLOUDCART_UPDATE_ORDERAcciónTool 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.
CLOUDCART_UPDATE_ORDERAcciónTool 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.
Parámetros de entrada
order_idstringObligatorioUnique identifier of the order to update
attributesobjectObligatorioOrder fields to update
Parámetros de salida
dataobjectObligatorioUpdated order resource object
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ProductCLOUDCART_UPDATE_PRODUCTAcciónTool to update an existing product's details. use when you need to modify product information after confirming the product id.
CLOUDCART_UPDATE_PRODUCTAcciónTool to update an existing product's details. use when you need to modify product information after confirming the product id.
Parámetros de entrada
namestringThe new name of the product.
pricenumberThe new price of the product; must be non-negative.
stockintegerThe new stock quantity; must be non-negative.
imagesstring[]List of URLs for the product images.
product_idstringObligatorioThe unique identifier of the product to update.
category_idstringIdentifier of the category to assign this product to.
descriptionstringA brief description of the product.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update VendorCLOUDCART_UPDATE_VENDORAcciónTool to update an existing vendor. use when vendor details change and need saving. call after confirming the vendor id.
CLOUDCART_UPDATE_VENDORAcciónTool to update an existing vendor. use when vendor details change and need saving. call after confirming the vendor id.
Parámetros de entrada
dataobjectObligatorioData wrapper for update vendor request.
Parámetros de salida
dataobjectObligatorioData wrapper for update vendor response.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not