Shopify

Learn how to connect Engini to Shopify.

Using Engini’s Shopify activities, you can Create, update and cancel orders.

To get started with the Shopify app, create an account at www.shopify.com/signup.

Getting Started with Shopify #

Prerequisites #

• A Shopify account

Connecting Engini to Shopify #

Retrieve your Shopify access token  #

1. Log in to your Shopify admin dashboard and navigate to the “Apps” section.
2. Click on the “App and sales channel setting” button.
   
3. Click on the “Develop apps” button.
   
4. Click on the “Create a new private app” button.
   
5. Enter a name for your private app and provide an email address for notifications, then click on “create app” button.
6. Click Configuration.
   
7. Click on Configure button next to Admin API integration.
   
8. Under the “Admin API” section, select the permissions that you want to grant to your app.
9. Click on the “Save” button to create the private app.
   
10. Switch to the API credentials tab and under Access tokens, click Install app.
    
11. In the dialog that appears, confirm the action by clicking Install.
    
12. Shopify creates an Admin API access token. Click Reveal token and copy the token.
    

Add a connection to Shopify in Engini #

If you need to connect Shopify with an app or service that is not available as a built-in integration, you can create a custom integration using Shopify’s API. It allows you to build a more customized and tailored integration that meets your specific needs.

To connect your Shopify account to Engini, follow the next steps:

1. Enter your Engini account at https://app.engini.io.
2. Navigate to Connections page by clicking on the Connections on the left sidebar or by clicking here.
3. Click on the Add connection option located at the topbar.
4. Choose Shopify option from the available applications
   
   
5. Enter the following details in the “Edit Connection” form:
   
   1. Connection name
   2. Shopify site URL
   3. API access token – Enter the access token you obtained from Shopify.

Triggers #

The trigger is executed automatically in response to a specific event.
Every workflow has to start with a trigger. You can use item, sub-item, item update triggers.

Orders #

Order Created #

An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.

Listens for a new order creation.

1. Add conditions
   If you want the trigger “Order Created” to be activated only under a certain condition, click on the “Add Condition” button.
   By choosing to add a condition, the workflow will only work if the condition or the number of conditions you added are met.  Follow the next steps to add conditions:
   1. Select from the drop down the field you want to add the condition on.
   2. Select the condition you want the record to meet. 
   3. Click on the empty field and the tooltip will pop up showing the options you can choose. 
   4. You can populate the field in one of the following options:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
      • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 
   5. Repeat steps a-d for all the fields you want to populate.

Order Updated #

Listens for an order’s updates. 

1. Add conditions
   If you want the trigger “Order Updated” to be activated only under a certain condition, click on the “Add Condition” button.
   By choosing to add a condition, the workflow will only work if the condition or the number of conditions you added are met.  Follow the next steps to add conditions:
   1. Select from the drop down the field you want to add the condition on.
   2. Select the condition you want the record to meet. 
   3. Click on the empty field and the tooltip will pop up showing the options you can choose. 
   4. You can populate the field in one of the following options:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
      • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 
   5. Repeat steps a-d for all the fields you want to populate.

Order Fulfilled #

Listener for the Fulfilled of an order.

In Shopify, “Order Fulfilled” means that the order has been completed and the customer’s purchased items have been shipped or delivered to them.

1. Add conditions
   If you want the trigger “Order Fulfilled” to be activated only under a certain condition, click on the “Add Condition” button.
   By choosing to add a condition, the workflow will only work if the condition or the number of conditions you added are met.  Follow the next steps to add conditions:
   1. Select from the drop down the field you want to add the condition on.
   2. Select the condition you want the record to meet. 
   3. Click on the empty field and the tooltip will pop up showing the options you can choose. 
   4. You can populate the field in one of the following options:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
      • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 
   5. Repeat steps a-d for all the fields you want to populate.

Order Paid #

Listens for paid orders.

1. Add conditions
   If you want the trigger “Order Paid” to be activated only under a certain condition, click on the “Add Condition” button.
   By choosing to add a condition, the workflow will only work if the condition or the number of conditions you added are met.  Follow the next steps to add conditions:
   1. Select from the drop down the field you want to add the condition on.
   2. Select the condition you want the record to meet. 
   3. Click on the empty field and the tooltip will pop up showing the options you can choose. 
   4. You can populate the field in one of the following options:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
      • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 
   5. Repeat steps a-d for all the fields you want to populate.

