Skip to main content

Shopify

The Shopify agent connector is a Python package that equips AI agents to interact with Shopify through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.

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 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?

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

@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. If your Airbyte client can access multiple organizations, also set organization_id.

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, AirbyteAuthConfig

connector = ShopifyConnector(
    auth_config=AirbyteAuthConfig(
        customer_name="<your_customer_name>",
        organization_id="<your_organization_id>",  # Optional for multi-org clients
        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

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

Shopify API docs

See the official Shopify API reference.

Version information

  • Package version: 0.1.83
  • Connector version: 0.1.12
  • Generated with Connector SDK commit SHA: c5258debd165ab701252c1436d4acfb475bf92b9
  • Changelog: View changelog

Release files for airbyte-agent-shopify 0.1.83

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for airbyte-agent-shopify 0.1.83
File Size Uploaded
airbyte_agent_shopify-0.1.83.tar.gz 197.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for airbyte-agent-shopify 0.1.83
File Interpreter ABI Platform
airbyte_agent_shopify-0.1.83-py3-none-any.whl Python 3 none any Details

Total release size: 417.4 kB

Release files / airbyte_agent_shopify-0.1.83.tar.gz

Download URL airbyte_agent_shopify-0.1.83.tar.gz
Size 197.4 kB
Tags Source
SHA-256 checksum
How to use checksums
600dbc9a6dc6bef4e133facd1479df0617cc9f4d5a2c746593a22ea7c5bb1af3
BLAKE2b-256 checksum
How to use checksums
3e988038eaa11f49108425ab8be794fc18b61381bd7c41f051f13534b06a4546
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.12

Release files / airbyte_agent_shopify-0.1.83-py3-none-any.whl

Download URL airbyte_agent_shopify-0.1.83-py3-none-any.whl
Size 220.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0be06e68fdb6dc47548633fe7b2ced75cb87863be725af0e7ce4c18cb81ff797
BLAKE2b-256 checksum
How to use checksums
393f876a9d6e0e0f41eb67d6322365352014ba5cead93867f140fb947ad7fe43
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.12

Release history Release notifications | RSS feed

This release

0.1.83 This release

2 release files

0.1.74

2 release files

0.1.73

2 release files

0.1.72

2 release files

0.1.71

2 release files

0.1.70

2 release files

0.1.69

2 release files

0.1.68

2 release files

0.1.67

2 release files

0.1.62

2 release files

0.1.61

2 release files

0.1.60

2 release files

0.1.59

2 release files

0.1.58

2 release files

0.1.57

2 release files

0.1.56

2 release files

0.1.55

2 release files

0.1.54

2 release files

0.1.53

2 release files

0.1.52

2 release files

0.1.51

2 release files

0.1.50

2 release files

0.1.49

2 release files

0.1.48

2 release files

0.1.47

2 release files

0.1.24

2 release files

0.1.23

2 release files

0.1.22

2 release files

0.1.21

2 release files

0.1.20

2 release files

0.1.19

2 release files

0.1.18

2 release files

0.1.17

2 release files

0.1.16

2 release files

0.1.15

2 release files

0.1.14

2 release files

0.1.13

2 release files

0.1.12

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page