airbyte-agent-shopify 0.1.17__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. airbyte_agent_shopify-0.1.17/.gitignore +29 -0
  2. airbyte_agent_shopify-0.1.17/AUTH.md +110 -0
  3. airbyte_agent_shopify-0.1.17/CHANGELOG.md +91 -0
  4. airbyte_agent_shopify-0.1.17/PKG-INFO +176 -0
  5. airbyte_agent_shopify-0.1.17/README.md +143 -0
  6. airbyte_agent_shopify-0.1.17/REFERENCE.md +4294 -0
  7. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/__init__.py +349 -0
  8. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/__init__.py +1 -0
  9. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/__init__.py +82 -0
  10. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/auth_strategies.py +1171 -0
  11. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/auth_template.py +135 -0
  12. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/cloud_utils/__init__.py +5 -0
  13. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/cloud_utils/client.py +213 -0
  14. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/connector_model_loader.py +1116 -0
  15. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/constants.py +78 -0
  16. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/exceptions.py +23 -0
  17. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/executor/__init__.py +31 -0
  18. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/executor/hosted_executor.py +196 -0
  19. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/executor/local_executor.py +1773 -0
  20. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/executor/models.py +190 -0
  21. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/extensions.py +693 -0
  22. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/http/__init__.py +37 -0
  23. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/http/adapters/__init__.py +9 -0
  24. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/http/adapters/httpx_adapter.py +251 -0
  25. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/http/config.py +98 -0
  26. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/http/exceptions.py +119 -0
  27. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/http/protocols.py +114 -0
  28. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/http/response.py +104 -0
  29. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/http_client.py +693 -0
  30. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/introspection.py +481 -0
  31. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/logging/__init__.py +11 -0
  32. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/logging/logger.py +273 -0
  33. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/logging/types.py +93 -0
  34. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/observability/__init__.py +11 -0
  35. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/observability/config.py +179 -0
  36. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/observability/models.py +19 -0
  37. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/observability/redactor.py +81 -0
  38. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/observability/session.py +103 -0
  39. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/performance/__init__.py +6 -0
  40. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/performance/instrumentation.py +57 -0
  41. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/performance/metrics.py +93 -0
  42. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/schema/__init__.py +75 -0
  43. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/schema/base.py +201 -0
  44. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/schema/components.py +244 -0
  45. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/schema/connector.py +120 -0
  46. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/schema/extensions.py +301 -0
  47. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/schema/operations.py +146 -0
  48. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/schema/security.py +236 -0
  49. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/secrets.py +182 -0
  50. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/telemetry/__init__.py +10 -0
  51. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/telemetry/config.py +32 -0
  52. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/telemetry/events.py +59 -0
  53. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/telemetry/tracker.py +155 -0
  54. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/types.py +255 -0
  55. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/utils.py +60 -0
  56. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/_vendored/connector_sdk/validation.py +828 -0
  57. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/connector.py +3052 -0
  58. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/connector_model.py +11640 -0
  59. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/models.py +1192 -0
  60. airbyte_agent_shopify-0.1.17/airbyte_agent_shopify/types.py +338 -0
  61. airbyte_agent_shopify-0.1.17/pyproject.toml +50 -0