Order Cancelled #

Listener for cancellation of orders.

1. Add conditions
   If you want the trigger “Order Cancelled” to be activated only under a certain condition, click on the “Add Condition” button.
   By choosing to add a condition, the workflow will only work if the condition or the number of conditions you added are met.  Follow the next steps to add conditions:
   1. Select from the drop down the field you want to add the condition on.
   2. Select the condition you want the record to meet. 
   3. Click on the empty field and the tooltip will pop up showing the options you can choose. 
   4. You can populate the field in one of the following options:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
      • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 
   5. Repeat steps a-d for all the fields you want to populate.

Customers #

Customer Created #

Listens for a new customer creation.

1. Add conditions
   If you want the trigger “Customer Created” to be activated only under a certain condition, click on the “Add Condition” button.
   By choosing to add a condition, the workflow will only work if the condition or the number of conditions you added are met.  Follow the next steps to add conditions:
   1. Select from the drop down the field you want to add the condition on.
   2. Select the condition you want the record to meet. 
   3. Click on the empty field and the tooltip will pop up showing the options you can choose. 
   4. You can populate the field in one of the following options:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
      • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 
   5. Repeat steps a-d for all the fields you want to populate.

Customer Updated #

Listens for a customer’s updates. 

1. Add conditions
   If you want the trigger “Customer Updated” to be activated only under a certain condition, click on the “Add Condition” button.
   By choosing to add a condition, the workflow will only work if the condition or the number of conditions you added are met.  Follow the next steps to add conditions:
   1. Select from the drop down the field you want to add the condition on.
   2. Select the condition you want the record to meet. 
   3. Click on the empty field and the tooltip will pop up showing the options you can choose. 
   4. You can populate the field in one of the following options:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
      • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 
   5. Repeat steps a-d for all the fields you want to populate.

Refund #

Refund Created #

Listens for a refund creation.

In Shopify, “Refund created” means that the seller has initiated the process of refunding the customer for a returned or cancelled order.

1. Add conditions
   If you want the trigger “Refund Created” to be activated only under a certain condition, click on the “Add Condition” button.
   By choosing to add a condition, the workflow will only work if the condition or the number of conditions you added are met.  Follow the next steps to add conditions:
   1. Select from the drop down the field you want to add the condition on.
   2. Select the condition you want the record to meet. 
   3. Click on the empty field and the tooltip will pop up showing the options you can choose. 
   4. You can populate the field in one of the following options:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
      • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 
   5. Repeat steps a-d for all the fields you want to populate.

Actions #

Product #

Get Product #

Get one product. To use the “Get product” activity block in Engini you need to fill the id field:

1. Product ID field
   1. Click on the empty field and the tooltip will pop up showing all the products ID you can use.
      Note that you choose an ID and not a name.
   2. Select the item ID that is relevant. you can use:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).

Get Product by SKU #

1. SKU
   SKU stands for “Stock Keeping Unit”. Set the SKU of the product.
   Click on the empty field and the tooltip will pop up showing the options you can choose. 
   You can populate the field in one of the following options:
   • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
   • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
   • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 

Create Product #

Creates a new product. To use the “Create product” activity block in Engini you need to fill to following fields:

1. Title field
   The title is the name of the new product you create. The title can come from the trigger or another action you performed in the process before the “create product” action. 
   1. Click on the empty field and the tooltip will pop up showing all the names you can use.
   2. Select from the tooltip the name of the new item you create. you can use:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
2. Add Fields
   By clicking the “Add field” button, you can choose how to fill in the various fields in the record you are creating. You can add one field to the activity or more fields to the activity definitions, up to the number of fields in the board.
   1. Choose from the drop down the field you want to fill.
   2. Click on the empty field to the right of the drop down to be shown the tooltip with all the options you can use to fill the field.
   3. You can populate the field in one of the following options:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
      • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 
   4. Repeat steps a-c for all the fields you want to populate.

