Shopify Integration with Axanta ERP

This guide explains how to integrate your Shopify store with Axanta ERP, synchronize products, and automatically create Sales Orders from Shopify orders using webhooks.

1. Install the Shopify Connector

  1. Navigate to Apps.
  2. Search for the Shopify Connector.
  3. Install the Shopify Connector.

During installation, the required Sales and Webhook modules will also be installed. Once installation is complete, you can configure your Shopify store in Axanta ERP.

2. Set Up a Shopify Instance in Axanta

Step 1: Create a New Instance

  1. Navigate to Apps > Webhook > Shopify > Instances.
  2. Click New to create an integration instance.
  3. Copy your Shopify store URL, for example yourstore.myshopify.com, and enter it in the Store URL field.

Step 2: Obtain API Credentials from Shopify

  1. Log in to your Shopify Admin dashboard.
  2. Navigate to Settings > Apps > Develop Apps.
  3. Select the application.
  4. Open App Settings to retrieve the Client ID and Client Secret.
  5. Go to Versions, select the active app version, and copy the API version string.

Step 3: Configure and Test the Connection

  1. Return to Axanta ERP and enter the Client ID, Client Secret, and API Version.
  2. Click Test Connection to verify communication between Axanta and Shopify.
  3. Click Generate Token to generate the access token required for API requests.
  4. Configure the field mappings between Shopify and Axanta.
  5. Fill in the recommended default fields to ensure the integration works as expected.
Note: Keep your Client Secret and access token confidential.

3. Configure Product Synchronization

Once the Shopify instance is configured, product synchronization follows the rules below.

Product Eligibility

Only products with the is_website_product enabled in Axanta are eligible for synchronization.

Product Publishing Status

The product's published status in Axanta determines its status in Shopify:

  • Unpublished in Axanta: The product is set to Draft in Shopify.
  • Published in Axanta: The product is set to Active in Shopify.

Product Images

To synchronize multiple product images:

  1. Open the product in Axanta ERP.
  2. Navigate to Website > URL.
  3. Add the direct URLs of the product images.

Ensure the image URLs are valid and publicly accessible so Shopify can retrieve the images.

4. Configure Shopify Webhooks

Webhooks allow Shopify to notify Axanta ERP when the configured order event occurs.

Step 1: Retrieve the Webhook URL from Axanta

  1. Navigate to Apps > Webhook > Shopify > Instances.
  2. Open the configured Shopify instance.
  3. Locate Webhook Path Token.
  4. Copy the webhook URL.

Step 2: Create a Webhook in Shopify

  1. Log in to Shopify Admin.
  2. Navigate to Settings > Notifications > Webhooks.
  3. Click Create Webhook.
  4. Configure the webhook based on how you want Axanta ERP to process the Shopify order.

Option 1: Create a Sales Order when the Shopify order is created

  • Event: Order Creation
  • Format: JSON
  • URL: Paste the webhook URL copied from Axanta.
  • Webhook API Version: Select the same API version configured in Axanta.

Option 2: Create a Sales Order when the Shopify order is fulfilled

  • Event: Order Fulfillment
  • Format: JSON
  • URL: Paste the webhook URL copied from Axanta.
  • Webhook API Version: Select the same API version configured in Axanta.

Choose one option based on your business requirement. You do not need to configure both webhooks unless you specifically require both events to be processed.

  1. Save the webhook.
  2. Copy the webhook secret associated with the configured webhook.

Step 3: Configure the Webhook Secret in Axanta

  1. Return to Axanta ERP.
  2. Open the configured Shopify instance.
  3. Paste the copied secret into the Webhook Secret field.
  4. Save the instance.

Ensure the secret corresponds to the webhook configured in Shopify.

5. Automatic Sales Order Creation

After the integration and webhook configuration are complete, Axanta can receive order notifications from Shopify.

  1. A customer places an order on Shopify, or the configured order event occurs.
  2. Shopify sends the corresponding webhook notification to Axanta.
  3. Axanta receives and processes the incoming webhook.
  4. Axanta creates the corresponding Sales Order according to the configured integration logic.

The webhook event and the order_type configuration determine how the incoming order is processed.

Note: The order_type can be configured from the webhook settings under 'Order Type'.