Skip to main content

📦 Shopify

After this guide, you will have sale conversion tracking up and running for your Shopify store.

To make yourself familiar with Linkster tracking, it is recommended that you read through the introduction and overview to tracking methods first.

caution

The user tracking container must be installed first before you can start using this integration.

The Shopify integration works by installing a custom app in your store, which enables Linkster to access sales data.

Creating a custom app​

A custom Shopify app can directly be created from your shop's Shopify admin dashboard.

info

Linkster specifically requires a custom app that was created from your store's Shopify admin. A custom app created from the Shopify partners dashboard won't work.

Admin API access scopes​

The Linkster custom Shopify app needs the following access scopes to work properly:

write_script_tags, read_script_tags, read_orders and read_customers.

Step-by-step guide​

You can follow these steps to create a custom app for Linkster.

info

You need the correct user permissions to create a custom app for your Shopify store.

  1. Navigate to your store's Shopify admin: https://your-shop-domain.com/admin.

  2. Click on "Apps" in the side menu.

  3. Click on "Develop apps", right next to the green "Customize your store" button.

    If you can't see a button named "Develop apps" you may not have sufficient user permissions.

  4. Next, click on "Create an app" to create a new custom app.

  5. Give it a memorizable name like "Linkster Tracking".

  6. You should now have landed on the detail page of the newly created app. Now click on the tab named "Configuration".

  7. On there, start configuring the "Admin API integration" by clicking on "Configure".

  8. Enable all access scopes listed above and click on "Save".

  9. Now you have to install the app by clicking "Install app".

  10. Finally, you can navigate to the "API credentials" tab and note down the API key, secret key and the admin API access token.

    danger

    The admin API access token can only be viewed once, so make sure to save it at a secure place.

Now, let your Linkster contact know the API key, secret key, admin API access token and webhook version (found on the "Configuration" tab) and he/she will take care of the rest.

Options​

Order category​

By setting an order category, you can group orders in Linkster.

Like for HTTP sale and lead conversion requests, you also have the ability to send an optional order category with Shopify orders tracked over this custom app integration.

If Linkster detects an entry named __linksterOrderCategory in the note_attributes of an order, it will use its value as the order category:

...
"note_attributes": [
  {
    "name": "__linksterOrderCategory",
    "value": "your_order_category_name_here"
  }
],
...

Shopify offers different ways for setting note_attributes. Two possible solutions are:

  1. Setting note_attributes with an HTML input element in the cart form. (Read this Shopify guide for more information)
  2. Setting note_attributes by sending an update request to the cart endpoint. (Read this Shopify guide for more information)