Guide for Akeneo Shopify App

Akeneo Shopify App allows you to integrate your Shopify store with the Akeneo PIM platform.

Using the Akeneo Shopify App, you can add and update products, collections, and variants from Akeneo to Shopify.

Export various product details such as title, description, multiple images, SEO information, SKU, barcode, price, comparison at price, quantity, weight, etc.

Also, the Akeneo Icecat App helps to import Icecat catalog content from Icecat to the Akeneo app.

• Export Akeneo Categories as Shopify Collections.
• Export Akeneo Products to Shopify.
• Export Product with 1 level of variation.
• Export Product with 2 levels of variation.
• Export Product Images.
• Can export Inventory quantity, SEO data, and Sale price along with Product Data.
• Can Use fixed values for some fields when Exporting data.
• Filter data to be Export based on status, family, Completeness, Time conditions, Identifier(SKU), Language, and Currency.
• Support Added for configuring multiple Shopify stores.
• Support Added For Manual Mapping for multiple credentials.
• Support Provided for Shopify API 2023-01, 2023-04, 2023-07, 2023-10
• Multi-locale for product export.
• Better mapping UI with select attribute instead of filling code.
• can map multiple fields in a tag.
• Functionality Added for the export metric unit with tag.
• Can map concatenate attributes for export.
• Can map group code in mapping.
• Export Weight Unit.
• Can map inventory policy, backorder (order when out of stock).
• Export associations to use as metafields.
• Can map more standard attributes in import mapping.
• Can Import Smart Collection as Collection.
• Individual jobs add for every entity in import (Category, Attribute, family, product, product model).
• Link the first variant image with a variant to show on the Shopify Store.
• Import Collections from Shopify to Akeneo as Categories.
• Import Variations Attributes Like Size, Color, and Material from Shopify.
• Import Variations Attributes Options.
• Import Family Variation according to Shopify Product Variations.
• Import Product Model.
• Import Product.
• Asset Export(Will work only with the Akeneo EE Edition).

After you have searched for the Akeneo Shopify App in your Akeneo App store, tap the connect button.

After tapping the Connect button, on the page that appears tap the Allow and Next button to proceed further.

Now, agree to the app’s privacy policy and terms and conditions and tap the Allow and Next button.

Thereafter, provide the access permissions to the category trees including – Catgeory, Locale, Attribute Group, and others, and then tap the Next button after that.

Note: These app permissions appear in the case of the Akeneo EE edition users only.

Now, confirm the access and tap the Confirm button.

After the permissions section, the app will be connected, and on the module page, you can see the notification for a 7-day trial period.

Now, the user can see the Akeno Shopify app connected and to open it tap the Open App button.

Akeneo App Flow Management:

To manage the Akeneo Shopify App, tap the Manage App button.

Here, for the flow type you need to select the Other type.

Note: You must select the Data Source flow type in the Growth, Flexibility, and Serenity editions.

After opening the Akeneo Shopify App, you will be redirected to the plan purchase page, as shown below.

After that, the user is redirected to PayPal to make the payment for the plan.

Now, after the successful payment, the user is redirected to the plan page with the activated plan for use.

Moreover, now you can configure the Shopify credentials within the Akeneo Shopify App.

Here, you can see the billing details, billing cycle, and the next due date for the plan payment.

Log in to your Shopify Store account and then navigate to the Settings option in the left-hand bottom corner.

After that, navigate to the Apps and Sales Channels side panel menu option.

This brings up the section where you need to tap the Develop Apps button on the top right-hand corner.

Now, tap the Create an App button.

After that, enter the app name and tap the Create App button.

Thereafter, go to the API credentials section and tap the Configure Admin API scopes button.

Now, you have to provide API access scopes. Provide access to “read and write” checks for the following scope categories:

– Shop locales
– Fulfillment services
– Inventory
– Product listings
– Products
– Translation

After that, save the same.

Thereafter, we will get the Install app option.

Now, tap the install button.

Lastly, under API credentials you will get the API Access Token to use to configure the Akeneo Shopify App.

In the Akeneo backend, navigate to the connected apps section and open the Akeneo Shopify App by tapping the Open App button.

This brings up the below section of the Akeneo Shopify App. Here, navigate to the Shopify->Credentials.

Now, tap the Create Credentials button on the top right-hand corner.

Note: You can add only the allowed number of Shopify accounts in the app depending upon your purchased plan.

