Give agents tools for secure, real-time access to fetch, search, write, and sync across every system, with replication, entity mapping, and auth built-in.
About this Connector
Shopify is an e-commerce platform that enables businesses to create online stores, manage products, process orders, and handle customer relationships. This connector provides access to Shopify Admin REST API for reading store data including customers, orders, products, inventory, and more.
CRM
Sales Analytics
Customer Data
Version Information
Package version
0.1.22
Connector version
0.1.2
SDK commit
5b20f488dec0e8f29410823753106603c23a4b65
Support Open Source
Star us on GitHub to help grow the Airbyte community
Installation & Usage
1
Install Package
Using uv or pip
bash
uv pip install airbyte-agent-shopify
2
Import
Initialize and use
python
from airbyte_agent_shopify import ShopifyConnector
from airbyte_agent_shopify.models import ShopifyAuthConfig
connector = ShopifyConnector(
auth_config=ShopifyAuthConfig(
api_key="<Your Shopify Admin API access token>",
shop="<Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com)>"
)
)3
Tool
Add tools to your agent
python
@agent.tool_plain # assumes you're using Pydantic AI
@ShopifyConnector.tool_utils
async def shopify_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})Supported Entities & Actions
Lorem ipsum
Lorem ipsum
| Entity | Actions |\n|--------|---------|\n| Customers | [List](./REFERENCE.md#customers-list), [Get](./REFERENCE.md#customers-get) |\n| Orders | [List](./REFERENCE.md#orders-list), [Get](./REFERENCE.md#orders-get) |\n| Products | [List](./REFERENCE.md#products-list), [Get](./REFERENCE.md#products-get) |\n| Product Variants | [List](./REFERENCE.md#product-variants-list), [Get](./REFERENCE.md#product-variants-get) |\n| Product Images | [List](./REFERENCE.md#product-images-list), [Get](./REFERENCE.md#product-images-get) |\n| Abandoned Checkouts | [List](./REFERENCE.md#abandoned-checkouts-list) |\n| Locations | [List](./REFERENCE.md#locations-list), [Get](./REFERENCE.md#locations-get) |\n| Inventory Levels | [List](./REFERENCE.md#inventory-levels-list) |\n| Inventory Items | [List](./REFERENCE.md#inventory-items-list), [Get](./REFERENCE.md#inventory-items-get) |\n| Shop | [Get](./REFERENCE.md#shop-get) |\n| Price Rules | [List](./REFERENCE.md#price-rules-list), [Get](./REFERENCE.md#price-rules-get) |\n| Discount Codes | [List](./REFERENCE.md#discount-codes-list), [Get](./REFERENCE.md#discount-codes-get) |\n| Custom Collections | [List](./REFERENCE.md#custom-collections-list), [Get](./REFERENCE.md#custom-collections-get) |\n| Smart Collections | [List](./REFERENCE.md#smart-collections-list), [Get](./REFERENCE.md#smart-collections-get) |\n| Collects | [List](./REFERENCE.md#collects-list), [Get](./REFERENCE.md#collects-get) |\n| Draft Orders | [List](./REFERENCE.md#draft-orders-list), [Get](./REFERENCE.md#draft-orders-get) |\n| Fulfillments | [List](./REFERENCE.md#fulfillments-list), [Get](./REFERENCE.md#fulfillments-get) |\n| Order Refunds | [List](./REFERENCE.md#order-refunds-list), [Get](./REFERENCE.md#order-refunds-get) |\n| Transactions | [List](./REFERENCE.md#transactions-list), [Get](./REFERENCE.md#transactions-get) |\n| Tender Transactions | [List](./REFERENCE.md#tender-transactions-list) |\n| Countries | [List](./REFERENCE.md#countries-list), [Get](./REFERENCE.md#countries-get) |\n| Metafield Shops | [List](./REFERENCE.md#metafield-shops-list), [Get](./REFERENCE.md#metafield-shops-get) |\n| Metafield Customers | [List](./REFERENCE.md#metafield-customers-list) |\n| Metafield Products | [List](./REFERENCE.md#metafield-products-list) |\n| Metafield Orders | [List](./REFERENCE.md#metafield-orders-list) |\n| Metafield Draft Orders | [List](./REFERENCE.md#metafield-draft-orders-list) |\n| Metafield Locations | [List](./REFERENCE.md#metafield-locations-list) |\n| Metafield Product Variants | [List](./REFERENCE.md#metafield-product-variants-list) |\n| Metafield Smart Collections | [List](./REFERENCE.md#metafield-smart-collections-list) |\n| Metafield Product Images | [List](./REFERENCE.md#metafield-product-images-list) |\n| Customer Address | [List](./REFERENCE.md#customer-address-list), [Get](./REFERENCE.md#customer-address-get) |\n| Fulfillment Orders | [List](./REFERENCE.md#fulfillment-orders-list), [Get](./REFERENCE.md#fulfillment-orders-get) |
Example Prompts
Lorem ipsum
List all customers in my Shopify store - Show me orders from the last 30 days - Get details for customer \{customer_id\} - What products do I have in my store? - Show me abandoned checkouts from this week - List all locations for my store - Get inventory levels for location \{location_id\} - Show me all draft orders - What price rules are currently active? - List all custom collections in my store - Get details for order \{order_id\} - Show me product variants for product \{product_id\}
Why Airbyte for AI Agents?
Built for production AI workloads with enterprise-grade reliability
Agent-Native Design
Structured, LLM-friendly schemas optimized for AI agent consumption with natural language query support.
Secure Authentication
Built-in OAuth 2.0 handling with automatic token refresh. No hard-coded credentials.
Production Ready
Battle-tested connectors with comprehensive error handling, logging, and retry logic.
Open Source
Fully open source under the MIT license. Contribute, customize, and extend freely.
Works with your favorite frameworks
🦜
LangChain
🦙
LlamaIndex
🤖
CrewAI
⚡
AutoGen
🧠
OpenAI Agents SDK
🔮
Claude Agents SDK
Frequently Asked Questions
Didn't find your answer? Please don't hesitate to reach out.
The Shopify connector supports API key authentication. You need to provide your Shopify Admin API access token and your store name (e.g., 'my-store' from my-store.myshopify.com).
Can I use this connector with any AI agent framework?
The connector is compatible with any Python-based AI agent framework including LangChain, LlamaIndex, CrewAI, Pydantic AI, and custom implementations.
Does this connector support write operations?
No, the Shopify connector currently focuses on read operations only. Write operations such as creating customers, updating product pricing, deleting orders, processing refunds, or creating discount codes are not supported at this time.
How is this different from the Airbyte data connector?
Agent connectors are specifically designed for AI agents and LLM applications. They provide natural language interfaces, optimized response formats, and seamless integration with agent frameworks, unlike traditional ETL-focused connectors.
Will there be a platform for agent connectors?
The hosted version with secure credential storage through Airbyte Cloud is already available. See the hosted usage section in the documentation for setup instructions.
