Tools

get_customer_details

Get customer details by UID or email. Returns email, full name, created_at, and order count.Input

string | null

The customer’s UUID

string | null

The customer’s email address

Output

string | null

integer | null

string | null

create_customer

Create a new customer record.Input

string

required

Customer email address.

string

required

Customer full name.

Output

CustomerOutput | null

Show properties

integer

string

integer

update_customer

Update a customer record.Input

integer

required

The customer’s database ID.

string | null

New email address.

string | null

New full name.

Output

CustomerOutput | null

Show properties

integer

string

integer

string[]

query_insights

Query the project’s analytics data.Input

string

required

get_invoice_details

Get invoice details by UID, including status, totals, line items, and billing info.Input

string

required

The invoice’s UUID

Output

boolean

string | null

integer | null

string | null

integer | null

string | null

integer | null

string | null

InvoiceLineItemOutput[]

Show properties

integer

integer | null

string

integer

create_invoice

Create an invoice for a customer.Input

integer

required

The customer’s database ID.

object[]

required

List of line items, each with description, quantity, unit_price.

string

ISO 4217 currency code (default: usd). Default: "usd".

Output

integer | null

string | null

integer | null

create_invoice_line_item

Append a line item to an existing invoice.Input

string

required

The invoice’s UUID.

string

required

Line item title.

integer

required

Quantity (>=1).

integer

required

Unit price in the invoice’s smallest currency unit.

integer | null

Optional product ID linking the item to a product.

string | null

Optional description.

Output

integer | null

list_notifications

Browse project notifications with filters.Input

string[] | null

boolean

Default: true.

boolean

Default: false.

boolean

Default: true.

integer | null

integer

Default: 25.

Output

integer

object[]

get_order_details

Get order details by UID including line items and customer info.Input

string

required

The order’s UUID

Output

integer | null

string | null

number | null

string | null

OrderCustomerInfo | null

Show properties

integer

string

OrderLineItemInfo[] | null

string | null

get_order_history

Get a customer’s recent order history. Returns orders with totals, status, and line items.Input

integer

required

The customer’s database ID

integer

Max orders to return (default 20) Default: 20.

Output

integer

OrderSummary[]

Show properties

integer | null

string | null

number | null

string | null

OrderCustomerInfo | null

Show properties

integer

string

OrderLineItemInfo[] | null

get_orders

Browse the most recent orders.Input

integer

Default: 10.

update_billing_address

Update the billing address on an order.Input

string

required

The order’s UUID.

string

required

Street address line 1.

string

required

City name.

string

required

Postal/ZIP code.

string

required

ISO country code (e.g. ‘US’).

string | null

Optional secondary address line.

string | null

Optional state/region code.

Output

integer | null

update_order

Update fields on an order (whitelisted by the order’s agent-updatable fields).Input

integer

required

The order’s database ID.

object

required

Dict of writable fields to apply (subject to the order’s agent-updatable whitelist).

Output

string | null

update_order_metadata

Update an order’s integration metadata.Input

integer

required

The order’s database ID.

object

required

Metadata fields to merge into the order record.

Output

integer | null

update_order_status

Update an order’s status. Pauses for approval before running.Input

integer

required

The order’s database ID.

enum (`pending`, `confirmed`, `complete`)

required

New status. Cannot be ‘refunded’ or ‘cancelled’ (those have dedicated flows).

Output

integer | null

string | null

update_shipping_address

Update the shipping address on an order.Input

string

required

The order’s UUID.

string

required

Street address line 1.

string

required

City name.

string

required

Postal/ZIP code.

string

required

ISO country code (e.g. ‘US’).

string | null

Optional secondary address line.

string | null

Optional state/region code.

Output

integer | null

get_payment_details

Get payment details by UID, including amount, status, and method.Input

string

required

The payment’s UUID

Output

boolean

string | null

integer | null

string | null

integer | null

string | null

integer | null

string | null

get_product_details

Get product details by UID, including name, description, archive state, and default variant.Input

string

required

The product’s UUID

Output

boolean

string | null

integer | null

string | null

boolean | null

ProductVariantOutput | null

Show properties

string

string | null

integer | null

ProductPriceOutput[]

Show properties

string

string | null

string

number | null

boolean

get_products

Browse the project’s products.Input

string | null

archive_deliverable

Archive a product deliverable.Input

string

required

The deliverable’s UUID.

Output

string | null

archive_product

Archive a product so it stops appearing on the storefront.Input

string

required

The product’s UUID.

Output

string | null

create_deliverable

Create a new product deliverable.Input

string

required

Deliverable type identifier.

string

required

Display name.

object | null

Optional type-specific configuration.

Output

string | null

create_price

Create a new price for a product variant.Input

string

required

The variant’s UUID.

number

required

Unit price.

string

ISO 4217 currency code (default: USD). Default: "USD".

string | null

Optional human-readable name for the price.

string | null

Optional ‘month’ or ‘year’ for subscriptions.

boolean

Whether to mark this as the default price for the variant. Default: false.

Output

string | null

boolean | null

publish_product

Publish a product so it appears on the storefront.Input

string

required

The product’s UUID.

Output

string | null

set_default_price

Mark a price as the default for its variant.Input

string

required

The price’s UUID.

Output

string | null

unarchive_product

Unarchive a product.Input

string

required

The product’s UUID.

Output

string | null

update_deliverable

Update a product deliverable.Input

string

required

The deliverable’s UUID.

string | null

Optional new name.

string | null

Optional new type identifier.

object | null

Optional new configuration.

Output

string | null

fetch_page

Fetch the content of a public web page.Input

string

required

string

required

web_search

Search the public web.Input

string

required

integer

Default: 5.

Get started

Platform

Agents

Automations

Storefront

Dev Tools

Customers

Read tools

Write tools

Insights

Read tools

Invoices

Read tools

Write tools

Notifications

Read tools

Orders

Read tools

Write tools

Payments

Read tools

Products

Read tools

Write tools

Web search

Read tools

​Customers

​Read tools

​Write tools

​Insights

​Read tools

​Invoices

​Read tools

​Write tools

​Notifications

​Read tools

​Orders

​Read tools

​Write tools

​Payments

​Read tools

​Products

​Read tools

​Write tools

​Web search

​Read tools

Customers

Read tools

Write tools

Insights

Read tools

Invoices

Read tools

Write tools

Notifications

Read tools

Orders

Read tools

Write tools

Payments

Read tools

Products

Read tools

Write tools

Web search

Read tools