Shopify Export Integration

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

You can use the Shopify Export Integration connector to export Metafield data to Shopify.

Prerequisites

• Basic knowledge of Treasure Data
• Basic knowledge of Shopify

Limitations

• Result output schema must match require columns(name & data type) with resource

Use the TD Console to Create Your Connection

Obtain Shopify Credentials

To obtain Shopify Credentials, complete the following steps:

1. Sign up at https://www.shopify.com/ to create an online store for the user.
2. Enter the details about the user.
3. Enter additional details about the business.
4. Create a custom app.
5. The user can see and use the API credentials for the store and can connect with different external applications. This API key is required to create a connection to Treasure Data.

Store Name Configuration

Shopify translates your free-form Store Name into a URL-friendly value. It truncates special characters and replaces spaces with hyphens as shown in this example:

Example Shop-123-!#$ becomes example-shop-123

You need to use the translated value (in Admin URL, after signing in):

Create a New Connection

In Treasure Data, you must create and configure the data connection, to be used during export, prior to running your query. As part of the data connection, you provide authentication to access the integration.

1. Open the TD Console.

2. Navigate to Integrations Hub >  Catalog

3. Search for Shopify Metafield. Select Create.

   

4. The following dialog opens. Complete the required fields and then select Continue.  Check Admin API access tokenin Shopify console for Password value.

   

5. Enter a name for your connection.

6. Select Done.

Configure Export Results in Your Data Connection

In this step you create or reuse a query. In the query, you configure the data connection.

You sometimes need to define the column mapping in the query.

Configure the Connection by Specifying the Parameters

1. Open the TD Console.
2. Navigate to Data Workbench > Queries.
3. Select the query that you plan to use to export data.

Each type of resource requires specific column and column data type.

4. Select Export Results located at top of your query editor. The Choose Integration dialog opens. You have two options when selecting a connection to use to export the results, using an existing connection or creating a new one.

Use an Existing Connection

1. Type the connection name in the search box to filter.

2. Select your connection. Select Next.

Create a New Shopify Connection.

1. Select Create New Integration.
2. Choose the connection Type.
3. Type a Name for your connection.
4. Enter the Store Name, Password, and API Key**.**
5. Select Next. The following dialog opens.

6. Select an Action. If the action is to Create Metafield, select the resource to be created with the metafield.
7. Select Stop on failed record if you want the job to stop when an error occurs.
8. Select Done.

(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: Configure Export Results in Workflow

Create metafield

timezone: UTC

_export:
  td:
    database: sample_datasets

+td-result-into-target:
  td>: queries/sample.sql
  result_connection: your_connections_name
  result_settings:
    apikey: {apikey}
    password: {password}
    store_name: {store_name}
    action: create
    resource: shop
    stop_on_failed_record: false

Update metafield

timezone: UTC

_export:
  td:
    database: sample_datasets

+td-result-into-target:
  td>: queries/sample.sql
  result_connection: your_connections_name
  result_settings:
    apikey: {apikey}
    password: {password}
    store_name: {store_name}
    action: update
    stop_on_failed_record: false

Click here for more information on using data connectors in workflow to export data.