airbyte-agent-shopify 0.1.18

Airbyte Shopify Connector for AI platforms

Shopify agent 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.

Example questions

The Shopify connector is optimized to handle prompts like these.

• 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}

Unsupported questions

The Shopify connector isn't currently able to handle prompts like these.

• Create a new customer in Shopify
• Update product pricing
• Delete an order
• Process a refund
• Send shipping notification to customer
• Create a new discount code

Installation

uv pip install airbyte-agent-shopify

Usage

Connectors can run in open source or hosted mode.

Open source

In open source mode, you provide API credentials directly to the connector.

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)>"
    )
)

@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 {})

Hosted

In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead.

This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.

from airbyte_agent_shopify import ShopifyConnector

connector = ShopifyConnector(
    external_user_id="<your_external_user_id>",
    airbyte_client_id="<your-client-id>",
    airbyte_client_secret="<your-client-secret>"
)

@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 {})

Full documentation

Entities and actions

This connector supports the following entities and actions. For more details, see this connector's full reference documentation.

Entity	Actions
Customers	List, Get
Orders	List, Get
Products	List, Get
Product Variants	List, Get
Product Images	List, Get
Abandoned Checkouts	List
Locations	List, Get
Inventory Levels	List
Inventory Items	List, Get
Shop	Get
Price Rules	List, Get
Discount Codes	List, Get
Custom Collections	List, Get
Smart Collections	List, Get
Collects	List, Get
Draft Orders	List, Get
Fulfillments	List, Get
Order Refunds	List, Get
Transactions	List, Get
Tender Transactions	List
Countries	List, Get
Metafield Shops	List, Get
Metafield Customers	List
Metafield Products	List
Metafield Orders	List
Metafield Draft Orders	List
Metafield Locations	List
Metafield Product Variants	List
Metafield Smart Collections	List
Metafield Product Images	List
Customer Address	List, Get
Fulfillment Orders	List, Get

Authentication and configuration

For all authentication and configuration options, see the connector's authentication documentation.

Shopify API docs

See the official Shopify API reference.

Version information

• Package version: 0.1.18
• Connector version: 0.1.2
• Generated with Connector SDK commit SHA: 97007bbdad3a6ac982ee2c0cdd667acdb5c12d3c