Installation & Usage
[01]
Install Package
Using uv or pip
BASH
uv pip install airbyte-agent-shopify
[02]
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>"
)
)[03]
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 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
Secure Authentication
Built-in OAuth 2.0 handling with automatic token refresh. No hard-coded credentials.
Agent-Native Design
Heading
Structured, LLM-friendly schemas optimized for AI agent consumption with natural language query support.
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
CrewAI
LlamaIndex
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 direct API key authentication using your Shopify Admin API access token (open source mode), or Airbyte Cloud credential storage using your Airbyte client ID and client secret (hosted mode).
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, and creating discount codes are not currently supported.
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.
Get started in minutes with our open-source connector.