Documentation Index

Fetch the complete documentation index at: https://docs.chatcrafterai.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Shopify Actions Reference

Complete reference of actions your ChatCrafterAI agent can perform with Shopify integration.

​

Product Actions

​

Search Products

Find products by name, category, or tag. Parameters:

• Query text (product name or keyword)
• Optional: Collection/category filter
• Optional: Tag filter
• Optional: Price range (min/max)

Returns: Array of matching products with name, price, image

​

Get Product Details

Retrieve complete information for specific product. Required: Product ID or handle Returns:

• Product name and description
• Price and compare-at price
• Available variants (size, color, etc.)
• Product images
• SKU and barcode
• Vendor
• Product tags
• Inventory status

​

Check Inventory

View stock levels for products. Required: Product ID or variant ID Returns:

• Available quantity
• Inventory locations
• Stock status (in stock, low stock, out of stock)
• Available variants with stock

​

List Collections

Show product categories/collections. Optional: Filter by collection type Returns:

• Collection name
• Product count
• Collection image
• Collection handle

​

Order Actions

​

Check Order Status

Get current status of an order. Required: Order number or order ID Returns:

• Order status (pending, processing, shipped, delivered, cancelled)
• Estimated delivery date
• Tracking number
• Carrier information
• Current location (if tracking available)

​

Look Up Order by Number

Find order using order number. Required: Order number (e.g., #1234) Returns: Complete order object with details

​

Get Order Details

Retrieve full order information. Required: Order ID or number Returns:

• Order items (products, quantities, prices)
• Order total and subtotal
• Shipping address
• Billing address
• Payment status
• Fulfillment status
• Order date
• Tracking information

​

List Customer Orders

Show all orders for a customer. Required: Customer email or ID Returns: Array of orders with dates and totals

​

Customer Actions

​

Get Customer Info

Retrieve customer account details. Required: Customer email or ID Returns:

• Customer name
• Email address
• Phone number
• Total orders placed
• Total amount spent
• Account creation date
• Default address

​

Look Up by Email

Find customer using email address. Required: Email address Returns: Customer object with all details

​

Get Customer Order History

View past purchases for customer. Required: Customer email or ID Returns:

• List of past orders
• Order dates and totals
• Product names from each order
• Order status

​

Common Agent Patterns

​

Product Inquiry Flow

1. Customer asks: “Do you have blue sneakers?”
2. Agent searches products with query “blue sneakers”
3. Agent displays matching products with images and prices
4. Customer can ask for more details or check availability

​

Availability Check

1. Customer asks: “Is the red dress in stock?”
2. Agent searches for “red dress”
3. Agent checks inventory for matching product
4. Agent responds: “Yes, 5 available in size Medium”

​

Order Tracking

1. Customer asks: “Where’s my order #5678?”
2. Agent looks up order by number
3. Agent retrieves tracking information
4. Agent responds: “Your order shipped via UPS, tracking: 1Z999. Estimated delivery: Tomorrow”

​

Price Comparison

1. Customer asks: “Show me products under $50”
2. Agent searches with price filter max=$50
3. Agent displays matching products sorted by price
4. Customer can browse results

​

Product Recommendations

1. Customer asks: “Show me winter coats”
2. Agent searches collection “winter” and tag “coats”
3. Agent displays products with images
4. Agent can filter by size, color, price range

​

Action Parameters

Common parameters used across actions: Product Queries:

• query - Search term (product name, keyword)
• collection - Filter by collection/category
• tag - Filter by product tag
• price_min - Minimum price filter
• price_max - Maximum price filter
• limit - Number of results to return

Order Queries:

• order_number - Order number (e.g., #1234)
• order_id - Shopify order ID
• customer_email - Customer email for filtering
• status - Filter by status (pending, shipped, etc.)

Customer Queries:

• email - Customer email address
• customer_id - Shopify customer ID
• phone - Customer phone number

​

Response Data

Actions return structured data including: Product Data:

• Product ID and handle
• Title and description
• Price and currency
• Image URLs
• Variant options
• Inventory quantity
• SKU

Order Data:

• Order ID and number
• Line items (products ordered)
• Total price and subtotal
• Shipping and billing addresses
• Fulfillment status
• Tracking number
• Order date

Customer Data:

• Customer ID
• Name and contact info
• Order count and total spent
• Default shipping address
• Account status

​

Limitations

Read-Only Access:

• Agent cannot create orders (customers order through Shopify)
• Cannot modify inventory levels
• Cannot change product prices
• Cannot update customer information

Rate Limits:

• Shopify API has rate limits (typically 2 requests/second)
• Agent automatically handles rate limiting with retries

Data Sync:

• Inventory updates may have 2-5 second delay
• Price changes reflect immediately
• Order status updates within 1 minute

Search Limits:

• Product search returns maximum 100 results
• Can paginate for more results if needed
• Recommend using filters to narrow results

​

Next Steps

These actions enable powerful customer service automation. Experiment with different combinations to create the best experience for your customers.