Built-in operations an agent can run as App Action steps. Each action has typed inputs and outputs.Documentation Index
Fetch the complete documentation index at: https://docs.colossal.sh/llms.txt
Use this file to discover all available pages before exploring further.
Cart
add_to_cart
Add a product to the cart.
Input
Cart UUID
Product UUID to add
Quantity to add min: 1. Default:
1.get_cart
Retrieve cart details by UUID.
Input
Cart UUID
remove_from_cart
Remove an item from the cart.
Input
Cart UUID
Line item ID to remove min: > 0.
update_cart_item
Update the quantity of a cart item.
Input
Cart UUID
Line item ID to update min: > 0.
New quantity min: 1.
Checkout
get_checkout_by_order
Retrieve checkout session for a given order.
Input
Order ID min: > 0.
get_checkout_session
Retrieve checkout session details by UUID.
Input
Checkout session UUID
Customers
create_customer
Create a new customer.
Input
Customer email address
Customer full name
get_customer
Retrieve customer by ID, UUID, or email.
Input
Customer ID
Customer UUID
Customer email
update_customer
Update customer details.
Input
Customer ID to update
New email address
New full name
send_email
Sends an email to a recipient.
Input
minLen: 1, maxLen: 998.
Default:
"".Default:
"".HTTP
http_request
Sends an HTTP request to any URL.
Input
minLen: 1, maxLen: 2083.
min: 1, max: 300. Default:
30.min: 0.
Inventory
check_inventory
Check current inventory level for a product and determine if stock is low.
Input
min: > 0.
min: 0. Default:
10.Invoices
create_invoice
Create a new invoice with line items.
Input
create_invoice_line_item
Append a line item to an existing invoice.
Input
min: 1.
min: 0.
get_invoice
Retrieve invoice details by UID.
Input
Orders
get_order
Retrieve order details by ID.
Input
min: > 0.
get_order_history
Retrieve orders for a specific customer.
Input
min: > 0.
min: 1, max: 100. Default:
50.lookup_order_count
Get the total number of orders placed by a specific customer.
Input
min: > 0.
update_billing_address
Update an order’s billing address.
Input
update_order
Update order fields in a secure workspace-scoped manner.
Input
min: > 0.
Fields to update on the order
update_order_metadata
Update order integration metadata.
Input
min: > 0.
Metadata fields to merge into the order
update_order_status
Update the status of an order.
Input
min: > 0.
New order status
update_shipping_address
Update an order’s shipping address.
Input
Payments
get_invoice_payments
Retrieve all payments for an invoice.
Input
min: > 0.
min: 1, max: 50. Default:
10.get_payment
Retrieve payment details by UID.
Input
Products
archive_deliverable
Archive a product deliverable.
Input
archive_product
Archive a product to hide it from the store.
Input
create_deliverable
Create a new product deliverable in the workspace.
Input
create_price
Create a new price for a product variant.
Input
min: > 0.
Default:
"USD".Default:
false.create_product
Create a new product in the store with optional price and images.
Input
get_product
Retrieve product details by UID.
Input
publish_product
Publish a product to make it visible in the store.
Input
set_default_price
Mark a price as the default for its variant.
Input
unarchive_product
Restore an archived product.
Input
update_deliverable
Update a product deliverable’s name, type, or config.
Input
update_product
Update an existing product’s details.
Input
update_product_price
Update the default price of a product.
Input
min: > 0.