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.
Full catalog of actions provided by the Colossal app (built-in). Third-party apps add their own actions when installed. See Apps.
Cart
| Action | Description |
|---|
get_cart | Retrieve a cart by UID |
add_to_cart | Add a product to a cart |
update_cart_item | Change a line item’s quantity |
remove_from_cart | Remove a line item from a cart |
Checkout
| Action | Description |
|---|
get_checkout_session | Retrieve a checkout session |
get_checkout_by_order | Retrieve checkout session by order ID |
Customer
| Action | Description |
|---|
get_customer | Retrieve a customer by ID |
create_customer | Create a new customer record |
update_customer | Update customer details |
Product
| Action | Description |
|---|
get_product | Retrieve a product by ID |
publish_product | Publish a draft product |
archive_product | Archive a product |
unarchive_product | Restore an archived product |
update_product_price | Update a product’s price |
Orders
| Action | Description |
|---|
get_order | Retrieve an order by ID |
get_customer_orders | Get orders for a specific customer |
update_order_status | Change an order’s status |
update_order_metadata | Update metadata on an order |
lookup_order_count | Count orders matching criteria |
Inventory
| Action | Description |
|---|
check_inventory | Check stock levels for a product variant |
Invoice
| Action | Description |
|---|
get_invoice | Retrieve an invoice |
create_invoice | Create a new invoice |
Email
| Action | Description |
|---|
send_email | Send an email to a recipient |
Payment
| Action | Description |
|---|
get_payment | Retrieve a payment record |
get_invoice_payments | Get all payments for an invoice |
HTTP
| Action | Description |
|---|
http_request | Send an HTTP request to any URL |
Using actions in agents
All actions accept parameters. Use data access variables to pass dynamic data:
{
"action": "colossal/send_email",
"parameters": {
"to": "{{payload.customer_email}}",
"subject": "Order {{payload.order_uid}} shipped",
"body": "Your order is on its way."
}
}