Update product #

1. Product ID field
   1. Click on the empty field and the tooltip will pop up showing all the products ID you can use.
      Note that you choose an ID and not a name.
   2. Select the item ID that is relevant. you can use:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
2. Add Fields
   By clicking the “Add field” button, you can choose how to fill in the various fields in the record you are creating. You can add one field to the activity or more fields to the activity definitions, up to the number of fields in the board.
   1. Choose from the drop down the field you want to fill.
   2. Click on the empty field to the right of the drop down to be shown the tooltip with all the options you can use to fill the field.
   3. You can populate the field in one of the following options:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
      • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 
   4. Repeat steps a-c for all the fields you want to populate.

Initialize PRODUCT OPTIONS Array #

Add this activity to initialize a PRODUCT OPTIONS array. The Name is automatically populated as “product options” by default. However, this field is editable.

This allowing users to set up and manage an array specifically designated for product options data.

Initialize PRODUCT IMAGES Array #

Add this activity to initialize a PRODUCT IMAGES array. The Name is automatically populated as “product images” by default. However, this field is editable.

This allowing users to set up and manage an array specifically designated for product images data.

Add PRODUCT OPTIONS to array #

To use this action, you first need to initialize a product options array.

1. Variable
   Select the variable from the dropdown menu. This variable likely represents the specific array or container where product options data will be added.
2. Add Field
   By clicking the “Add field” button, you can choose how to fill in the various fields in the product options you are adding. You can add one field to the activity or more fields to the activity definitions.
   1. Choose from the drop down the field you want to fill.
   2. Click on the empty field to the right of the drop down to be shown the tooltip with all the options you can use to fill the field.
   3. You can populate the field in one of the following options:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
      • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 
   4. Repeat steps 1-3 for all the fields you want to populate.

Add PRODUCT IMAGES to array #

Any product may have up to 250 images.

To use this action, you first need to initialize a product images array.

1. Variable
   Select the variable from the dropdown menu. This variable likely represents the specific array or container where product images data will be added.
2. Add Field
   By clicking the “Add field” button, you can choose how to fill in the various fields in the product images you are adding. You can add one field to the activity or more fields to the activity definitions.
   1. Choose from the drop down the field you want to fill.
   2. Click on the empty field to the right of the drop down to be shown the tooltip with all the options you can use to fill the field.
   3. You can populate the field in one of the following options:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
      • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 
   4. Repeat steps 1-3 for all the fields you want to populate.

Inventory #

Get Inventory Item

#

Get Inventory Item by SKU.

1. SKU
   SKU stands for “Stock Keeping Unit”. Set the SKU of the inventory item. Click on the empty field and the tooltip will pop up showing the options you can choose. 
   You can populate the field in one of the following options:
   • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
   • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
   • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 

Update inventory level #

In Shopify, the “Inventory Level” represents the actual quantity of an item that is available.
Inventory levels connect one inventory item to one location. Each inventory level holds the available quantity for its inventory item at the associated location.

1. Inventory item id
   Click on the empty field and the tooltip will pop up showing the options you can choose. 
   You can populate the field in one of the following options:
   • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
   • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
2. Location id
   A unique identifier assigned to a physical location where you store your inventory.
   Click on the empty field and the tooltip will pop up showing the options you can choose. 
   You can populate the field in one of the following options:
   • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
   • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
3. Available Qty
   Click on the empty field and the tooltip will pop up showing the options you can choose. 
   You can populate the field in one of the following options:
   • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
   • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
   • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 

Order #

Get Order

#

1. Order Id
   Click on the empty field and the tooltip will pop up showing the options you can choose. 
   You can populate the field in one of the following options:
   • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
   • Property value from a previous activity (Using the tooltip that opens when clicking on the field).

Add orderTag #

OrderTag is a label or a keyword that you can attach to an order to help you categorize or organize your orders in a more meaningful way.

1. Order id
   Click on the empty field and the tooltip will pop up showing the options you can choose. 
   You can populate the field in one of the following options:
   • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
   • Property value from a previous activity (Using the tooltip that opens when clicking on the field). 
