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.12
Connector version
0.1.12
SDK commit
unknown
Support Open Source
Check us out on Github and join the Airbyte community
Installation & Usage
1
Install Package
Using uv or pip
bash
uv pip install airbyte-agent-sdk
2
Import
Initialize and use
python
from airbyte_agent_sdk.connectors.shopify import ShopifyConnector
from airbyte_agent_sdk.connectors.shopify.models import ShopifyAuthConfig
connector = ShopifyConnector(
auth_config=ShopifyAuthConfig(
api_key="<Your Shopify Admin API access token>"
)
)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), [Context Store Search](./REFERENCE.md#customers-context-store-search) |\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), [Context Store Search](./REFERENCE.md#product-variants-context-store-search) |\n| Product Images | [List](./REFERENCE.md#product-images-list), [Get](./REFERENCE.md#product-images-get), [Context Store Search](./REFERENCE.md#product-images-context-store-search) |\n| Abandoned Checkouts | [List](./REFERENCE.md#abandoned-checkouts-list), [Context Store Search](./REFERENCE.md#abandoned-checkouts-context-store-search) |\n| Locations | [List](./REFERENCE.md#locations-list), [Get](./REFERENCE.md#locations-get), [Context Store Search](./REFERENCE.md#locations-context-store-search) |\n| Inventory Levels | [List](./REFERENCE.md#inventory-levels-list), [Context Store Search](./REFERENCE.md#inventory-levels-context-store-search) |\n| Inventory Items | [List](./REFERENCE.md#inventory-items-list), [Get](./REFERENCE.md#inventory-items-get), [Context Store Search](./REFERENCE.md#inventory-items-context-store-search) |\n| Shop | [Get](./REFERENCE.md#shop-get), [Context Store Search](./REFERENCE.md#shop-context-store-search) |\n| Price Rules | [List](./REFERENCE.md#price-rules-list), [Get](./REFERENCE.md#price-rules-get), [Context Store Search](./REFERENCE.md#price-rules-context-store-search) |\n| Discount Codes | [List](./REFERENCE.md#discount-codes-list), [Get](./REFERENCE.md#discount-codes-get), [Context Store Search](./REFERENCE.md#discount-codes-context-store-search) |\n| Custom Collections | [List](./REFERENCE.md#custom-collections-list), [Get](./REFERENCE.md#custom-collections-get), [Context Store Search](./REFERENCE.md#custom-collections-context-store-search) |\n| Smart Collections | [List](./REFERENCE.md#smart-collections-list), [Get](./REFERENCE.md#smart-collections-get), [Context Store Search](./REFERENCE.md#smart-collections-context-store-search) |\n| Collects | [List](./REFERENCE.md#collects-list), [Get](./REFERENCE.md#collects-get), [Context Store Search](./REFERENCE.md#collects-context-store-search) |\n| Draft Orders | [List](./REFERENCE.md#draft-orders-list), [Get](./REFERENCE.md#draft-orders-get), [Context Store Search](./REFERENCE.md#draft-orders-context-store-search) |\n| Fulfillments | [List](./REFERENCE.md#fulfillments-list), [Get](./REFERENCE.md#fulfillments-get), [Context Store Search](./REFERENCE.md#fulfillments-context-store-search) |\n| Order Refunds | [List](./REFERENCE.md#order-refunds-list), [Get](./REFERENCE.md#order-refunds-get), [Context Store Search](./REFERENCE.md#order-refunds-context-store-search) |\n| Transactions | [List](./REFERENCE.md#transactions-list), [Get](./REFERENCE.md#transactions-get) |\n| Tender Transactions | [List](./REFERENCE.md#tender-transactions-list), [Context Store Search](./REFERENCE.md#tender-transactions-context-store-search) |\n| Countries | [List](./REFERENCE.md#countries-list), [Get](./REFERENCE.md#countries-get), [Context Store Search](./REFERENCE.md#countries-context-store-search) |\n| Metafield Shops | [List](./REFERENCE.md#metafield-shops-list), [Get](./REFERENCE.md#metafield-shops-get), [Context Store Search](./REFERENCE.md#metafield-shops-context-store-search) |\n| Metafield Customers | [List](./REFERENCE.md#metafield-customers-list), [Context Store Search](./REFERENCE.md#metafield-customers-context-store-search) |\n| Metafield Products | [List](./REFERENCE.md#metafield-products-list), [Context Store Search](./REFERENCE.md#metafield-products-context-store-search) |\n| Metafield Orders | [List](./REFERENCE.md#metafield-orders-list), [Context Store Search](./REFERENCE.md#metafield-orders-context-store-search) |\n| Metafield Draft Orders | [List](./REFERENCE.md#metafield-draft-orders-list), [Context Store Search](./REFERENCE.md#metafield-draft-orders-context-store-search) |\n| Metafield Locations | [List](./REFERENCE.md#metafield-locations-list), [Context Store Search](./REFERENCE.md#metafield-locations-context-store-search) |\n| Metafield Product Variants | [List](./REFERENCE.md#metafield-product-variants-list), [Context Store Search](./REFERENCE.md#metafield-product-variants-context-store-search) |\n| Metafield Smart Collections | [List](./REFERENCE.md#metafield-smart-collections-list), [Context Store Search](./REFERENCE.md#metafield-smart-collections-context-store-search) |\n| Metafield Product Images | [List](./REFERENCE.md#metafield-product-images-list), [Context Store Search](./REFERENCE.md#metafield-product-images-context-store-search) |\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), [Context Store Search](./REFERENCE.md#fulfillment-orders-context-store-search) |
Example Prompts
Lorem ipsum
List all customers in my Shopify store - Show me details for a recent customer - What products do I have in my store? - List all locations for my store - Show me inventory levels for a recent location - Show me all draft orders - List all custom collections in my store - Show me details for a recent order - Show me product variants for a recent product - Show me orders from the last 30 days - Show me abandoned checkouts from this week - What price rules are currently active?
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 using your Shopify Admin API access token. In open source mode, you provide the token directly via ShopifyAuthConfig. In hosted mode, credentials are stored securely in Airbyte Cloud and accessed via Airbyte client credentials.
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?
Currently, the Shopify connector focuses on read operations only. Write operations such as creating customers, updating product pricing, deleting orders, processing refunds, sending shipping notifications, 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.