Shopify Export Integration V2

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

The Shopify Export Connector V2 is designed to create and update metafields for various Shopify resources using Shopify's GraphQL Admin API. By leveraging the more efficient and flexible GraphQL API, this version of the connector represents a significant upgrade from V1 which used REST API endpoints.

Key capabilities

• GraphQL API integration for improved performance and flexibility
• Support for creating and updating metafields across multiple resource types
• Batch processing capabilities
• Comprehensive error handling and validation
• Rate limiting compliance with Shopify's API guidelines

Supported Resource Types

The connector supports metafield operations for the following Shopify resources:

• Product
• MediaImage (replaces Product Image from V1)
• ProductVariant
• Collection
• Blog
• Page
• DraftOrder
• Customer
• Article
• Shop

Prerequisites

• Basic knowledge of Treasure Data, including the TD Toolbelt.
• Basic knowledge of Shopify .

Limitations & Known Issues

• MediaImage vs Product Image—A significant change from V1 to V2 is the handling of image-related metafields:
  • Whereas V1 used Product Image IDs for creating/updating metafields on product images, V2 requires MediaImage IDs.
  • MediaImage is a more versatile resource type that can reference various media types (not just product images).
  • Existing metafields created with Product Image IDs in V1 will need to be migrated to use MediaImage IDs
• Metafield keys must be 3-64 characters long
• Namespace must be 3-255 characters long

Static IP Address of Treasure Data Integration

If your security policy requires IP whitelisting, you must add Treasure Data's IP addresses to your allowlist to ensure a successful connection.

Please find the complete list of static IP addresses, organized by region, at the following link:
https://api-docs.treasuredata.com/en/overview/ip-addresses-integrations-result-workers/

Use the TD Console

Create Authentication

Your first step is to create a new authentication with a set of credentials.

1. Select Integrations Hub.
2. Select Catalog.

3. Search for your Shopify in the Catalog; hover your mouse over the icon and select Create Authentication.

4. Ensure that the Credentials tab is selected and then enter credential information for the integration.

New Authentication Fields

1. Select Continue.
2. Enter a name for your authentication, and then select Done.

Configure a Query Result for Export

The TD Console supports multiple ways to export data. Please follow these steps to export data from the Data Workbench.

1. Navigate to Data Workbench > Queries.
2. Select New Query, and define your query.
3. Select Export Results to configure the data exporting.
4. Select an existing Shopify CAPI authentication or create a new one described previously.
5. Configure the Export Results

6. Select Done.

Detailed Guide for Create Metafield Action

For creating metafields in Shopify, you need to build a data export query that includes the necessary fields that adhere to Shopify’s guidelines. For default fields, ensure that the column names match those listed in the “Field/Column-Level Specifications” section. The connector automatically normalizes the column names to match Shopify’s required format, so you don’t need to worry about case sensitivity. For example, if a field name is “resource_id”, you can write it as “RESOURCE_ID”, “Resource_Id”, or “resource_id”, and the connector will standardize it to match Shopify’s requirements.

Export Query Specifications

Field/Column-Level Specifications

Default Field Columns

Automatic Type Detection

When you don’t include a type column in your query result, the connector automatically determines the metafield type based on the data type of your value column:

Value Specifications by Type

Basic Types

Reference Types

List Types

List types support arrays of basic types and reference types. List types are prefixed with list., and all list types support their base type’s validation rules applied to each array element. The examples below show common list types.

Note:

Detailed Guide for Update Metafield Actions

To update existing metafields in Shopify, you need to build a data export query that includes the necessary fields. The connector automatically handles the data validation and formatting requirements for each field.

Export Query Specifications

Required Columns

Optional Columns

These fields are not required for updates but can be included for validation purposes:

(Optional) Schedule Query Export Jobs

You can use Scheduled Jobs with Result Export to periodically write the output result to a target destination that you specify.

Treasure Data's scheduler feature supports periodic query execution to achieve high availability.

When two specifications provide conflicting schedule specifications, the specification requesting to execute more often is followed while the other schedule specification is ignored.