Now enter the Shopify store URL and the access token, select the Shopify API version, and then tap the Save button to save the Shopify account.

GraphQL Translation Mapping:

To check the Graphql Translation Mapping click on the edit credential. After saving the Shopify credential, All the Shopify locales fetch automatically.

If you add any new locale at the Shopify end then you will fetch that locale by clicking on the Validate fetch Button, you can get all of the published locales.

You can sync detailed information about the products from Akeneo to Shopify. But first, you need to do the mapping of Akeneo attributes with Shopify product fields.

After that please go to the Export Attributes Mapping tab. On the left, you will find all the product fields that can be synchronized with Akeneo attributes.

Then in the middle, you need to select the attribute of Akeneo which will be mapped with the Shopify product fields.

The following attributes can be mapped:

• Name
• Description
• Price
• Stock Quantity
• Vendor
• URL and handle
• Taxable (1/0)
• Fulfillment Service
• Weight

Note – To create a single value, click on the check box and concatenate the values of many attributes.

Use This Fixed Value – If you want to use any definite (same) value for the attribute, you can enter it on the right.

Please note, that all the exported products will be using this mentioned attribute value.

For eg, If you want the weight of all the exported products to be 1, then you need to deselect the Akeneo attribute in the middle and enter 1 as the fixed value on the right. Now, all the exported products’ weights will be shown as 1 in Shopify.

Map Existing Categories/Products of Shopify with Akeneo

If you already have products and categories in your Shopify setup, please map them to Akeneo to avoid creating duplicate records first go to Shopify->Export Mappings->Manual Mapping.

After that click the Create Mapping button to create a new mapping for a category, or product.

Select Mapping Type as – Category or Product as required.

Then, select the Shopify store URL, Shopify Category, and Akeneo category values accordingly and after that click Save.

Image Mapping – Provide the attributes created as image type that you want to export to your Shopify store.

Asset Mapping:

Here, the Akeneo admin can map only the image assets that are to be exported to Shopify.

Association Mapping  – Associations like Cross-Sell, Upsell, Substitution, etc can be mapped in meta fields as shown in the image.

Note – To make this field available, first map the “URL and handle” attribute mapping under standard attribute mapping.

After product export, the associations/metafields are exported to Shopify.

NOTE – You must install the Metafields Guru App to use MetaFields.

In the Import Attributes Mapping section, you need to configure some settings so that import functionality works properly –

Map More Attributes – 

If your products have lots of information, you can enter Shopify attribute code ID and then click Add Field. Akeneo Shopify App supports various attributes of Shopify products.

Please make sure to use the same attribute code as Shopify in Akeneo.

Shopify Other Mappings:

Set Family (for simple products) –  From this option, you need to select an Akeneo family for imported products. All the simple products imported from the Shopify stores will come under this family.

Set Attribute Group – All the imported attributes from Shopify will be mapped in the selected attribute group.

Set Common Images – From here, you need to select the Akeneo image attributes which will be the common images for the product model.

This option is meant for Shopify imported products with variants. Make sure you have created the required attributes in Akeneo already.

Set Variant Image – From here, you need to select an Akeneo image attribute which will be mapped with Shopify’s imported product variant’s image.

Import Smart Collection as Collection – With this you can Import a collection in Akeneo with a smart collection.

*Therefore A smart collection is a grouping of products established by the merchant’s rules. Based on the rules, Shopify adjusts the contents of a smart collection.

Tags Export Setting –

These tags will be exported from Akeneo to Shopify. There will be three types to export the tag –

You want to pull tags as Named Tags – If you want to include the attribute name in the tag if you enable this option.

As seen in the referenced image, attributes, and attribute values are displayed in a named tag format.

Do you want to pull through the attribute name as well in tags – In this, you can export the name and tags both the name and tags will be separated by a dash, colon, or space.

Do you want to pull through the Metric UNIT name as well in tags – In this, you can export metric value when you enable this, the unit will also be exported as well.

Other Settings –

Remove Extra fractional Zeros of Metric Attribute Value – If you will enable this feature then the extra zeros of metric attribute value will be removed

Value for Option Name as Attribute Label – Enable this option to export the variant axis as label or code (for Product Model) as shown in the below image.

Meta-field definitions allow you to create and export meta-field definitions from Akeneo to the Shopify platform.

They act as a template that defines which parts of your store a certain meta field applies to as well as the possible values for that meta field.

These akeneo attributes support the following metafield definition types:-
1. Text (Single line text, Color, Rating and URL)
2. Simple select (Single line text)
3. Yes/No (True or False)
4. Measurement (Volume, Weight and Dimension)
5. Text Area (Multi-line text and JSON)
6. Multi select (Multi-line text)
7. Date (Date)
8. Number (Interger and Decimal)

Add Metafield Definitions: You can navigate through Shopify->Metafield Definition. This lists all of the created ones if any. For the first time, this section will be empty.

To add a metafield definition tap on the Add Definition button and that brings up the below section.

Here, to create the Metafields you have to –

• Choose the Metafield Definition Type as – Products or Variants.
• Choose the Akeneo Attribute Type and the content type for the selected attribute will be displayed, select it.

• Provide the name space and key, this should kept minimal. Your meta field unique identifier is creates by the namespace and key worked together in this.
  
  The only characters allow are letters, numerals, underscores (_), and hyphens (-); they are separat by a comma.
  
• Enter the description for the metafield – Information about the values to be entered in the meta field should be provided.

• Enter the minimum length.
• Set the maximum Length.

Lastly, Save the Metafield definition.

The created ones appear as shown below.

Export Metafield Definitions:

Now, to export your metafield definition data you need to create a job profile and then execute it. First, go to Exports>Create Export Profile.

After that enter a unique code, and label, and select a job profile.

Export Job:

First, you need to export the definition to Shopify. Once you will add the details you need to click on the Save button.

Wait for the execution process to complete then check the errors.

After the completion of the export job, the meta fields definition will appear on Shopify.

When all of the meta field definitions export, go to Settings>>Metafileds>>Product to view the list.

After clicking, the product of all the exported metafields definitions will be visible here.

Variants in Shopify:

Go to Settings>>Metafileds>>Variants to view the list.

Meta fields Product:
Now, you need to export meta fields product create an export profile, filter the data then click on the Save button:

Note: You must export the product and product model in Shopify first before exporting the meta field definitions product in Shopify.

Wait for the execution process to complete then check the errors.

After the completion of the export job, the meta fields products will appear on Shopify.

Meta fields Product in Shopify:

Once all the value has been exported to Shopify, you may check the meta field product value in your products.

Once all the variant value has been exported to Shopify, you may check the meta field variant value in your product model.

To export your product data, you need to create a job profile. First, go to Exports->Create Export Profile.

After that enter a unique code, and label then select Shopify Export Job.

Credentials for Multi-Store

If you have multiple stores in Shopify, you can enter the store credentials here by going to the Credential section for the created export job.

Note: Depending upon your plan, only the allow number of Shopify stores can be add, the same will be visible for selection(the Shopify store that you have added).

After saving the export profile, go to the Content section and select Locale and Scope for the exported products.

Also, you can decide which products you want to export and filter them using various options.

Execution Process

Once you have filtered the products and saved your export job profile, click the Export Now button.

After the completion of the execution process, you can see the number of products exported from Akeneo to Shopify, and also see the status as completed.

View Products on Shopify

After that, you can see the products have been created using the Shopify Akeneo App mentioning all the product details.

Then you can edit and update any product information as you like.

All the variation information will also appear mentioning inventory, price, SKU. SEO information can also be seen here.

Shopify Storefront

Once the export job is complete, the products will appear on the storefront. The customer will see the name, price, images, and description on the product page.

You can also explore our Akeneo Development Services and Quality Akeneo Extensions.

For importing product data from Shopify to Akeneo, go to Imports>Create Import Profile.

There are Category, Attribute and attribute options, family, product, and product model types of import jobs in the connector.

Now, enter a code, label, and select Job as Shopify Import All.

Then go to Content and select the appropriate Scope, locale, and currency for importing Shopify products to Akeneo PIM.

In case you are managing multiple Shopify stores, you can select the store credential from the drop-down, and click Save.

Note: Depending upon your plan, only the allow number of Shopify stores can be add, the same will be visible for selection(After you have added the Shopify stores).

After that, click the Import Now button to execute the import process.

The import job will run to import the products from Shopify to Akeneo.

So, that was much about the User Guide Akeneo Shopify App for any queries or doubts reach out to us at [email protected]. You can also raise a ticket at our HelpDesk System.