Skip to main content
Print

Shopify Transmitter

The Shopify Transmitter exports products, variants, collections, media, metafields, market prices, bundles and metaobject entries from Contentserv to Shopify. It talks to Shopify’s GraphQL Admin API directly: apart from your own custom app for the API access, nothing has to be installed in Shopify.

We provide a fully configured station template with the datamaps and jobs. This page covers the setup. The features are described on their own pages:

Requirements

  • A licence key for the OWL
  • The Dynamic:JSON Connector installed in your system
  • Version 1.22.0 or later for the current station template; the metaobject datamaps need 1.21.20 or later. On 1.21.19, see Shopify Datamap Template.
  • Access to the Shopify store as its owner, to create the app (see Create the Shopify app)

Versions

Many sections of the Shopify pages name the connector version they need, e.g. Available from: 1.19.14 · 1.20.5 · 1.21.0. Each number is the first version of one release line that has the feature: here 1.19.14 or later in the 1.19 line, 1.20.5 or later in the 1.20 line, and every 1.21 version. A version of a newer line has it too. Sections without such a line work in every version of the Shopify Transmitter.

The installed version is shown on the SAWSConnector start page, top left next to the SAWS logo: Base Connector and one line per connector.

Import the station template

Open SAWSConnector > Stations > Add / edit stations.

  1. Select the Dynamic:JSON connector.
Selecting the Dynamic:JSON connector
  1. Click Create new station from template.
Creating a new station from a template
  1. In the file selection, open Owl Cloud Templates (log in to OWL if it asks), select Shopify – Station V2 and click OK. The import starts right away. Shopify – Station is the previous template.
Selecting Shopify - Station V2 in the Owl Cloud Templates

The station then contains:

  • the Shopify transmitter
  • the datamap Shopify Products, Variants, Collections V2 for products, variants and collections, and for deleting them
  • the datamap Shopify Metaobject Entries V2 for metaobject entries
  • both datamaps once more with legacy rows: the rows of earlier templates, deactivated (see Shopify Datamap Template)
  • the jobs for collections, products, metaobject entries and deleted products

Every datamap row has a note with what it does, what Shopify expects and what to look out for. See Shopify Datamap Template.

Create the Shopify app

The transmitter logs in with the Client ID and the Secret of a custom app in your store. The app is created in Shopify’s Developer Dashboard.

Available from: 1.20.17 · 1.21.0

Important: the app must be created by the store owner, in the store’s own organisation. Otherwise the credentials don’t work in your store, and Shopify answers with HTTP 400:

Oauth error shop_not_permitted: Client credentials cannot be performed on this shop.

To check that the Developer Dashboard is open in the right organisation, look at the organisation switcher top right:

Organisation switcher in the Developer Dashboard with the available stores

Create and install the app

  1. Open the Developer Dashboard. Depending on your Shopify version, either via Settings > Apps > Develop apps > Build apps in Dev Dashboard, or via the account menu top right: View Dev Dashboard.
Develop apps in the Shopify admin
View Dev Dashboard in the account menu
  1. Create an app with the Create app button, give it a name and click Create.
App list in the Developer Dashboard with the Create app button
Naming the new app
  1. Select the access scopes. The app needs all scopes of the Admin API and of the Storefront API. Click Select from list next to Scopes.
Select from list next to the Scopes field

In the list, choose Admin API at the top left (1) and tick every scope (2):

All Admin API scopes ticked

Then choose Storefront API (1), tick every scope there too (2), and click Done (3):

All Storefront API scopes ticked, then Done
  1. Release the app. Click Release; a version name is optional.
Released version of the app
  1. Choose the distribution. On the app’s Home, select the distribution method Custom distribution, so the app is not offered in the Shopify App Store.
  2. Enter your store domain (from your store’s dashboard) and click Generate link. The app can then only be installed in your store.
Distribution settings of the app
Store domain and generated install link
  1. Install the app. Open the generated link in a new tab, select your store if you have several, and click Install. The app then appears in your store’s left navigation.
The installed app in the Shopify admin
  1. Copy the Client ID and the Secret. The Developer Dashboard now shows one installation of the app (refresh the page if not). Under Settings you find the Client ID and the Secret.
The app with one installation
Client ID and Secret of the app

Connect Contentserv with the store

Store the Secret as a credential in Contentserv:

The app secret stored as a credential in Contentserv

Then create an HTTP connection of the type Shopify HTTP with:

  • Base URL (1): the URL of the shop, https://<your-shop>.myshopify.com
  • Grant Type: Client Credentials
  • Client ID (2): the app’s Client ID
  • Client Secret (3): the credential with the Secret
HTTP connection of the type Shopify HTTP

Available from: 1.22.0. Before 1.22, the shop URL, Client ID and App Secret are fields of the transmitter itself. When you update to 1.22, the module update moves them into a connection and selects it in the transmitter.

Important:

  • Use the myshopify domain. With an admin.shopify.com/store/… address no token can be obtained, and the job fails with “Failed to obtain access token”.
  • Do not change the shop URL once products are in Shopify while the station cache is used: the cache is tied to the URL, and the products would be created a second time.
  • The (Deprecated) Shopify Storefront API Token is only needed for the DSA data import, not for the export.

Set up the transmitter

