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)
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 detailsGet 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 totalsCustomer 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 detailsGet 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
- Customer asks: “Do you have blue sneakers?”
- Agent searches products with query “blue sneakers”
- Agent displays matching products with images and prices
- Customer can ask for more details or check availability
Availability Check
- Customer asks: “Is the red dress in stock?”
- Agent searches for “red dress”
- Agent checks inventory for matching product
- Agent responds: “Yes, 5 available in size Medium”
Order Tracking
- Customer asks: “Where’s my order #5678?”
- Agent looks up order by number
- Agent retrieves tracking information
- Agent responds: “Your order shipped via UPS, tracking: 1Z999. Estimated delivery: Tomorrow”
Price Comparison
- Customer asks: “Show me products under $50”
- Agent searches with price filter max=$50
- Agent displays matching products sorted by price
- Customer can browse results
Product Recommendations
- Customer asks: “Show me winter coats”
- Agent searches collection “winter” and tag “coats”
- Agent displays products with images
- 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/categorytag- Filter by product tagprice_min- Minimum price filterprice_max- Maximum price filterlimit- Number of results to return
order_number- Order number (e.g., #1234)order_id- Shopify order IDcustomer_email- Customer email for filteringstatus- Filter by status (pending, shipped, etc.)
email- Customer email addresscustomer_id- Shopify customer IDphone- 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 ID and number
- Line items (products ordered)
- Total price and subtotal
- Shipping and billing addresses
- Fulfillment status
- Tracking number
- Order date
- 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
- Shopify API has rate limits (typically 2 requests/second)
- Agent automatically handles rate limiting with retries
- Inventory updates may have 2-5 second delay
- Price changes reflect immediately
- Order status updates within 1 minute
- Product search returns maximum 100 results
- Can paginate for more results if needed
- Recommend using filters to narrow results