Child pages
  • Shopify IPaaS Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

shopify - ipaas integration

Anchor
_GoBack
_GoBack

Image Added

3/4/22

James Larry Gaines II

 

 




Anchor
_Toc1
_Toc1
Table of contents

Table of contents
1.Introduction
Technical Description
2.integration setup with shopify and IPaas
Setup Shopify
Setup IPaaS
3.Configure ipaas webhooks
3.Configure Ipaas shopify translations
3.Configure Ipaas shopify translations











Anchor
_Toc2
_Toc2
Introduction

Anchor
_Toc3
_Toc3
Technical Description

This document describes how we can integrate Shopify with IPaaS. This integration provides an automated way to move orders, transactions, products and customers from an external eCommerce Application to Shopify and vice versa. It integrates with Shopify via API calls and Web Hooks.
IPaaS is a broker system in between Shopify and another external eCommerce System. It facilitates data transfers to and from between them. If say you need to sync data from a Big Commerce System to Shopify and vice versa, you upload the necessary application plugins to IPaaS. One for each system, which recognizes and interacts with the system and sends this to IPaaS.
If say a data arrives from Shopify, the defined mapping rule is used to understand how data from Shopify maps back to IPaaS. And when this is send to Shopify, a similar mapping is used to specify how an IPaaS data is mapped back to Shopify. This also happens vice versa.
The following describes how data transfer works when an External System is integrated to IPaaS and when a data is sent From an External System such as Shopify To IPaaS.
Image Added

IPaaS is integrated with the external system via Web hooks. This is done by coding the webhook subscription in the plugin. When the plugin is installed in IPaaS, IPaaS automatically subscribes to the webhook offered by the external system.
When data arrives, it follows the process above. The process is:

Process

Description

  1. Webhook Call happens

In this process, IPaaS will start the basic operations which includes instantiating all the connection classes, translation utility classes and API Call Wrapper

  1. Prepare the Source Data

This process is the 2nd step. IPaaS will then do a Get API Call to the external system by passing the ID that was sent by the Web Hook to get the data.

  1. Prepare Translation process

The next step is to translate the data received as appropriate

  1. Translate and Transfer the Data

IPaaS will then use the mappings configured in its system to map the data received from the Get call to IPaaS.

  1. Post Transfer Procedure

This procedure does the post transfer actions.



The following describes how data transfer works when an External System is integrated with IPaaS and when a data is sent TO an External System such as Shopify FROM IPaaS.


Image Added
When data arrives, it follows the process above. The process would be :

Process

Description

  1. Webhook Call happens

In this process, IPaaS will start the basic operations which includes instantiating all the connection classes, translation utility classes and API Call Wrapper

  1. Prepare the Source Data

This process is the 2nd step. IPaaS will prepare EstimateTotalAPICallsMade

  1. Prepare Translation process

The next step is to translate the data received as appropriate. It will also execute the GetDestinationObject.
It will also map the data from IPaaS to the required data by Shopify API methods.

  1. Translate and Transfer the Data

IPaaS will then call the API methods of Shopify or the target Ecommerce application. IPaaS will use the mappings as parameter to call the external API methods.

  1. Post Transfer Procedure

This procedure does the post transfer actions.

Anchor
_Toc4
_Toc4
integration setup with shopify and IPaas

Follow these steps to begin configuring the integration. We're here to help. So as you have questions, contact Support via our help desk, which is at https://help.web2market.com/.

Anchor
_Toc5
_Toc5
Setup Shopify


The first thing we need to do is to create a Private Apps. Follow the instructions below

  1. Login to your Shopify Store Admin Panel
  2. Go To Apps as shown below :


Image Added

  1. Click on Manage Private Apps


Image Added

  1. Click on Create New Private App

Image Added

  1. Fill up the following data



Name

Values

Private App Name

Name of the App you want to name it

Emergency Developer Email

Enter the contact email or developer email

Admin API Permissions

Enable the following :

Customers -> Read and Write
Draft Order -> Read and Write
Fulfillment Services -> Read and Write
Inventory -> Read and Write
Locations -> Read Access
Order Editing -> Read and Write
Orders -> Read and Write
Product Listings -> Read and Write
Products -> Read and Write

Webhook API Version

choose : 2021-04

Storefront API

Enable the following :

Allow this app to access your storefront data
Read products, variants and collections
Read and modify Customer details
Read and modify checkouts
Read content like articles, blogs and comments




  1. Click on Save button.
  2. If a popup opens, click on Create App
  3. Copy the API Key and Password to somewhere safe. We will reference this later in IPaaS

Image Added


Anchor
_Toc6
_Toc6
Setup IPaaS


Once setup, login to IPaaS.

  1. Login to your IPaaS Admin Panel
  2. Go to Subscription Management as shown below :


Image Added

  1. Click on Search Certified Integration Marketplace and Subscribe.

Image Added

  1. On the available companies, choose Shopify


  1. Fill the following :


Name

Values

Name

Enter the name of this subscription

Versions

Choose the latest version

API Store

Enter the name of your API Store

API Key

Enter the API Key from Shopify

API Password

Enter the API Password from Shopify

API Version

Enter 2021-04





  1. Save this settings.


Anchor
_Toc7
_Toc7
Configure ipaas webhooks

Do the following to configure IPaaS WebHooks.

  1. On the subscriptions page, configure the Webhook Internal by clicking on the below

Image Added

  1. Make the application's webhooks active by clicking the switch as shown below. Configuring this to Active will enable the Application Webhooks to be captured by IPaaS. Click each of the below:


Image Added

  1. On the subscriptions page, configure the Webhook Internal by clicking on the below


Image Added

  1. Enable all hooks to be active as shown below in the example. Make everything active.


Image Added

Anchor
_Toc8
_Toc8
Configure Ipaas shopify translations

Do the following to configure IPaaS Shopify Translations:

  1. On the subscriptions page, click the Manage Translations as shown below

Image Added

  1. Click on Add Translation Collections as shown below

Image Added

  1. Add the following translations below as


  • ProductStatus


Name

Values

Name

ProductStatus

Direction

From IPaaS

Mapping Type

Field

Destination

Field : Status

Source

Field : Status

Lookup Translations






Source

Destination


Active


active

Disabled

draft

Discontinued

archive

Preorder

draft




|
Image Added

  • Transaction



Name

Values

Name

SH Transaction Status To iPaaS

Direction

To IPaaS

Mapping Type

Field

Destination

Field : Status

Source

Field : Status

Lookup Translations






Source

Destination


CONFIRMED


Pending

PENDING

Pending

PAID

Pending

REFUNDED

Complete

VOIDED

Cancelled

SHIPPED

Shipped

FULFILLED

Complete




|


  • ProductStatus To IPaaS



Name

Values

Name

ProductStatusToIPaaS

Direction

To IPaaS

Mapping Type

Field

Destination

Field : Status

Source

Field : Status

Lookup Translations






Source

Destination


active


Active

draft

Preorder

archive

Discontinued




|





Anchor
_Toc9
_Toc9
Configure Ipaas shopify translations