Important API details:
- All data access is performed via Shopify’s GraphQL API; queries are subject to Shopify’s standard GraphQL cost-based rate limits (typically 1,000 cost points per second for Storefront API).
- Authentication uses a Bearer token (JWT) with a 60-minute TTL; tokens must be refreshed before expiry to maintain uninterrupted agent access.
- Cart operations (get_cart, update_cart) are scoped to individual buyer sessions and require a valid cart or session identifier to function correctly.
- Store policies and FAQ search results are limited to content published and accessible via the Storefront API; unpublished or draft content will not be returned.
Server Details
Authentication
This server does not require authentication.
Server Configuration
The following parameters can be set in the server URL when adding this server to your Caylex project:Getting Started
1
Add the server
Navigate to the Server Library and click on the New Server button. Find Shopify in the Caylex Catalog.
2
Server Onboarding flow
Go through the server onboarding flow.
3
Use in a project
Add the server to a project by configuring project connections. Its tools are now available to any agents connected to that project.
Available Tools
This server provides 5 tools:Search
search_shop_catalog
search_shop_catalog
Search for products from the online store, hosted on Shopify.This tool can be used to search for products using natural language queries, specific filter criteria, or both.Best practices:
- Searches return available_filters which can be used for refined follow-up searches
- When filtering, use ONLY the filters from available_filters in follow-up searches
- For specific filter searches (category, variant option, product type, etc.), use simple terms without the filter name (e.g., “red” not “red color”)
- For filter-specific searches (e.g., “find burton in snowboards” or “show me all available products in gray / green color”), use a two-step approach:
- Perform a normal search to discover available filters
- If relevant filters are returned, do a second search using the proper filter (productType, category, variantOption, etc.) with just the specific search term
- Results are paginated, with initial results limited to improve experience
- Use the after parameter with endCursor to fetch additional pages when users request more results
search_shop_policies_and_faqs
search_shop_policies_and_faqs
Used to get facts about the stores policies, products, or services.
Some examples of questions you can ask are:
- What is your return policy?
- What is your shipping policy?
- What is your phone number?
- What are your hours of operation?”
Product
get_product_details
get_product_details
Look up a product by ID and optionally specify variant options to select a specific variant.
Cart
get_cart
get_cart
Get the cart including items, shipping options, discount info, and checkout url for a given cart id
update_cart
update_cart
Perform updates to a cart, including adding/removing/updating line items, buyer information, shipping details, discount codes, gift cards and notes in one consolidated call. Shipping options become available after adding items and delivery address. When creating a new cart, only addItems is required.