2. Tags
   Click on the empty field and the tooltip will pop up showing the options you can choose. 
   You can populate the field in one of the following options:
   • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
   • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
   • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 

Variant #

Get variant #

Specific version of a product that has a unique combination of attributes such as size, color, material, and price.

1. Variant id
   Click on the empty field and the tooltip will pop up showing the options you can choose. 
   You can populate the field in one of the following options:
   • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
   • Property value from a previous activity (Using the tooltip that opens when clicking on the field).

Create Variant #

1. Product id
   The id of the product for which you want to create a variant.
   1. Click on the empty field and the tooltip will pop up showing all the product ID you can use.
   2. Select the product ID that is relevant. you can use:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (sing the tooltip that opens when clicking on the field).
2. Title
   Click on the empty field and the tooltip will pop up showing the options you can choose for the title of the variant. 
   You can populate the field in one of the following options:
   • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
   • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
3. Option 1
   This field allows you to define the first customizable option for the variant. Click on the empty field and the tooltip will pop up showing the options you can choose for the option. 
   You can populate the field in one of the following options:
   • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
   • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
4. Add field
   By clicking the “Add field” button, you can choose how to fill in the various fields in the customer you are creating. You can add one field to the activity or more fields to the activity definitions.
   1. Choose from the drop down the field you want to fill.
   2. Click on the empty field to the right of the drop down to be shown the tooltip with all the options you can use to fill the field.
   3. You can populate the field in one of the following options:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
      • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 
   4. Repeat steps a-c for all the fields you want to populate.

Update variant #

1. Variant id
   The id of the variant you want to update.
   1. Click on the field to show the tooltip with all the options you can choose.
   2. You can populate the field in one of the following options:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
2. Add field
   By clicking the “Add field” button, you can choose how to fill in the various fields in the customer you are creating. You can add one field to the activity or more fields to the activity definitions.
   1. Choose from the drop down the field you want to fill.
   2. Click on the empty field to the right of the drop down to be shown the tooltip with all the options you can use to fill the field.
   3. You can populate the field in one of the following options:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
      • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 
   4. Repeat steps a-c for all the fields you want to populate.

Initialize VARIANTS Array

#

Add this activity to initialize a VARIATIONS array. The Name is automatically populated as “variants array” by default. However, this field is editable.

This allowing users to set up and manage an array specifically designated for variant-related data.

Add VARIATION to array

#

To use this action, you first need to initialize a variants array.

1. Variable
   Select the variable from the dropdown menu. This variable likely represents the specific array or container where variation data will be added.
2. Title
   Click on the empty field and the tooltip will pop up showing the options you can choose for the title of the variation. 
   You can populate the field in one of the following options:
   • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
   • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
3. Add Field
   By clicking the “Add field” button, you can choose how to fill in the various fields in the variation you are adding. You can add one field to the activity or more fields to the activity definitions.
   1. Choose from the drop down the field you want to fill.
   2. Click on the empty field to the right of the drop down to be shown the tooltip with all the options you can use to fill the field.
   3. You can populate the field in one of the following options:
      • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
      • Property value from a previous activity (Using the tooltip that opens when clicking on the field).
      • Expression – using functions and/or Previous activity properties and/or static values (Using the tooltip that opens when clicking on the field). 
   4. Repeat steps 1-3 for all the fields you want to populate.

Transactions #

In Shopify, a transaction refers to any payment or refund that is associated with an order.

Get Transactions #

1. Transaction id
   Click on the field to show the tooltip with all the options you can choose.
   You can populate the field in one of the following options:
   • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
   • Property value from a previous activity (Using the tooltip that opens when clicking on the field).

Get Payment Transactions

#

Get records of all payment transactions.

Get Payplus Transactions

#

Get records of all payplus transactions.

Location #

In Shopify, a location refers to a physical address or place associated with the management of inventory and fulfillment.

Get Location

#

1. Location Id
   Click on the field to show the tooltip with all the options you can choose.
   You can populate the field in one of the following options:
   • Static value – number / string. when using strings, you need to surround them with single quotes (‘).
   • Property value from a previous activity (Using the tooltip that opens when clicking on the field).

Get Locations

#

Get records of all locations.