Shopify Streaming

Adobe Experience Platform provides support for ingesting data from streaming applications. Support for streaming providers include Shopify.

Prerequisites prerequisites

The following section outlines prerequisite steps to complete before using the Shopify Streaming source.

You must have a valid Shopify partner account in order to connect to the Shopify APIs. If you do not already have a partner account, please register using the Shopify partners dashboard.

Create your application

With a valid Shopify partner account, you can now proceed and create your app using the partners dashboard. For comprehensive steps on how to create your app in Shopify, read the Shopify guide on getting started.

Once your app is created, retrieve your client ID and client secret from the client credentials tab of the Shopify partners dashboard. The client ID and client secret will be used in the next steps to retrieve your authorization code and access token.

Retrieve your authorization code

Next, retrieve your authorization code by entering your domain’s myshopify.com URL into your browser, along with query strings that define your API key, scopes, and the redirect URI.

The format for this URL is as follows:

API format

https://{SHOP}.myshopify.com/admin/oauth/authorize?client_id={API_KEY}&scope={SCOPES}&redirect_uri={REDIRECT_URI}

Request

https://connnectors-test.myshopify.com/admin/oauth/authorize?client_id=l6fiviermmzpram5i1spfub99shms3j9&scope=write_orders,read_customers&redirect_uri=https://acme.com

Response

A successful response returns your redirect URL, including the authorization code required to generate your access token.

https://www.acme.com/?code=k6j2palgrbljja228ou8c20fmn7w41gz&hmac=68c9163f772eecbc8848c90f695bca0460899c125af897a6d2b0ebbd59d3a43b&shop=connnectors-test.myshopify.com&state=123456×tamp=1658305460

Retrieve your access token

Now that you have your client ID, client secret, and authorization code, you can retrieve your access token. To retrieve your access token, make a POST request to your domain’s myshopify.com URL while appending this URL with Shopify’s API endpoint: /admin/oauth/access_token.

API format

POST /{SHOP}.myshopify.com/admin/oauth/access_token

Request

The following request generates an access token for your Shopify instance.

curl -X POST \
  'https://connnectors-test.myshopify.com/admin/oauth/access_token' \
  -H 'developer-token: {DEVELOPER_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'Cookie: _master_udr=xxx; request_method=POST'
  -d '{
    "client_id": "l6fiviermmzpram5i1spfub99shms3j9",
    "client_secret": "dajn3caxz9s7ti624ncyv_m4f60jnwi3ii3y3k",
    "code": "k6j2palgrbljja228ou8c20fmn7w41gz"
}'

Response

A successful response returns your access token and permission scopes.

{
  "access_token": "shpca_wjhifwfc91psjtldysxd6rqli371tx54",
  "scope": "write_orders,read_customers"
}

Create a webhook for streaming Shopify data webhook

Webhooks allow applications to stay synchronized with your Shopify data or perform an action after a particular event occurs in a shop. For streaming Shopify data to Experience Platform, webhooks can be used to define the http endpoint and the topics for subscription.

Request

The following request creates a webhook for your Shopify Streaming data.

curl -X POST \
  'https://connnectors-test.myshopify.com/admin/api/2022-07/webhooks.json' \
  -H 'X-Shopify-Access-Token: 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' \
  -H 'Content-Type: application/json' \; request_method=POST' \
  -d '{
  "webhook": {
    "address": "https://dcs.adobedc.net/collection/9d411a24aa3c0a3eded92bac6c64d0da986ee7a8212f87168c5fb42d9ddc3227",
    "topic": "orders/create",
    "format": "json"
  }
}'

Response

A successful response returns information on your webhook, including its corresponding id, address, and other metadata information.

{
  "webhook": {
    "id": 1091138715786,
    "address": "https://dcs.adobedc.net/collection/9d411a24aa3c0a3eded92bac6c64d0da986ee7a8212f87168c5fb42d9ddc3227",
    "topic": "orders/create",
    "created_at": "2022-07-20T07:15:23-04:00",
    "updated_at": "2022-07-20T07:15:23-04:00",
    "format": "json",
    "fields": [],
    "metafield_namespaces": [],
    "api_version": "2021-10",
    "private_metafield_namespaces": []
  }
}

Limitations limitations

The following is a list of known limitations that you may encounter when using webhooks with the Shopify Streaming source.

Next steps

The following tutorials provide steps on how to connect your Shopify Streaming source to Experience Platform using the API and the UI: