Shopify Transmitter

We provide a full configured station template with the necessary datamap and jobs for the Dynamic JSON Transmitter!

---

Setup the transmitter

In the transmitter settings you need to setup the following things:

1. The URL to the Shopify Shop
2. The custom Metafield Identifier
3. The Shopify API Version
4. The Shopify Admin API Token
5. The Shopify Storefront API Token

There is no need to install importer plugins in Shopify, as the SAWSConnector seamlessly integrates with Shopify’s HTTP Web API using GraphQL.

Custom Metafield Identifier

To create the custom Metafield for the identifier in the Shopify backend, set the name as you like and copy the name with the namespace after creation.

The custom metafield identifier is used to identify the product in Shopify with a value stored in Contentserv. The metafield identifier needs to be configured in the datamap to add, update or delete products or collections. In the transmitter configuration the identifier is set with <namespace>.<key>.

Shopify Backend	Shopify Transmitter

e.g. productsUpdateCreate-Datamap

API Tokens

To use the Shopify Transmitter set the API Key for the Storefront API and the Admin API in the Contentserv credentials and select them in the transmitter settings.

First you need to generate these tokens, therefore you can follow this guideline

Shopify generate Tokens
Go to the configuration tab and select the Admin API Integration. Please select every point in the Admin Api access scope
After the access scope please select the API version e.g. 2024-07
Now that the Admin API is configured correct, go to the configuration of the Storefront API and select every point of the access scope In the Storefront API you can’t set a version for the API
With both APIs setup, click on “Install” and install the app
Important: Copy the Admin API key now and save them, because you can only reveal the admin API key once!

After configuring the tokens save them in Contentserv and select them in the Shopify Transmitter configuration.

Contentserv configuration

 

Node Mappings

Please ensure that the nodemap settings are set correctly to identify products and variants and to differentiate if the record needs to be created/updated or deleted.

Configuring the datamaps

Every datamap (except for the variant datamap) needs the custom identifier metafield. Also Shopify needs at least a title to create a resource, the other rows are optional. The last row in the datamaps is always called ‘additionalInformation’. This row is ignored by Shopify but is necessary for the connector to work. In this row the csrecordid and the csrecordclass are stored.

 

If you export products with variants you need to configure the row called ‘variants’ in the ‘productUpdateCreate’ datamap, in which an array of the skus from the variants is stored. To connect the variants correctly to the product, you need to setup the sku for the variant in the ‘variants’ datamap.

 

If you export simple products you need to configure the simple product datamap rows.

Metafields

In the datamap you always configure the metafield with the following key:

 

metafields|your-name

 

If the metafield is language dependent, you need to set |{StoreView} behind the name.

Every metafield gets configured as an array and needs the namespace, the key and its value. You can see the namespace and the key in your Shopify backend.

The value needs to be a string.

Media to upload

The media for variants and products gets uploaded via the ‘productUpdateCreate’ datamap. You can send only 1 image per variant but multiple media files per product.

To connect the media files to a variant you also need to maintain the datamap row ‘additionalInformation’.

Every media upload needs the following keys:

Note: for collections you also need to maintain the collectionInformation|image row in the datamap, otherwise the image can’t be connected to the collection.

 

 

Was this article helpful?

1 0

How can we improve this article?

Please submit the reason for your vote so that we can improve the article.

Name

Email

Submit