Settings of the Shopify transmitter
SettingWhat to enter
(1) HTTP ConnectionThe Shopify HTTP connection from above.
(2) Shopify Custom Metafeld IdThe metafield that holds the PIM identifier, as namespace.key, e.g. custom.pimid. See PIM identifier metafield below.
(3) Shopify API VersionThe Admin API version, e.g. 2026-04. From 1.22 you can leave it empty: the transmitter then uses the latest version it was tested with.
(4) Seconds until a new request is triggered when data is missing
Maximum number of times missing data will be re-requested
For data Shopify has not finished processing yet, e.g. uploaded media. Higher values make the export slower. Keep both at 0 for the defaults.
(5) Save return IDs of the respective Shopify entities in the attributesOne row per entity (Products, Collections) with the Contentserv attribute that receives the Shopify ID. See Shopify IDs in Contentserv below.

Important: Shopify supports each API version for at least a year, then serves the next one instead. Use a current version. The job log warns when Shopify serves a different version than the one configured (from 1.21.19) and when a request uses fields Shopify has deprecated (from 1.22.0).

Station cache

With Use Station Cache in the station settings, the transmitter keeps the Shopify IDs of products, collections and media files, so it does not have to load them from Shopify on every run. The cache entries are shown in the station; deleting them, or switching the cache off, empties the cache.

Use Station Cache in the station settings

Available from: 1.21.0 (station cache). In 1.20 (from 1.20.4) the same is the checkbox “Use Proxy-Cache for Product Ids” in the transmitter.

Important: if records were changed or deleted in Shopify by hand, empty the cache before the next export.

PIM identifier metafield

The transmitter finds products and collections in Shopify by a metafield that holds their Contentserv ID. Create this metafield definition in Shopify for products and for collections (Settings > Custom data), type Single line text, with any name. We recommend custom.pimid.

Metafield definition custom.pimid for products
Metafield definition custom.pimid for collections

Enter it as namespace.key in the transmitter setting Shopify Custom Metafeld Id. The first row of the product, collection and delete datamaps sends it with the same key:

The datamap row custom.pimid

Important:

  • Without the definition, Shopify answers “Type can’t be blank”.
  • Do not change the key or the values once products are in Shopify. The transmitter would no longer find them and would create them again.

Languages

Set up the languages in the datamap’s language table:

StoreViewLanguageChannel
defaultthe shop’s primary languageyour sales channel
enEnglishyour sales channel
Language table of the datamap

default is always the shop’s primary language. For every further language, the StoreView is the Shopify language code (en, fr, de-CH, …); its values are sent as translations of products, options, metafields, collections and metaobject entries.

Important:

  • The template exports nothing until the language table is filled: rows without a language are ignored, and without any row the job stops.
  • Do not add a row for the primary language’s own code.
  • Add and publish the languages in Shopify (Settings > Languages).
Published languages in Shopify

Sales channel and node mappings

The template reads the records through a SAWSConnector sales channel:

  • Link the simple products and the variant heads to the sales channel, with the structure groups (collections) they belong to.
  • Do not link the variants. They come with their head through the complex article table.

The node mappings route the records: products in the sales channel go to the products datamap, variants (records without their own channel entry) to the variants datamap, and structure groups to the collections datamap.

Node mappings of the Shopify datamap

The node conditions in the screenshot:

  1. productsUpdateCreate: records with a sales channel entry
  2. variants: records without a sales channel entry of their own
  3. productsDelete: the records of the delete job
  4. collectionsUpdateCreate and collectionsDelete: structure groups only. Nodes that link a product into a group (PdmarticleID greater than 0) are skipped. The demo in the screenshot also checks a record-class attribute; the template checks PdmarticleID only.

Important:

  • Products are only exported when they are assigned to a structure group in the sales channel.
  • A variant with its own sales channel entry is exported as a product of its own.
  • Structure groups that contain products also show these products as nodes. The node condition of the collections datamap skips them; keep it, or every product becomes a collection.

Jobs

Jobs of the Shopify station

On an empty shop, run the jobs in this order:

  1. Metaobject entries, if you use linked options or metaobject references (see Shopify Metaobject Entries).
  2. Collections: products can only be added to existing collections.
  3. Products, twice: references to products, collections in the product’s list and bundle components that were created in the same run are found in the second run.

Deleting:

  • Products are deleted by the job for deleted products (4), with the node mapping productsDelete.
  • Collections: the datamap collectionsDelete reads the same data as the collection export, so it is deactivated. For a delete run, activate it and deactivate collectionsUpdateCreate, run the collections job, then switch both back.

Important: the transmitter only deletes what it created: products and collections with the PIM identifier metafield. Files uploaded to Shopify stay under Content > Files.

Shopify IDs in Contentserv

With the transmitter setting Save return IDs of the respective Shopify entities in the attributes, a Contentserv attribute receives the Shopify ID of each exported product and collection. Variants get their ID in the same attribute when the variants datamap sends additionalInformation, as the template does. When a product is deleted in Shopify, its ID and its variants’ IDs are cleared.

Available from: 1.19.6 · 1.20.0; variants from 1.19.8 · 1.20.0; cleared after deleting from 1.21.19

The template uses these IDs to send some values only when a product is created, e.g. the initial stock and the gift card flag.

(Deprecated) API tokens

Since 1 January 2026, Shopify no longer lets you create custom apps in the store admin. Existing apps of this kind keep working with their Admin API token: in the connection, select the Grant Type (Deprecated) Shopify Admin API Token and enter the token (before 1.22: the token field of the transmitter). New setups use an app from the Developer Dashboard, as described above.

Was this article helpful?
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.
Table of Contents