Product documentation
Patchworks services
Patchworks services
  • Services documentation
  • Getting started
    • What is a service?
  • Roles & Permissions
    • Roles & permissions summary (services)
  • Working with Services
    • Accessing services
    • The services list
    • The anatomy of a service
      • Service summary
      • Service canvas
      • Service filters
      • Service trigger
      • Service source
      • Service destination
      • Service mapping
      • Service alerts
      • Payload script
      • Run service
      • Service settings
    • Adding a Patchworks service
      • Add a default service
      • Configure service settings
      • Set the service trigger schedule
      • Define service filters
      • Define field mappings
      • Activate the service
    • Cloning an existing service
    • Updating a service
      • Service notes
      • Using a payload-level custom script in services
    • Removing a service
    • Field mappings & transformations (services)
      • Field mappings (services)
        • Mapping metafields for products (services)
      • Field transformations (services)
        • Transform function reference (services)
        • Using a custom script in field transformations (services)
      • Transform mapping/lookup tables (services)
      • Legacy shipment & payment maps (services)
  • Service connectors
    • What is a service connector?
    • Accessing service connectors
    • The anatomy of a service connector
    • Adding a service connector
    • Updating a service connector
    • Removing a service connector
  • Reporting & logging
    • Service sync reports
      • Viewing the service sync report
      • Handling failed service syncs
      • Sync failure email notifications
    • Service sync logs
    • Viewing logs for custom script activity in services
  • Service systems
    • Service systems
    • Supported service systems
      • Active Ants (service connector)
        • Finding service connector credentials for Active Ants
      • BigCommerce (service connector)
        • Finding service connector credentials for BigCommerce
        • Additional setup notes for BigCommerce (services)
      • Bleckmann (service connector)
        • Finding service connector credentials for Bleckmann (API)
      • Bleckmann Returns (service connector)
        • Finding service connector credentials for Bleckmann (Returns)
      • Bleckmann SFTP (service connector)
        • Finding service connector credentials for Bleckmann (SFTP)
      • Brightpearl (service connector)
        • Finding service connector credentials for Brightpearl
        • Additional setup notes for Brightpearl (services)
      • Business Central (service connector)
        • Finding service connector credentials for Business Central
      • Citrus-Lime (service connector)
        • Finding service connector credentials for Citrus-Lime
      • CommerceTools (service connector)
        • Finding service connector credentials for CommerceTools
      • Cybertill (service connector)
        • Finding service connector credentials for Cybertill
      • Descartes Peoplevox (service connector)
        • Finding service connector credentials for Peoplevox
        • Configuring Peoplevox as a data destination (services)
        • Quick setup CSV files for Peoplevox (services)
      • Dynamics NAV (service connector)
        • Finding service connector credentials for Dynamics NAV
      • Emarsys (service connector)
        • Finding service connector credentials for Emarsys (FTP)
      • EposNow (service connector)
        • Finding service connector credentials for EposNow
      • Global-e (service connector)
        • Finding service connector credentials for Global-e
      • Inventory Planner (service connector)
        • Finding service connector credentials for Inventory Planner
      • Khaos Control (service connector)
        • Finding service connector credentials for Khaos Control
      • Lightspeed Retail R-Series (service connector)
        • Authorising Patchworks to access your Lightspeed Retail R-Series account (services)
      • Lightspeed Retail X-Series (service connector)
      • Linnworks (service connector)
        • Finding service connector credentials for Linnworks
      • Magento 2 (service connector)
        • Finding service connector credentials for Magento 2
        • Required settings for Magento 2.4.4+ (services)
      • Mirakl (service connector)
        • Finding service connector credentials for Mirakl
      • Navision (service connector)
      • NetSuite (service connector)
        • Authorising Patchworks to access your NetSuite account (services)
        • Required NetSuite features (services)
        • Working with NetSuite custom fields (services)
        • Setting unique IDs for NetSuite product syncs (services)
        • NetSuite concurrency (services)
        • Troubleshooting NetSuite connections (services)
        • Additional setup notes for NetSuite (services)
        • Legacy service connector setup for NetSuite
          • Installing the Patchworks bundle for NetSuite (services)
          • Finding connector credentials for NetSuite (services)
      • Odoo (service connector)
        • Finding service connector credentials for Odoo
      • Ometria (service connector)
        • Finding service connector credentials for Ometria
      • Patchworks SFTP (service connector)
        • Finding basic auth service connector credentials for SFTP
        • Finding ssh auth service connector credentials for SFTP
        • Specifying a non-root folder as the file location (services)
        • Adding entity schemas (services)
      • Plytix (service connector)
        • Finding service connector credentials for Plytix
      • Prima (service connector)
        • Finding service connector credentials for Prima
      • ReBound (service connector)
        • Finding service connector credentials for ReBound
      • SAP Business One (service connector)
        • Finding service connector credentials for SAP Business One
      • Seko (service connector)
        • Finding service connector credentials for Seko (API)
        • Finding service connector credentials for Seko (FTP)
      • Shopify / Shopify+ (service connector)
        • Finding service connector credentials for Shopify (token auth)
        • Finding service connector credentials for Shopify (legacy auth)
        • Additional setup notes for Shopify (service connector)
      • Sitoo (service connector)
        • Finding service connector credentials for Sitoo
      • SparkLayer (service connector)
        • Finding service connector credentials for SparkLayer
      • The Edge by John Lewis (service connector)
        • Finding service connector credentials for The Edge by John Lewis
      • TikTok Shop (service connector)
        • Finding service connector credentials for TikTok Shop
      • Torque (service connector)
        • Finding service connector credentials for Torque
      • Veeqo
        • Finding service connector credentials for Veeqo
      • Vend (service connector)
        • Finding service connector credentials for Vend
      • Visualsoft (service connector)
        • Finding service connector credentials for Visualsoft
      • Voyado (service connector)
        • Finding service connector credentials for Voyado
      • WooCommerce (service connector)
        • Finding service connector credentials for WooCommerce
      • ZigZag (service connector)
        • Finding service connector credentials for ZigZag
  • Troubleshooting
    • How to manage failed service syncs
    • How to run a service manually
    • How to deactivate/activate a service
    • How to check the operational status of a service connector
    • What to check if you can't save a new service connector
    • How to handle an empty mapping page
    • What to do if your third-party systems go offline
  • Inbound API
    • Inbound API for services
    • Using the Inbound API connector with Patchworks services
      • Adding an inbound API connector with a custom payload
      • Generating token credentials for API access
      • Adding a Patchworks service for an inbound API connector
        • Add a default service
        • Configure service settings
        • Set the service trigger schedule
        • Define field mappings
        • Activate the service
      • Implementing API requests
  • Support
    • Raising a support ticket
Powered by GitBook
On this page
  • Introduction
  • Shopify documentation
  • Patchworks filters
  • Time period filters
  • Order ID filters
  • Special options when pulling data from Shopify
  • Special options when pushing data to Shopify
  1. Service systems
  2. Supported service systems
  3. Shopify / Shopify+ (service connector)

Additional setup notes for Shopify (service connector)

PreviousFinding service connector credentials for Shopify (legacy auth)NextSitoo (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 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:

Field
Summary
  • 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

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

Entity synced
Field
Field 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

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 synced
Field
Field 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.

Entity synced
Field
Field summary

-

-

-

When you choose to add Shopify as a source connector for a Patchworks service, you're prompted to provide details for a set of , irrespective of the system being used.

When you choose to add Shopify as a destination connector for a Patchworks service, you're prompted to provide details for a set of , irrespective of the system being used.

Shopify documentation
Patchworks filters
Special options when pulling data from Shopify
Special options when pushing data to Shopify
Shopify API documentation
service filters
standard options which are common to all source connectors
standard options which are common to all destination connectors