Additional setup notes for Shopify (service connector)

Introduction

This page includes additional information and resources that may be useful when configuring Shopify in Patchworks:

Shopify documentation

The following links to Shopify's own documentation may be useful if you need to dig deeper into Shopify fields (for example, to configure advanced mappings):

Patchworks filters

When you are pulling data from Shopify, filters can be used to refine the data that is pulled. Available filter options vary, depending on which entity type is being synced (for example: orders, products, customers, etc.).

For general information about working with filters in Patchworks, please see our service filters page.

Time period filters

A common scenario for filters is to process records created/modified in the last x minutes/hours/days, or within a given timeframe. For Shopify, the following time period filter fields are available:

FieldSummary
  • Created At Min

  • Updated At Min

  • Processed At Min

The minimum date and time for which you want to retrieve records for processing. This parameter can be used to filter results so that you only get data that was created/updated/processed on or after the specified date and time.

These parameters are inclusive.

  • Created At Max

  • Updated At Max

  • Processed At Max

The maximum date and time for which you want to retrieve records for processing. This parameter can be used to filter results so that you only get data that was created/updated/processed before or up to the specified date and time.

These parameters are inclusive.

Example 1

Let's say that we only want to process all orders which were created in the last 2 hours. In the Patchworks dashboard, our filters would look as follows:

We can visualise this as below:

Example 2

Let's say that we only want to process all orders which are between 1 and 2 hours old. In the Patchworks dashboard, our filters would look as below:

We can visualise this as below:

Order ID filters

If you need to define filters to pull a specific order from Shopify, the ID to specify in Patchworks is the order id - this is not the same as the buyer's order number in Shopify:

When viewing an orders in the Shopify admin portal, the required order id is the long number at the end of the URL in the address bar - for example:

In the example above, notice that the customer's order number is #111 - we don't need this.

So, if we needed to run a manual sync for this order, our Patchworks filter would be defined as below:

Special options when pulling data from Shopify

When you choose to add Shopify as a source connector for a Patchworks service, you're prompted to provide details for a set of standard options which are common to all source connectors, irrespective of the system being used.

In addition, depending on the entity being synced, some Shopify-specific source options may be required. These options are summarised below:

Entity syncedFieldField summary

Orders(Orders)

ignore order updates

Select this option if you only want to sync new orders. When this option is set, any changes to existing orders are ignored.

Special options when pushing data to Shopify

When you choose to add Shopify as a destination connector for a Patchworks service, you're prompted to provide details for a set of standard options which are common to all destination connectors, irrespective of the system being used.

In addition, depending on the system you're pulling data from and the entity being synced, some Shopify-specific destination options may be required. These options are summarised below.

Entity syncedFieldField summary

Stocklevels (Stock)

location id

This is an optional ID which can be used when you have multiple Shopify warehouses and need to specify which location this data is for.