For example, if the cron schedule is '0 0 1 * 1', then the 'day of month' specification and 'day of week' are discordant because the former specification requires it to run every first day of each month at midnight (00:00), while the latter specification requires it to run every Monday at midnight (00:00). The latter specification is followed.

Scheduling your Job Using TD Console

1. Navigate to Data Workbench > Queries

2. Create a new query or select an existing query.

3. Next to Schedule, select None.

4. In the drop-down, select one of the following schedule options:

   Drop-down Value	Description
   Custom cron...	Review Custom cron... details.
   @daily (midnight)	Run once a day at midnight (00:00 am) in the specified time zone.
   @hourly (:00)	Run every hour at 00 minutes.
   None	No schedule.

Custom cron... Details

 *    *    *    *    *
 -    -    -    -    -
 |    |    |    |    |
 |    |    |    |    +----- day of week (0 - 6) (Sunday=0)
 |    |    |    +---------- month (1 - 12)
 |    |    +--------------- day of month (1 - 31)
 |    +-------------------- hour (0 - 23)
 +------------------------- min (0 - 59)

The following named entries can be used:

• Day of Week: sun, mon, tue, wed, thu, fri, sat.
• Month: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.

A single space is required between each field. The values for each field can be composed of:

1. (Optional) You can delay the start time of a query by enabling the Delay execution.

Execute the Query

Save the query with a name and run, or just run the query. Upon successful completion of the query, the query result is automatically exported to the specified destination.

(Optional) You can delay the start time of a query by enabling the Delay execution.

Activate a Segment in Audience Studio

You can also send segment data to the target platform by creating an activation in the Audience Studio.

1. Navigate to Audience Studio.
2. Select a parent segment.
3. Open the target segment, right-mouse click, and then select Create Activation.
4. In the Details panel, enter an Activation name and configure the activation according to the previous section on Configuration Parameters.
5. Customize the activation output in the Output Mapping panel.

• Attribute Columns
  • Select Export All Columns to export all columns without making any changes.
  • Select + Add Columns to add specific columns for the export. The Output Column Name pre-populates with the same Source column name. You can update the Output Column Name. Continue to select + Add Columnsto add new columns for your activation output.
• String Builder
  • + Add string to create strings for export. Select from the following values:
    • String: Choose any value; use text to create a custom value.
    • Timestamp: The date and time of the export.
    • Segment Id: The segment ID number.
    • Segment Name: The segment name.
    • Audience Id: The parent segment number.

6. Set a Schedule.

• Select the values to define your schedule and optionally include email notifications.

7. Select Create.

(Optional) Export Integration Using the CLI

You can also use CLI (Toolbelt) to export results to Shopify by specifying the information you want to export to your Shopify server using the --result option of the td query command. For more information about the td query command, refer to TD Toolbelt: Query Commands.

Options for the .yml configuration files used for TD Toolbelt are formatted in JSON, and the general structure is as follows.

• For create metafields

out:
  type: 'shopify_v2'
  admin_api_access_token: {admin_api_access_token}
  store_name: {store_name}
  action: 'create'
  resource: 'product'
  stop_on_failed_record: false

• For update metafields

out:
  type: 'shopify_v2'
  admin_api_access_token: {admin_api_access_token}
  store_name: {store_name}
  action: 'update'
  stop_on_failed_record: false

Parameters

CLI Usage Example

Create Metafields

td query --result '{"type":"shopify_v2","admin_api_access_token":"admin_api_access_token","store_name":"store_name","action":"create,"resource":"shop", "stop_on_failed_record":true}' -d sample_database "select shop_id,key,namespace,value from tbl_shop" -T presto

Update Metafields

td query --result '{"type":"shopify_v2","admin_api_access_token":"admin_api_access_token","store_name":"store_name","action":"update, "stop_on_failed_record":true}'  -d sample_database "select metafield_id,value from tbl_metafield" -T presto

See Also

• The Result Export can be scheduled to periodically upload data to a target destination. See Scheduling Jobs Using TD Console.
• All import and export integrations can be added to a TD Workflow. The td>: data operator can export a query result to a specified integration. For more information, see Reference for Treasure Workflow Operators.