Overview
Enable your agents to manage e-commerce operations through Shopify. Handle customers, orders, products, inventory, and store analytics to streamline your online business with AI-powered automation.Prerequisites
Before using the Shopify integration, ensure you have:- A CrewAI Enterprise account with an active subscription
- A Shopify store with appropriate admin permissions
- Connected your Shopify store through the Integrations page
Available Tools
Customer Management
SHOPIFY_GET_CUSTOMERS
SHOPIFY_GET_CUSTOMERS
Description: Retrieve a list of customers from your Shopify store.Parameters:
customerIds
(string, optional): Comma-separated list of customer IDs to filter by (example: “207119551, 207119552”)createdAtMin
(string, optional): Only return customers created after this date (ISO or Unix timestamp)createdAtMax
(string, optional): Only return customers created before this date (ISO or Unix timestamp)updatedAtMin
(string, optional): Only return customers updated after this date (ISO or Unix timestamp)updatedAtMax
(string, optional): Only return customers updated before this date (ISO or Unix timestamp)limit
(string, optional): Maximum number of customers to return (defaults to 250)
SHOPIFY_SEARCH_CUSTOMERS
SHOPIFY_SEARCH_CUSTOMERS
Description: Search for customers using advanced filtering criteria.Parameters:
filterFormula
(object, optional): Advanced filter in disjunctive normal form with field-specific operatorslimit
(string, optional): Maximum number of customers to return (defaults to 250)
SHOPIFY_CREATE_CUSTOMER
SHOPIFY_CREATE_CUSTOMER
Description: Create a new customer in your Shopify store.Parameters:
firstName
(string, required): Customer’s first namelastName
(string, required): Customer’s last nameemail
(string, required): Customer’s email addresscompany
(string, optional): Company namestreetAddressLine1
(string, optional): Street addressstreetAddressLine2
(string, optional): Street address line 2city
(string, optional): Citystate
(string, optional): State or province codecountry
(string, optional): CountryzipCode
(string, optional): Zip codephone
(string, optional): Phone numbertags
(string, optional): Tags as array or comma-separated listnote
(string, optional): Customer notesendEmailInvite
(boolean, optional): Whether to send email invitationmetafields
(object, optional): Additional metafields in JSON format
SHOPIFY_UPDATE_CUSTOMER
SHOPIFY_UPDATE_CUSTOMER
Description: Update an existing customer in your Shopify store.Parameters:
customerId
(string, required): The ID of the customer to updatefirstName
(string, optional): Customer’s first namelastName
(string, optional): Customer’s last nameemail
(string, optional): Customer’s email addresscompany
(string, optional): Company namestreetAddressLine1
(string, optional): Street addressstreetAddressLine2
(string, optional): Street address line 2city
(string, optional): Citystate
(string, optional): State or province codecountry
(string, optional): CountryzipCode
(string, optional): Zip codephone
(string, optional): Phone numbertags
(string, optional): Tags as array or comma-separated listnote
(string, optional): Customer notesendEmailInvite
(boolean, optional): Whether to send email invitationmetafields
(object, optional): Additional metafields in JSON format
Order Management
SHOPIFY_GET_ORDERS
SHOPIFY_GET_ORDERS
Description: Retrieve a list of orders from your Shopify store.Parameters:
orderIds
(string, optional): Comma-separated list of order IDs to filter by (example: “450789469, 450789470”)createdAtMin
(string, optional): Only return orders created after this date (ISO or Unix timestamp)createdAtMax
(string, optional): Only return orders created before this date (ISO or Unix timestamp)updatedAtMin
(string, optional): Only return orders updated after this date (ISO or Unix timestamp)updatedAtMax
(string, optional): Only return orders updated before this date (ISO or Unix timestamp)limit
(string, optional): Maximum number of orders to return (defaults to 250)
SHOPIFY_CREATE_ORDER
SHOPIFY_CREATE_ORDER
Description: Create a new order in your Shopify store.Parameters:
email
(string, required): Customer email addresslineItems
(object, required): Order line items in JSON format with title, price, quantity, and variant_idsendReceipt
(boolean, optional): Whether to send order receiptfulfillmentStatus
(string, optional): Fulfillment status - Options: fulfilled, null, partial, restockedfinancialStatus
(string, optional): Financial status - Options: pending, authorized, partially_paid, paid, partially_refunded, refunded, voidedinventoryBehaviour
(string, optional): Inventory behavior - Options: bypass, decrement_ignoring_policy, decrement_obeying_policynote
(string, optional): Order note
SHOPIFY_UPDATE_ORDER
SHOPIFY_UPDATE_ORDER
Description: Update an existing order in your Shopify store.Parameters:
orderId
(string, required): The ID of the order to updateemail
(string, optional): Customer email addresslineItems
(object, optional): Updated order line items in JSON formatsendReceipt
(boolean, optional): Whether to send order receiptfulfillmentStatus
(string, optional): Fulfillment status - Options: fulfilled, null, partial, restockedfinancialStatus
(string, optional): Financial status - Options: pending, authorized, partially_paid, paid, partially_refunded, refunded, voidedinventoryBehaviour
(string, optional): Inventory behavior - Options: bypass, decrement_ignoring_policy, decrement_obeying_policynote
(string, optional): Order note
SHOPIFY_GET_ABANDONED_CARTS
SHOPIFY_GET_ABANDONED_CARTS
Description: Retrieve abandoned carts from your Shopify store.Parameters:
createdWithInLast
(string, optional): Restrict results to checkouts created within specified timecreatedAfterId
(string, optional): Restrict results to after the specified IDstatus
(string, optional): Show checkouts with given status - Options: open, closed (defaults to open)createdAtMin
(string, optional): Only return carts created after this date (ISO or Unix timestamp)createdAtMax
(string, optional): Only return carts created before this date (ISO or Unix timestamp)limit
(string, optional): Maximum number of carts to return (defaults to 250)
Product Management (REST API)
SHOPIFY_GET_PRODUCTS
SHOPIFY_GET_PRODUCTS
Description: Retrieve a list of products from your Shopify store using REST API.Parameters:
productIds
(string, optional): Comma-separated list of product IDs to filter by (example: “632910392, 632910393”)title
(string, optional): Filter by product titleproductType
(string, optional): Filter by product typevendor
(string, optional): Filter by vendorstatus
(string, optional): Filter by status - Options: active, archived, draftcreatedAtMin
(string, optional): Only return products created after this date (ISO or Unix timestamp)createdAtMax
(string, optional): Only return products created before this date (ISO or Unix timestamp)updatedAtMin
(string, optional): Only return products updated after this date (ISO or Unix timestamp)updatedAtMax
(string, optional): Only return products updated before this date (ISO or Unix timestamp)limit
(string, optional): Maximum number of products to return (defaults to 250)
SHOPIFY_CREATE_PRODUCT
SHOPIFY_CREATE_PRODUCT
Description: Create a new product in your Shopify store using REST API.Parameters:
title
(string, required): Product titleproductType
(string, required): Product type/categoryvendor
(string, required): Product vendorproductDescription
(string, optional): Product description (accepts plain text or HTML)tags
(string, optional): Product tags as array or comma-separated listprice
(string, optional): Product priceinventoryPolicy
(string, optional): Inventory policy - Options: deny, continueimageUrl
(string, optional): Product image URLisPublished
(boolean, optional): Whether product is publishedpublishToPointToSale
(boolean, optional): Whether to publish to point of sale
SHOPIFY_UPDATE_PRODUCT
SHOPIFY_UPDATE_PRODUCT
Description: Update an existing product in your Shopify store using REST API.Parameters:
productId
(string, required): The ID of the product to updatetitle
(string, optional): Product titleproductType
(string, optional): Product type/categoryvendor
(string, optional): Product vendorproductDescription
(string, optional): Product description (accepts plain text or HTML)tags
(string, optional): Product tags as array or comma-separated listprice
(string, optional): Product priceinventoryPolicy
(string, optional): Inventory policy - Options: deny, continueimageUrl
(string, optional): Product image URLisPublished
(boolean, optional): Whether product is publishedpublishToPointToSale
(boolean, optional): Whether to publish to point of sale
Product Management (GraphQL)
SHOPIFY_GET_PRODUCTS_GRAPHQL
SHOPIFY_GET_PRODUCTS_GRAPHQL
Description: Retrieve products using advanced GraphQL filtering capabilities.Parameters:
productFilterFormula
(object, optional): Advanced filter in disjunctive normal form with support for fields like id, title, vendor, status, handle, tag, created_at, updated_at, published_at
SHOPIFY_CREATE_PRODUCT_GRAPHQL
SHOPIFY_CREATE_PRODUCT_GRAPHQL
Description: Create a new product using GraphQL API with enhanced media support.Parameters:
title
(string, required): Product titleproductType
(string, required): Product type/categoryvendor
(string, required): Product vendorproductDescription
(string, optional): Product description (accepts plain text or HTML)tags
(string, optional): Product tags as array or comma-separated listmedia
(object, optional): Media objects with alt text, content type, and source URLadditionalFields
(object, optional): Additional product fields like status, requiresSellingPlan, giftCard
SHOPIFY_UPDATE_PRODUCT_GRAPHQL
SHOPIFY_UPDATE_PRODUCT_GRAPHQL
Description: Update an existing product using GraphQL API with enhanced media support.Parameters:
productId
(string, required): The GraphQL ID of the product to update (e.g., “gid://shopify/Product/913144112”)title
(string, optional): Product titleproductType
(string, optional): Product type/categoryvendor
(string, optional): Product vendorproductDescription
(string, optional): Product description (accepts plain text or HTML)tags
(string, optional): Product tags as array or comma-separated listmedia
(object, optional): Updated media objects with alt text, content type, and source URLadditionalFields
(object, optional): Additional product fields like status, requiresSellingPlan, giftCard
Usage Examples
Basic Shopify Agent Setup
Filtering Specific Shopify Tools
Product Management with GraphQL
Order and Customer Analytics
Getting Help
Need Help?
Contact our support team for assistance with Shopify integration setup or troubleshooting.