Skip to main content
Built-in cart and checkout operations an agent can run as App Action steps. Each action has typed inputs and outputs. For all other built-in operations, see Colossal actions.

​
Cart

Add a product to the cart.Input
​
cart_uid
string
required
Cart UUID
​
product_uid
string
required
Product UUID to add
​
quantity
integer
Quantity to add min: 1. Default: 1.
Output
​
cart_uid
string | null
​
line_item_id
integer | null
​
product_uid
string | null
​
quantity
integer | null
Retrieve cart details by UUID.Input
​
cart_uid
string
required
Cart UUID
Output
​
cart_uid
string | null
​
line_items
CartLineItemOutput[]
​
item_count
integer
​
subtotal
number
Remove an item from the cart.Input
​
cart_uid
string
required
Cart UUID
​
line_item_id
integer
required
Line item ID to remove min: > 0.
Output
​
cart_uid
string | null
​
line_item_id
integer | null
​
product_uid
string | null
Update the quantity of a cart item.Input
​
cart_uid
string
required
Cart UUID
​
line_item_id
integer
required
Line item ID to update min: > 0.
​
quantity
integer
required
New quantity min: 1.
Output
​
cart_uid
string | null
​
line_item_id
integer | null
​
previous_quantity
integer | null
​
new_quantity
integer | null

​
Checkout

Retrieve checkout session for a given order.Input
​
order_id
integer
required
Order ID min: > 0.
Output
​
checkout
CheckoutOutput | null
Retrieve checkout session details by UUID.Input
​
checkout_uid
string
required
Checkout session UUID
Output
​
checkout
CheckoutOutput | null