Skip to main content
Built-in operations an automation can run as App Action steps on Colossal’s commerce primitives. Each action has typed inputs and outputs.

​
Customers

Create a new customer.Input
​
string
required
Customer email address
​
string
required
Customer full name
Output
​
CustomerOutput | null
Retrieve customer by ID, UUID, or email.Input
​
integer | null
Customer ID
​
string | null
Customer UUID
​
string | null
Customer email
Output
​
CustomerOutput | null
Update customer details.Input
​
integer
required
Customer ID to update
​
string | null
New email address
​
string | null
New full name
Output
​
CustomerOutput | null
​
string[]

​
Products

Archive a product deliverable.Input
​
string
required
Output
​
string | null
Archive a product to hide it from the project.Input
​
string
required
Output
​
string | null
Create a new product deliverable in the project.Input
​
string
required
​
string
required
​
object | null
Output
​
string | null
​
string | null
Create a new price for a product variant.Input
​
string
required
​
string | null
​
number
required
min: > 0.
​
string
Default: "USD".
​
string | null
​
boolean
Default: false.
Output
​
string | null
​
boolean | null
Create a new product in the project with optional price and images.Input
​
string
required
​
string
required
​
string | null
​
string | null
​
number | null
​
string | null
​
string[]
Output
​
string | null
​
string | null
​
string | null
Retrieve product details by UID.Input
​
string
required
Output
​
integer | null
​
string | null
​
string | null
​
string | null
​
string | null
​
boolean | null
​
boolean | null
​
ProductVariantOutput | null
Publish a product to make it visible in the project.Input
​
string
required
Output
​
string | null
​
string | null
Mark a price as the default for its variant.Input
​
string
required
Output
​
string | null
Restore an archived product.Input
​
string
required
Output
​
string | null
Update a product deliverable’s name, type, or config.Input
​
string
required
​
string | null
​
string | null
​
object | null
Output
​
string | null
Update an existing product’s details.Input
​
string
required
​
string | null
​
string | null
​
string | null
​
string | null
Output
​
string | null
​
string | null
Update the default price of a product.Input
​
string
required
​
number
required
min: > 0.
​
string | null
Output
​
string | null
​
string | null
​
number | null
​
string | null

​
Orders

Retrieve order details by ID.Input
​
integer
required
min: > 0.
Output
​
integer | null
​
string | null
​
string | null
​
integer | null
​
string | null
​
number | null
​
number | null
​
number | null
​
OrderLineItemOutput[]
Retrieve orders for a specific customer.Input
​
integer
required
min: > 0.
​
integer
min: 1, max: 100. Default: 50.
Output
​
integer | null
​
CustomerOrderOutput[]
​
integer
Get the total number of orders placed by a specific customer.Input
​
integer
required
min: > 0.
Output
​
integer | null
​
integer | null
Update an order’s billing address.Input
​
string
required
​
string
required
​
string
required
​
string
required
​
string
required
​
string | null
​
string | null
Output
​
integer | null
Update order fields in a secure project-scoped manner.Input
​
integer
required
min: > 0.
​
object
required
Fields to update on the order
Output
​
string | null
Update order integration metadata.Input
​
integer
required
min: > 0.
​
object
required
Metadata fields to merge into the order
Output
​
integer | null
Update the status of an order.Input
​
integer
required
min: > 0.
​
enum (`pending`, `confirmed`, `complete`)
required
New order status
Output
​
integer | null
​
string | null
​
string | null
Update an order’s shipping address.Input
​
string
required
​
string
required
​
string
required
​
string
required
​
string
required
​
string | null
​
string | null
Output
​
integer | null

​
Payments

Retrieve all payments for an invoice.Input
​
integer
required
min: > 0.
​
integer
min: 1, max: 50. Default: 10.
Output
​
integer | null
​
PaymentSummary[]
​
integer
Retrieve payment details by UID.Input
​
string
required
Output
​
integer | null
​
string | null
​
integer | null
​
string | null
​
integer | null
​
string | null
​
string | null
​
string | null
​
string | null
​
string | null
​
string | null
​
string | null
​
string | null

​
Invoices

Create a new invoice with line items.Input
​
integer | null
​
string | null
​
string | null
​
string | null
​
CreateInvoiceLineItemInput[]
required
Output
​
integer | null
​
string | null
​
string | null
​
integer | null
Append a line item to an existing invoice.Input
​
string
required
​
string
required
​
integer
required
min: 1.
​
integer
required
min: 0.
​
integer | null
​
string | null
Output
​
integer | null
​
integer | null
Retrieve invoice details by UID.Input
​
string
required
Output
​
integer | null
​
string | null
​
string | null
​
string | null
​
string | null
​
integer | null
​
integer | null
​
string | null
​
integer | null
​
integer | null
​
integer | null
​
integer | null
​
string | null
​
string | null
​
InvoiceLineItemOutput[]

​
Inventory

Check current inventory level for a product and determine if stock is low.Input
​
integer
required
min: > 0.
​
integer
min: 0. Default: 10.
Output
​
integer | null
​
string | null
​
integer | null
​
boolean | null
​
integer | null