Shopify authentication and configuration

This page documents the authentication and configuration options for the Shopify agent connector.

Authentication

Open source execution

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

OAuth

This authentication method isn't available for this connector.

Token

Field Name	Type	Required	Description
api_key	str	Yes	Your Shopify Admin API access token
shop	str	Yes	Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com)

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

Hosted execution

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.

OAuth

This authentication method isn't available for this connector.

Token

Create a connector with Token credentials:

curl -X POST 'https://api.airbyte.ai/v1/integrations/connectors' \
  -H 'Authorization: Bearer <SCOPED_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
    "external_user_id": "<EXTERNAL_USER_ID>",
    "connector_type": "Shopify",
    "credentials": {
      "api_key": "<Your Shopify Admin API access token>",
      "shop": "<Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com)>"
    }
  }'

Execution

After creating the connector, execute operations using either the Python SDK or API.

Python SDK

from airbyte_agent_shopify import ShopifyConnector

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

@agent.tool_plain # assumes you're using Pydantic AI
@ShopifyConnector.describe
async def shopify_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

API

curl -X POST 'https://api.airbyte.ai/api/v1/connectors/sources/<connector_id>/execute' \
  -H 'Authorization: Bearer <SCOPED_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"entity": "<entity>", "action": "<action>", "params": {}}'

Configuration

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.

Variable	Type	Required	Default	Description
shop	string	Yes	my-store	Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com)