Copy data from Shopify using Azure Data Factory or Synapse Analytics (Preview)

APPLIES TO: Azure Data Factory Azure Synapse Analytics

This article outlines how to use the Copy Activity in an Azure Data Factory or Synapse Analytics pipeline to copy data from Shopify. It builds on the copy activity overview article that presents a general overview of copy activity.

Supported capabilities

This Shopify connector is supported for the following capabilities:

① Azure integration runtime ② Self-hosted integration runtime

For a list of data stores that are supported as sources/sinks, see the Supported data stores table.

The service provides a built-in driver to enable connectivity, therefore you don't need to manually install any driver using this connector.

The connector supports the Windows versions in this article.

The billing_on column property was removed from the Recurring_Application_Charges and UsageCharge tables due to Shopify's official deprecation of billing_on field.

Getting started

To perform the Copy activity with a pipeline, you can use one of the following tools or SDKs:

• The Copy Data tool
• The Azure portal
• The .NET SDK
• The Python SDK
• Azure PowerShell
• The REST API
• The Azure Resource Manager template

Create a linked service to Shopify using UI

Use the following steps to create a linked service to Shopify in the Azure portal UI.

1. Browse to the Manage tab in your Azure Data Factory or Synapse workspace and select Linked Services, then click New:

   • Azure Data Factory
   • Azure Synapse

   

2. Search for Shopify and select the Shopify connector.

   

3. Configure the service details, test the connection, and create the new linked service.

   

Connector configuration details

The following sections provide details about properties that are used to define Data Factory entities specific to Shopify connector.

Linked service properties

The Shopify connector now supports version 2.0 (Preview). Refer to this section to upgrade your Shopify connector version from version 1.0. For the property details, see the corresponding sections.

• Version 2.0 (Preview)
• Version 1.0

Version 2.0 (Preview)

The Shopify linked service supports the following properties when apply version 2.0 (Preview):

Example:

{
    "name": "ShopifyLinkedService",
    "properties": {
        "type": "Shopify",
        "version": "2.0",
        "typeProperties": {
            "host" : "mystore.myshopify.com",
            "accessToken": {
                 "type": "SecureString",
                 "value": "<accessToken>"
            }
        }
    }
}

Version 1.0

The Shopify linked service supports the following properties when apply version 1.0:

Example:

{
    "name": "ShopifyLinkedService",
    "properties": {
        "type": "Shopify",
        "typeProperties": {
            "host" : "mystore.myshopify.com",
            "accessToken": {
                 "type": "SecureString",
                 "value": "<accessToken>"
            }
        }
    }
}

Dataset properties

For a full list of sections and properties available for defining datasets, see the datasets article. This section provides a list of properties supported by Shopify dataset.

To copy data from Shopify, set the type property of the dataset to ShopifyObject. The following properties are supported:

Example

{
    "name": "ShopifyDataset",
    "properties": {
        "type": "ShopifyObject",
        "typeProperties": {},
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<Shopify linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

Copy activity properties

For a full list of sections and properties available for defining activities, see the Pipelines article. This section provides a list of properties supported by Shopify source.

Shopify as source

To copy data from Shopify, set the source type in the copy activity to ShopifySource. The following properties are supported in the copy activity source section:

Example:

"activities":[
    {
        "name": "CopyFromShopify",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Shopify input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "ShopifySource",
                "query": "SELECT * FROM \"Products\" WHERE Product_Id = '123'"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Data type mapping for Shopify

When you copy data from Shopify, the following mappings apply from Shopify's data types to the internal data types used by the service. To learn about how the copy activity maps the source schema and data type to the sink, see Schema and data type mappings.

Lookup activity properties

To learn details about the properties, check Lookup activity.

Shopify connector lifecycle and upgrade

The following table shows the release stage and change logs for different versions of the Shopify connector:

Upgrade the Shopify connector from version 1.0 to version 2.0 (Preview)

1. In Edit linked service page, select 2.0 (Preview) for version. For more information, see linked service version 2.0 (Preview) properties.
2. For version 2.0 (Preview), note that column names retain the Shopify GraphQL structure, such as data.customers.edges.node.xx. For version 1.0, column names use simplified names.
3. query is only supported in version 1.0. You should use the tableName instead of query in version 2.0 (Preview).

Related content

For a list of data stores supported as sources and sinks by the copy activity, see supported data stores.