Tools reference
| Tool | Description | Sample prompt |
|---|---|---|
global_search | Search across all store data (products, customers, sales, discounts) | “Search for ‘premium’ in my store” |
get_store | Get store profile, settings, and sales summary | ”Show me my store information” |
list_products | List products with optional filters (status, category, type) | “List my published products” |
get_product | Get full details for a specific product | ”Show me details for product prd_abc123” |
list_customers | List customers with optional search | ”Find customers named Marie” |
get_customer | Get full profile for a specific customer | ”Show me customer cus_abc123” |
list_sales | List sales with filters (status, date range, customer) | “Show me today’s completed sales” |
get_sale | Get complete details for a specific sale | ”Get details for sale sal_xyz789” |
list_discounts | List discount codes with optional filters | ”List my active discount codes” |
get_discount | Get full details for a specific discount | ”How many times has SUMMER20 been used?” |
list_licenses | List issued licenses with filters (status, customer, product) | “List all active licenses” |
get_license | Get details for a specific license key | ”Check license ABC-123-XYZ-789” |
get_license_activations | View activation history for a license | ”Show activations for license ABC-123” |
list_pulses | List webhook configurations | ”List my webhooks” |
get_pulse | Get details for a specific webhook | ”Show me pulse pulse_abc123” |
get_store_analytics | Get store performance overview (visits, conversions, sales) | “Show me store analytics for this month” |
get_sales_analytics | Get detailed revenue and sales analysis | ”What’s my revenue this month?” |
get_customer_analytics | Get customer insights (new vs returning, geography) | “Who are my top 5 customers?” |
get_visits_analytics | Get traffic analysis (sources, devices, locations) | “Where is my traffic coming from?” |
get_conversion_rate_analytics | Get conversion rates by device, country, product | ”What’s my conversion rate?” |
Tool details
global_search
Search across all your store data at once.| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | Yes | Search term |
limit | integer | No | Results per category (1-10). Default: 5 |
from | string | No | Start date (YYYY-MM-DD) |
to | string | No | End date (YYYY-MM-DD) |
get_store
Get your store profile, settings, and sales summary. No parameters required.list_products
List products with filtering and pagination.| Parameter | Type | Required | Description |
|---|---|---|---|
search | string | No | Search by name or slug |
status | string | No | Filter: draft, published, archived |
category | string | No | Filter by category |
type | string | No | Filter: downloadable, service, course, license, bundle |
per_page | integer | No | Results per page (1-100). Default: 20 |
cursor | string | No | Pagination cursor |
get_product
Get full details for a specific product.| Parameter | Type | Required | Description |
|---|---|---|---|
product_id | string | Yes | Product ID (prd_xxx) or slug |
list_customers
List customers with optional search.| Parameter | Type | Required | Description |
|---|---|---|---|
search | string | No | Search by name or email |
per_page | integer | No | Results per page (1-100). Default: 20 |
cursor | string | No | Pagination cursor |
get_customer
Get full profile for a specific customer.| Parameter | Type | Required | Description |
|---|---|---|---|
customer_id | string | Yes | Customer ID (cus_xxx) |
list_sales
List sales with filtering options.| Parameter | Type | Required | Description |
|---|---|---|---|
status | string | No | Filter: completed, failed, pending, abandoned |
customer_id | string | No | Filter by customer |
start_date | string | No | From date (YYYY-MM-DD) |
end_date | string | No | To date (YYYY-MM-DD) |
per_page | integer | No | Results per page (1-100). Default: 10 |
cursor | string | No | Pagination cursor |
get_sale
Get complete details for a specific sale.| Parameter | Type | Required | Description |
|---|---|---|---|
sale_id | string | Yes | Sale ID (sal_xxx) |
list_discounts
List discount codes with optional filters.| Parameter | Type | Required | Description |
|---|---|---|---|
status | string | No | Filter: active, expired, disabled |
search | string | No | Search by code or name |
per_page | integer | No | Results per page (1-100). Default: 20 |
cursor | string | No | Pagination cursor |
get_discount
Get full details for a specific discount.| Parameter | Type | Required | Description |
|---|---|---|---|
discount_id | string | Yes | Discount ID (dis_xxx) |
list_licenses
List issued licenses with filters.| Parameter | Type | Required | Description |
|---|---|---|---|
status | string | No | Filter: active, expired, revoked |
customer_id | string | No | Filter by customer |
product_id | string | No | Filter by product |
per_page | integer | No | Results per page (1-100). Default: 20 |
cursor | string | No | Pagination cursor |
get_license
Get details for a specific license key.| Parameter | Type | Required | Description |
|---|---|---|---|
license_key | string | Yes | License key (e.g., ABC-123-XYZ-789) |
get_license_activations
View activation history for a license.| Parameter | Type | Required | Description |
|---|---|---|---|
license_key | string | Yes | License key |
list_pulses
List webhook configurations.| Parameter | Type | Required | Description |
|---|---|---|---|
search | string | No | Search webhooks |
per_page | integer | No | Results per page (1-100). Default: 20 |
cursor | string | No | Pagination cursor |
get_pulse
Get details for a specific webhook.| Parameter | Type | Required | Description |
|---|---|---|---|
pulse_id | string | Yes | Pulse ID (pulse_xxx) |
get_store_analytics
Get store performance overview.| Parameter | Type | Required | Description |
|---|---|---|---|
from | string | Yes | Start date (YYYY-MM-DD) |
to | string | Yes | End date (YYYY-MM-DD) |
get_sales_analytics
Get detailed revenue and sales analysis.| Parameter | Type | Required | Description |
|---|---|---|---|
from | string | Yes | Start date (YYYY-MM-DD) |
to | string | Yes | End date (YYYY-MM-DD) |
get_customer_analytics
Get customer insights and top customers.| Parameter | Type | Required | Description |
|---|---|---|---|
from | string | Yes | Start date (YYYY-MM-DD) |
to | string | Yes | End date (YYYY-MM-DD) |
top_customers_limit | integer | No | Number of top customers. Default: 10 |
get_visits_analytics
Get traffic analysis.| Parameter | Type | Required | Description |
|---|---|---|---|
from | string | Yes | Start date (YYYY-MM-DD) |
to | string | Yes | End date (YYYY-MM-DD) |
get_conversion_rate_analytics
Get conversion rates by device, country, and product.| Parameter | Type | Required | Description |
|---|---|---|---|
from | string | Yes | Start date (YYYY-MM-DD) |
to | string | Yes | End date (YYYY-MM-DD) |