| Specification | Details |
|---|---|
| Repository type | Cloud |
| Supported content | Blog Articles |
| RACL support | No |
| Content filtering | No |
Prerequisites
- An admin account on Shopify.
- A Shopify custom app, created using one of the following methods, depending on the authorization type you plan to use:
- Legacy custom app, created from the Shopify Admin, for API Access Token authorization.
- Dev Dashboard app, created from the Shopify Dev Dashboard or CLI, for Client Credentials (OAuth 2.0) authorization.
Step 1: Configure Authentication on Shopify
Choose the setup method that matches your custom app type.Option A: API Access Token (legacy custom apps)
- Sign in to the Shopify admin portal.
- Go to Apps and Sales Channels.
- Click Develop apps and create an app.
- Enter the app name and details.
- Enable the following admin scope and click Save:
read_content
- Go to the API Credentials tab and click Install app to generate an access token. This token is used to configure the Search AI connector.
Option B: Client Credentials (OAuth, Dev Dashboard apps)
- Sign in to the Shopify Dev Dashboard.
- Create a new app, or select an existing one.
- Enable the following admin scope:
read_content
- Go to the app’s Client Credentials section and note the Client ID and Secret.
- Note your store’s Store Domain (for example,
yourstore.myshopify.com).
Step 2: Configure the Search AI Connector
Go to Content > Connectors and select the Shopify connector. On the Authentication tab, select an Authorization Method and enter the corresponding fields.API Access Token
| Field | Description |
|---|---|
| Name | Unique name for the connector |
| Store Host URL | URL of your Shopify store |
| Authorization Method | API Access Token |
| API Key | Access token generated in the Shopify app |
Client Credentials (OAuth)
Enter the corresponding fields:| Field | Description |
|---|---|
| Name | Unique name for the connector |
| Store Host URL | URL of your Shopify store |
| Authorization Method | Client Credentials (OAuth) |
| Client ID | Client ID from the Shopify Dev Dashboard app |
| Client Secret | Client Secret from the Shopify Dev Dashboard app |
Content Ingestion
The connector ingests blog articles from your Shopify account. Only articles that are published or visible at the time of sync are ingested. If an article’s visibility status changes after a sync, the update is reflected in Search AI only after the next sync. The ingested document contains:- Content field - Textual content of the blog article.
- Metadata fields - Author, labels, and URL, each captured in individual fields.