@@ -0,0 +1,29 @@
1
+ # Python
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+ *.egg-info/
6
+ dist/
7
+ build/
8
+ .eggs/
9
+
10
+ # Testing
11
+ .pytest_cache/
12
+ .coverage
13
+ htmlcov/
14
+
15
+ # Virtual environments
16
+ .venv/
17
+ venv/
18
+
19
+ # IDE
20
+ .idea/
21
+ .vscode/
22
+ *.swp
23
+
24
+ # OS
25
+ .DS_Store
26
+ Thumbs.db
27
+
28
+ .env
29
+ configured_connectors.yaml
@@ -0,0 +1,110 @@
1
+ # Shopify authentication and configuration
2
+
3
+ This page documents the authentication and configuration options for the Shopify agent connector.
4
+
5
+ ## Authentication
6
+
7
+ ### Open source execution
8
+
9
+ In open source mode, you provide API credentials directly to the connector.
10
+
11
+ #### OAuth
12
+ This authentication method isn't available for this connector.
13
+
14
+ #### Token
15
+
16
+ `credentials` fields you need:
17
+
18
+ | Field Name | Type | Required | Description |
19
+ |------------|------|----------|-------------|
20
+ | `api_key` | `str` | Yes | Your Shopify Admin API access token |
21
+ | `shop` | `str` | Yes | Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com) |
22
+
23
+ Example request:
24
+
25
+ ```python
26
+ from airbyte_agent_shopify import ShopifyConnector
27
+ from airbyte_agent_shopify.models import ShopifyAuthConfig
28
+
29
+ connector = ShopifyConnector(
30
+ auth_config=ShopifyAuthConfig(
31
+ api_key="<Your Shopify Admin API access token>",
32
+ shop="<Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com)>"
33
+ )
34
+ )
35
+ ```
36
+
37
+ ### Hosted execution
38
+
39
+ In hosted mode, you first create a connector via the Airbyte API (providing your OAuth or Token credentials), then execute operations using either the Python SDK or API. If you need a step-by-step guide, see the [hosted execution tutorial](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-hosted).
40
+
41
+ #### OAuth
42
+ This authentication method isn't available for this connector.
43
+
44
+ #### Token
45
+ Create a connector with Token credentials.
46
+
47
+
48
+ `credentials` fields you need:
49
+
50
+ | Field Name | Type | Required | Description |
51
+ |------------|------|----------|-------------|
52
+ | `api_key` | `str` | Yes | Your Shopify Admin API access token |
53
+ | `shop` | `str` | Yes | Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com) |
54
+
55
+ Example request:
56
+
57
+
58
+ ```bash
59
+ curl -X POST "https://api.airbyte.ai/v1/integrations/connectors" \
60
+ -H "Authorization: Bearer <SCOPED_TOKEN>" \
61
+ -H "Content-Type: application/json" \
62
+ -d '{
63
+ "external_user_id": "<EXTERNAL_USER_ID>",
64
+ "connector_type": "Shopify",
65
+ "name": "My Shopify Connector",
66
+ "credentials": {
67
+ "api_key": "<Your Shopify Admin API access token>",
68
+ "shop": "<Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com)>"
69
+ }
70
+ }'
71
+ ```
72
+
73
+ #### Execution
74
+
75
+ After creating the connector, execute operations using either the Python SDK or API.
76
+
77
+ **Python SDK**
78
+
79
+ ```python
80
+ from airbyte_agent_shopify import ShopifyConnector
81
+
82
+ connector = ShopifyConnector(
83
+ external_user_id="<your_external_user_id>",
84
+ airbyte_client_id="<your-client-id>",
85
+ airbyte_client_secret="<your-client-secret>"
86
+ )
87
+
88
+ @agent.tool_plain # assumes you're using Pydantic AI
89
+ @ShopifyConnector.tool_utils
90
+ async def shopify_execute(entity: str, action: str, params: dict | None = None):
91
+ return await connector.execute(entity, action, params or {})
92
+ ```
93
+
94
+ **API**
95
+
96
+ ```bash
97
+ curl -X POST 'https://api.airbyte.ai/api/v1/connectors/sources/<connector_id>/execute' \
98
+ -H 'Authorization: Bearer <SCOPED_TOKEN>' \
99
+ -H 'Content-Type: application/json' \
100
+ -d '{"entity": "<entity>", "action": "<action>", "params": {}}'
101
+ ```
102
+
103
+
104
+ ## Configuration
105
+
106
+ The Shopify connector requires the following configuration variables. These variables are used to construct the base API URL. Pass them via the `config` parameter when initializing the connector.
107
+
108
+ | Variable | Type | Required | Default | Description |
109
+ |----------|------|----------|---------|-------------|
110
+ | `shop` | `string` | Yes | my-store | Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com) |
@@ -0,0 +1,91 @@
1
+ # Shopify changelog
2
+
3
+ ## [0.1.17] - 2026-01-28
4
+ - Updated connector definition (YAML version 0.1.2)
5
+ - Source commit: f6c6fca2
6
+ - SDK version: 0.1.0
7
+
8
+ ## [0.1.16] - 2026-01-28
9
+ - Updated connector definition (YAML version 0.1.2)
10
+ - Source commit: 71f48c10
11
+ - SDK version: 0.1.0
12
+
13
+ ## [0.1.15] - 2026-01-27
14
+ - Updated connector definition (YAML version 0.1.2)
15
+ - Source commit: 0f5e1914
16
+ - SDK version: 0.1.0
17
+
18
+ ## [0.1.14] - 2026-01-27
19
+ - Updated connector definition (YAML version 0.1.2)
20
+ - Source commit: a01f6b16
21
+ - SDK version: 0.1.0
22
+
23
+ ## [0.1.13] - 2026-01-27
24
+ - Updated connector definition (YAML version 0.1.2)
25
+ - Source commit: c9b05509
26
+ - SDK version: 0.1.0
27
+
28
+ ## [0.1.12] - 2026-01-27
29
+ - Updated connector definition (YAML version 0.1.1)
30
+ - Source commit: 4bded58d
31
+ - SDK version: 0.1.0
32
+
33
+ ## [0.1.11] - 2026-01-26
34
+ - Updated connector definition (YAML version 0.1.1)
35
+ - Source commit: 74809153
36
+ - SDK version: 0.1.0
37
+
38
+ ## [0.1.10] - 2026-01-26
39
+ - Updated connector definition (YAML version 0.1.1)
40
+ - Source commit: b73c71e0
41
+ - SDK version: 0.1.0
42
+
43
+ ## [0.1.9] - 2026-01-24
44
+ - Updated connector definition (YAML version 0.1.1)
45
+ - Source commit: 609c1d86
46
+ - SDK version: 0.1.0
47
+
48
+ ## [0.1.8] - 2026-01-23
49
+ - Updated connector definition (YAML version 0.1.1)
50
+ - Source commit: 416466da
51
+ - SDK version: 0.1.0
52
+
53
+ ## [0.1.7] - 2026-01-23
54
+ - Updated connector definition (YAML version 0.1.1)
55
+ - Source commit: f17cdd8c
56
+ - SDK version: 0.1.0
57
+
58
+ ## [0.1.6] - 2026-01-22
59
+ - Updated connector definition (YAML version 0.1.1)
60
+ - Source commit: 49e6dfe9
61
+ - SDK version: 0.1.0
62
+
63
+ ## [0.1.5] - 2026-01-22
64
+ - Updated connector definition (YAML version 0.1.1)
65
+ - Source commit: b27328e2
66
+ - SDK version: 0.1.0
67
+
68
+ ## [0.1.4] - 2026-01-22
69
+ - Updated connector definition (YAML version 0.1.1)
70
+ - Source commit: 1da193dd
71
+ - SDK version: 0.1.0
72
+
73
+ ## [0.1.3] - 2026-01-22
74
+ - Updated connector definition (YAML version 0.1.1)
75
+ - Source commit: c713ec48
76
+ - SDK version: 0.1.0
77
+
78
+ ## [0.1.2] - 2026-01-21
79
+ - Updated connector definition (YAML version 0.1.1)
80
+ - Source commit: c7dab975
81
+ - SDK version: 0.1.0
82
+
83
+ ## [0.1.1] - 2026-01-19
84
+ - Updated connector definition (YAML version 0.1.1)
85
+ - Source commit: 529cebb7
86
+ - SDK version: 0.1.0
87
+
88
+ ## [0.1.0] - 2026-01-17
89
+ - Updated connector definition (YAML version 0.1.1)
90
+ - Source commit: 7c6c8361
91
+ - SDK version: 0.1.0
@@ -0,0 +1,176 @@
1
+ Metadata-Version: 2.4
2
+ Name: airbyte-agent-shopify
3
+ Version: 0.1.17
4
+ Summary: Airbyte Shopify Connector for AI platforms
5
+ Project-URL: Homepage, https://github.com/airbytehq/airbyte-agent-connectors
6
+ Project-URL: Documentation, https://docs.airbyte.com/ai-agents/
7
+ Project-URL: Repository, https://github.com/airbytehq/airbyte-agent-connectors
8
+ Project-URL: Issues, https://github.com/airbytehq/airbyte-agent-connectors/issues
9
+ Author-email: Airbyte <contact@airbyte.io>
10
+ License: Elastic-2.0
11
+ Keywords: agent,ai,airbyte,api,connector,data-integration,llm,mcp,shopify
12
+ Classifier: Development Status :: 3 - Alpha
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: License :: Other/Proprietary License
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.13
18
+ Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
19
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
20
+ Classifier: Typing :: Typed
21
+ Requires-Python: >=3.13
22
+ Requires-Dist: httpx>=0.24.0
23
+ Requires-Dist: jinja2>=3.0.0
24
+ Requires-Dist: jsonpath-ng>=1.6.1
25
+ Requires-Dist: jsonref>=1.1.0
26
+ Requires-Dist: opentelemetry-api>=1.37.0
27
+ Requires-Dist: opentelemetry-sdk>=1.37.0
28
+ Requires-Dist: pydantic>=2.0.0
29
+ Requires-Dist: python-dotenv>=1.0.0
30
+ Requires-Dist: pyyaml>=6.0
31
+ Requires-Dist: segment-analytics-python>=2.2.0
32
+ Description-Content-Type: text/markdown
33
+
34
+ # Shopify agent connector
35
+
36
+ Shopify is an e-commerce platform that enables businesses to create online stores,
37
+ manage products, process orders, and handle customer relationships. This connector
38
+ provides access to Shopify Admin REST API for reading store data including customers,
39
+ orders, products, inventory, and more.
40
+
41
+
42
+ ## Example questions
43
+
44
+ The Shopify connector is optimized to handle prompts like these.
45
+
46
+ - List all customers in my Shopify store
47
+ - Show me orders from the last 30 days
48
+ - Get details for customer \{customer_id\}
49
+ - What products do I have in my store?
50
+ - Show me abandoned checkouts from this week
51
+ - List all locations for my store
52
+ - Get inventory levels for location \{location_id\}
53
+ - Show me all draft orders
54
+ - What price rules are currently active?
55
+ - List all custom collections in my store
56
+ - Get details for order \{order_id\}
57
+ - Show me product variants for product \{product_id\}
58
+
59
+ ## Unsupported questions
60
+
61
+ The Shopify connector isn't currently able to handle prompts like these.
62
+
63
+ - Create a new customer in Shopify
64
+ - Update product pricing
65
+ - Delete an order
66
+ - Process a refund
67
+ - Send shipping notification to customer
68
+ - Create a new discount code
69
+
70
+ ## Installation
71
+
72
+ ```bash
73
+ uv pip install airbyte-agent-shopify
74
+ ```
75
+
76
+ ## Usage
77
+
78
+ Connectors can run in open source or hosted mode.
79
+
80
+ ### Open source
81
+
82
+ In open source mode, you provide API credentials directly to the connector.
83
+
84
+ ```python
85
+ from airbyte_agent_shopify import ShopifyConnector
86
+ from airbyte_agent_shopify.models import ShopifyAuthConfig
87
+
88
+ connector = ShopifyConnector(
89
+ auth_config=ShopifyAuthConfig(
90
+ api_key="<Your Shopify Admin API access token>",
91
+ shop="<Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com)>"
92
+ )
93
+ )
94
+
95
+ @agent.tool_plain # assumes you're using Pydantic AI
96
+ @ShopifyConnector.tool_utils
97
+ async def shopify_execute(entity: str, action: str, params: dict | None = None):
98
+ return await connector.execute(entity, action, params or {})
99
+ ```
100
+
101
+ ### Hosted
102
+
103
+ In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead.
104
+
105
+ This example assumes you've already authenticated your connector with Airbyte. See [Authentication](AUTH.md) to learn more about authenticating. If you need a step-by-step guide, see the [hosted execution tutorial](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-hosted).
106
+
107
+ ```python
108
+ from airbyte_agent_shopify import ShopifyConnector
109
+
110
+ connector = ShopifyConnector(
111
+ external_user_id="<your_external_user_id>",
112
+ airbyte_client_id="<your-client-id>",
113
+ airbyte_client_secret="<your-client-secret>"
114
+ )
115
+
116
+ @agent.tool_plain # assumes you're using Pydantic AI
117
+ @ShopifyConnector.tool_utils
118
+ async def shopify_execute(entity: str, action: str, params: dict | None = None):
119
+ return await connector.execute(entity, action, params or {})
120
+ ```
121
+
122
+ ## Full documentation
123
+
124
+ ### Entities and actions
125
+
126
+ This connector supports the following entities and actions. For more details, see this connector's [full reference documentation](REFERENCE.md).
127
+
128
+ | Entity | Actions |
129
+ |--------|---------|
130
+ | Customers | [List](./REFERENCE.md#customers-list), [Get](./REFERENCE.md#customers-get) |
131
+ | Orders | [List](./REFERENCE.md#orders-list), [Get](./REFERENCE.md#orders-get) |
132
+ | Products | [List](./REFERENCE.md#products-list), [Get](./REFERENCE.md#products-get) |
133
+ | Product Variants | [List](./REFERENCE.md#product-variants-list), [Get](./REFERENCE.md#product-variants-get) |
134
+ | Product Images | [List](./REFERENCE.md#product-images-list), [Get](./REFERENCE.md#product-images-get) |
135
+ | Abandoned Checkouts | [List](./REFERENCE.md#abandoned-checkouts-list) |
136
+ | Locations | [List](./REFERENCE.md#locations-list), [Get](./REFERENCE.md#locations-get) |
137
+ | Inventory Levels | [List](./REFERENCE.md#inventory-levels-list) |
138
+ | Inventory Items | [List](./REFERENCE.md#inventory-items-list), [Get](./REFERENCE.md#inventory-items-get) |
139
+ | Shop | [Get](./REFERENCE.md#shop-get) |
140
+ | Price Rules | [List](./REFERENCE.md#price-rules-list), [Get](./REFERENCE.md#price-rules-get) |
141
+ | Discount Codes | [List](./REFERENCE.md#discount-codes-list), [Get](./REFERENCE.md#discount-codes-get) |
142
+ | Custom Collections | [List](./REFERENCE.md#custom-collections-list), [Get](./REFERENCE.md#custom-collections-get) |
143
+ | Smart Collections | [List](./REFERENCE.md#smart-collections-list), [Get](./REFERENCE.md#smart-collections-get) |
144
+ | Collects | [List](./REFERENCE.md#collects-list), [Get](./REFERENCE.md#collects-get) |
145
+ | Draft Orders | [List](./REFERENCE.md#draft-orders-list), [Get](./REFERENCE.md#draft-orders-get) |
146
+ | Fulfillments | [List](./REFERENCE.md#fulfillments-list), [Get](./REFERENCE.md#fulfillments-get) |
147
+ | Order Refunds | [List](./REFERENCE.md#order-refunds-list), [Get](./REFERENCE.md#order-refunds-get) |
148
+ | Transactions | [List](./REFERENCE.md#transactions-list), [Get](./REFERENCE.md#transactions-get) |
149
+ | Tender Transactions | [List](./REFERENCE.md#tender-transactions-list) |
150
+ | Countries | [List](./REFERENCE.md#countries-list), [Get](./REFERENCE.md#countries-get) |
151
+ | Metafield Shops | [List](./REFERENCE.md#metafield-shops-list), [Get](./REFERENCE.md#metafield-shops-get) |
152
+ | Metafield Customers | [List](./REFERENCE.md#metafield-customers-list) |
153
+ | Metafield Products | [List](./REFERENCE.md#metafield-products-list) |
154
+ | Metafield Orders | [List](./REFERENCE.md#metafield-orders-list) |
155
+ | Metafield Draft Orders | [List](./REFERENCE.md#metafield-draft-orders-list) |
156
+ | Metafield Locations | [List](./REFERENCE.md#metafield-locations-list) |
157
+ | Metafield Product Variants | [List](./REFERENCE.md#metafield-product-variants-list) |
158
+ | Metafield Smart Collections | [List](./REFERENCE.md#metafield-smart-collections-list) |
159
+ | Metafield Product Images | [List](./REFERENCE.md#metafield-product-images-list) |
160
+ | Customer Address | [List](./REFERENCE.md#customer-address-list), [Get](./REFERENCE.md#customer-address-get) |
161
+ | Fulfillment Orders | [List](./REFERENCE.md#fulfillment-orders-list), [Get](./REFERENCE.md#fulfillment-orders-get) |
162
+
163
+
164
+ ### Authentication and configuration
165
+
166
+ For all authentication and configuration options, see the connector's [authentication documentation](AUTH.md).
167
+
168
+ ### Shopify API docs
169
+
170
+ See the official [Shopify API reference](https://shopify.dev/docs/api/admin-rest).
171
+
172
+ ## Version information
173
+
174
+ - **Package version:** 0.1.17
175
+ - **Connector version:** 0.1.2
176
+ - **Generated with Connector SDK commit SHA:** f6c6fca292b291b200b31e4056856465129ae703
@@ -0,0 +1,143 @@
1
+ # Shopify agent connector
2
+
3
+ Shopify is an e-commerce platform that enables businesses to create online stores,
4
+ manage products, process orders, and handle customer relationships. This connector
5
+ provides access to Shopify Admin REST API for reading store data including customers,
6
+ orders, products, inventory, and more.
7
+
8
+
9
+ ## Example questions
10
+
11
+ The Shopify connector is optimized to handle prompts like these.
12
+
13
+ - List all customers in my Shopify store
14
+ - Show me orders from the last 30 days
15
+ - Get details for customer \{customer_id\}
16
+ - What products do I have in my store?
17
+ - Show me abandoned checkouts from this week
18
+ - List all locations for my store
19
+ - Get inventory levels for location \{location_id\}
20
+ - Show me all draft orders
21
+ - What price rules are currently active?
22
+ - List all custom collections in my store
23
+ - Get details for order \{order_id\}
24
+ - Show me product variants for product \{product_id\}
25
+
26
+ ## Unsupported questions
27
+
28
+ The Shopify connector isn't currently able to handle prompts like these.
29
+
30
+ - Create a new customer in Shopify
31
+ - Update product pricing
32
+ - Delete an order
33
+ - Process a refund
34
+ - Send shipping notification to customer
35
+ - Create a new discount code
36
+
37
+ ## Installation
38
+
39
+ ```bash
40
+ uv pip install airbyte-agent-shopify
41
+ ```
42
+
43
+ ## Usage
44
+
45
+ Connectors can run in open source or hosted mode.
46
+
47
+ ### Open source
48
+
49
+ In open source mode, you provide API credentials directly to the connector.
50
+
51
+ ```python
52
+ from airbyte_agent_shopify import ShopifyConnector
53
+ from airbyte_agent_shopify.models import ShopifyAuthConfig
54
+
55
+ connector = ShopifyConnector(
56
+ auth_config=ShopifyAuthConfig(
57
+ api_key="<Your Shopify Admin API access token>",
58
+ shop="<Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com)>"
59
+ )
60
+ )
61
+
62
+ @agent.tool_plain # assumes you're using Pydantic AI
63
+ @ShopifyConnector.tool_utils
64
+ async def shopify_execute(entity: str, action: str, params: dict | None = None):
65
+ return await connector.execute(entity, action, params or {})
66
+ ```
67
+
68
+ ### Hosted
69
+
70
+ In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead.
71
+
72
+ This example assumes you've already authenticated your connector with Airbyte. See [Authentication](AUTH.md) to learn more about authenticating. If you need a step-by-step guide, see the [hosted execution tutorial](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-hosted).
73
+
74
+ ```python
75
+ from airbyte_agent_shopify import ShopifyConnector
76
+
77
+ connector = ShopifyConnector(
78
+ external_user_id="<your_external_user_id>",
79
+ airbyte_client_id="<your-client-id>",
80
+ airbyte_client_secret="<your-client-secret>"
81
+ )
82
+
83
+ @agent.tool_plain # assumes you're using Pydantic AI
84
+ @ShopifyConnector.tool_utils
85
+ async def shopify_execute(entity: str, action: str, params: dict | None = None):
86
+ return await connector.execute(entity, action, params or {})
87
+ ```
88
+
89
+ ## Full documentation
90
+
91
+ ### Entities and actions
92
+
93
+ This connector supports the following entities and actions. For more details, see this connector's [full reference documentation](REFERENCE.md).
94
+
95
+ | Entity | Actions |
96
+ |--------|---------|
97
+ | Customers | [List](./REFERENCE.md#customers-list), [Get](./REFERENCE.md#customers-get) |
98
+ | Orders | [List](./REFERENCE.md#orders-list), [Get](./REFERENCE.md#orders-get) |
99
+ | Products | [List](./REFERENCE.md#products-list), [Get](./REFERENCE.md#products-get) |
100
+ | Product Variants | [List](./REFERENCE.md#product-variants-list), [Get](./REFERENCE.md#product-variants-get) |
101
+ | Product Images | [List](./REFERENCE.md#product-images-list), [Get](./REFERENCE.md#product-images-get) |
102
+ | Abandoned Checkouts | [List](./REFERENCE.md#abandoned-checkouts-list) |
103
+ | Locations | [List](./REFERENCE.md#locations-list), [Get](./REFERENCE.md#locations-get) |
104
+ | Inventory Levels | [List](./REFERENCE.md#inventory-levels-list) |
105
+ | Inventory Items | [List](./REFERENCE.md#inventory-items-list), [Get](./REFERENCE.md#inventory-items-get) |
106
+ | Shop | [Get](./REFERENCE.md#shop-get) |
107
+ | Price Rules | [List](./REFERENCE.md#price-rules-list), [Get](./REFERENCE.md#price-rules-get) |
108
+ | Discount Codes | [List](./REFERENCE.md#discount-codes-list), [Get](./REFERENCE.md#discount-codes-get) |
109
+ | Custom Collections | [List](./REFERENCE.md#custom-collections-list), [Get](./REFERENCE.md#custom-collections-get) |
110
+ | Smart Collections | [List](./REFERENCE.md#smart-collections-list), [Get](./REFERENCE.md#smart-collections-get) |
111
+ | Collects | [List](./REFERENCE.md#collects-list), [Get](./REFERENCE.md#collects-get) |
112
+ | Draft Orders | [List](./REFERENCE.md#draft-orders-list), [Get](./REFERENCE.md#draft-orders-get) |
113
+ | Fulfillments | [List](./REFERENCE.md#fulfillments-list), [Get](./REFERENCE.md#fulfillments-get) |
114
+ | Order Refunds | [List](./REFERENCE.md#order-refunds-list), [Get](./REFERENCE.md#order-refunds-get) |
115
+ | Transactions | [List](./REFERENCE.md#transactions-list), [Get](./REFERENCE.md#transactions-get) |
116
+ | Tender Transactions | [List](./REFERENCE.md#tender-transactions-list) |
117
+ | Countries | [List](./REFERENCE.md#countries-list), [Get](./REFERENCE.md#countries-get) |
118
+ | Metafield Shops | [List](./REFERENCE.md#metafield-shops-list), [Get](./REFERENCE.md#metafield-shops-get) |
119
+ | Metafield Customers | [List](./REFERENCE.md#metafield-customers-list) |
120
+ | Metafield Products | [List](./REFERENCE.md#metafield-products-list) |
121
+ | Metafield Orders | [List](./REFERENCE.md#metafield-orders-list) |
122
+ | Metafield Draft Orders | [List](./REFERENCE.md#metafield-draft-orders-list) |
123
+ | Metafield Locations | [List](./REFERENCE.md#metafield-locations-list) |
124
+ | Metafield Product Variants | [List](./REFERENCE.md#metafield-product-variants-list) |
125
+ | Metafield Smart Collections | [List](./REFERENCE.md#metafield-smart-collections-list) |
126
+ | Metafield Product Images | [List](./REFERENCE.md#metafield-product-images-list) |
127
+ | Customer Address | [List](./REFERENCE.md#customer-address-list), [Get](./REFERENCE.md#customer-address-get) |
128
+ | Fulfillment Orders | [List](./REFERENCE.md#fulfillment-orders-list), [Get](./REFERENCE.md#fulfillment-orders-get) |
129
+
130
+
131
+ ### Authentication and configuration
132
+
133
+ For all authentication and configuration options, see the connector's [authentication documentation](AUTH.md).
134
+
135
+ ### Shopify API docs
136
+
137
+ See the official [Shopify API reference](https://shopify.dev/docs/api/admin-rest).
138
+
139
+ ## Version information
140
+
141
+ - **Package version:** 0.1.17
142
+ - **Connector version:** 0.1.2
143
+ - **Generated with Connector SDK commit SHA:** f6c6fca292b291b200b31e4056856465129ae703