Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
The Shopify & Descartes Peoplevox blueprint includes everything you need to:
Sync products from Shopify to Peoplevox
Sync orders from Shopify to Peoplevox
Sync stock from Peoplevox events to Shopify
Sync refunds (using returns report data) from Peoplevox to Shopify
Sync fulfilments from Peoplevox events to Shopify
Subscribe to Peoplevox fulfilment post events
Subscribe to Peoplevox stock events (using site filters)
Unsubscribe from Peoplevox events
Process flows are built to implement powerful data flows between connector instances in an intuitive, visual way - this is where we define if, when, what, and how data is synced. All process flows installed with this blueprint are shown below.
You'll find installed process flows in the manage process flows area of your dashboard. For product documentation please see Process flows.
A connector is a generic integration of a third-party business system/application. Connector instances (configured by you as part of the blueprint install process, or later via your connectors page), are added to process flows via the connector shape. All connectors installed with this blueprint are shown below.
You'll find installed connectors in the manage connectors area of your dashboard. For product documentation please see Connectors & instances.
Custom scripts are implemented via the script shape, and are typically used when source data needs to be manipulated beyond the capabilities that standard transform functions provide. All scripts installed with this blueprint are shown below.
You'll find installed scripts in the scripts area of your dashboard. For product documentation please see Custom scripting.
Cross-reference lookups are used for cases where some values are commonly known by other terms. If source data includes values that always need to be changed to an alternative term, a cross-reference lookup can be used to transform required data fields (via the map shape). All cross-reference lookups installed with this blueprint are shown below.
You'll find installed cross-reference lookups in the cross-reference lookups area of your dashboard. For product documentation please see Cross-reference lookups.
Caches are specified in the add to cache shape, and used to store data (temporarily) at given points in a process flow. Typically, this is done so the data at that point in time can be referenced later in the same process flow, or by other process flows, via a load from cache shape. All caches installed with this blueprint are shown below.
You'll find installed caches in the data caches area of your dashboard. For product documentation please see Cache shapes.
Data pools are used by the de-dupe shape in process flows. They store unique key field values that have passed through the shape, so subsequent records can be checked and matched for duplication. All data pools installed with this blueprint are shown below.
The Shopify & NetSuite blueprint includes everything you need to sync customer details and orders from Shopify to NetSuite.
Process flows are built to implement powerful data flows between connector instances in an intuitive, visual way - this is where we define if, when, what, and how data is synced. All process flows installed with this blueprint are shown below.
You'll find installed process flows in the manage process flows area of your dashboard. For product documentation please see Process flows.
A connector is a generic integration of a third-party business system/application. Connector instances (configured by you as part of the blueprint install process, or later via your connectors page), are added to process flows via the connector shape. All connectors installed with this blueprint are shown below.
You'll find installed connectors in the manage connectors area of your dashboard. For product documentation please see Connectors & instances.
Custom scripts are implemented via the script shape, and are typically used when source data needs to be manipulated beyond the capabilities that standard transform functions provide. All scripts installed with this blueprint are shown below.
You'll find installed scripts in the scripts area of your dashboard. For product documentation please see Custom scripting.
Cross-reference lookups are used for cases where some values are commonly known by other terms. If source data includes values that always need to be changed to an alternative term, a cross-reference lookup can be used to transform required data fields (via the map shape). All cross-reference lookups installed with this blueprint are shown below.
You'll find installed cross-reference lookups in the cross-reference lookups area of your dashboard. For product documentation please see Cross-reference lookups.
Caches are specified in the add to cache shape, and used to store data (temporarily) at given points in a process flow. Typically, this is done so the data at that point in time can be referenced later in the same process flow, or by other process flows, via a load from cache shape. All caches installed with this blueprint are shown below.
You'll find installed caches in the data caches area of your dashboard. For product documentation please see Cache shapes.
Data pools are used by the de-dupe shape in process flows. They store unique key field values that have passed through the shape so subsequent records can be checked and matched for duplication. All data pools installed with this blueprint are shown below.
Patchworks pulls fulfilled orders from Shopify and the dispatch is then sent to Virtualstock Supplier, with the associated tracking number.
We pull newly updated orders with a fulfilled
or partially-fulfilled
status and filters on source_name
= VS_Patchworks
for sales orders.
The operations count for this process flow is: 2 per fulfillment.
For reference, all shapes in this process flow are documented below. Do not change shape settings unless advised to do so in our installation guide.
This process flow retrieves the product listing associated with the Patchworks sales channel that you , and then updates Virtualstock Supplier with new stock levels:
It's important to ensure that ONLY SKUs that you want to sync with Virtualstock Supplier are associated with the Patchworks app sales channel in Shopify - otherwise processing time will be longer.
Then, Patchworks makes a call to Virtualstock Supplier to retrieve the product by part number (this is needed to obtain the associated URL ID
of the product). We then use the URL ID
to make a second call into Virtualstock Supplier to update the stock level.
The operations count for this process flow is: 3 per sync.
Sales orders are pulled from Virtualstock Supplier and created in Shopify with a paid
and unfulfilled
status. Finally, an acknowledgement is sent back to Virtualstock Supplier.
Any orders with an ORDER
status are pulled from Virtualstock Supplier. Once an order is successfully sent into Shopify, we send an ORDER_ACK
back to Virtualstock Supplier - the order is then moved into ORDER_ACK
status so that it won't be picked up in subsequent flow runs.
The operations count for this process flow is: 4 per order.
The Lightspeed X-Series & Shopify blueprint includes everything you need to sync:
Stock data from Shopify to Lightspeed X-Series
Product data from Shopify to Lightspeed X-Series
Sales order data from Lightspeed X-Series to Shopify
Customer data from Lightspeed X-Series to Shopify
Process flows are built to implement powerful data flows between connector instances in an intuitive, visual way - this is where we define if, when, what, and how data is synced. All process flows installed with this blueprint are shown below.
Script | Summary |
---|---|
Cross-reference lookup name | Cross-reference lookup description |
---|---|
Cache name | Cache type |
---|---|
Data pool name | Unique key | Applicable process flows |
---|---|---|
Script title | Summary |
---|---|
Cross-reference lookup name | Cross-reference lookup description |
---|---|
Cache name | Cache type |
---|---|
Data pool name | Unique key | Applicable process flows |
---|---|---|
Shape | Notes |
---|---|
Script | Summary |
---|---|
Cross-reference lookup | Summary |
---|---|
Any SKUs pulled from Shopify are checked against the and mapped to the relevant Virtualstock Supplier part number.
For reference, all shapes in this process flow are documented below. Do not change shape settings unless advised to do so in our .
Shape | Notes |
---|
Script | Summary |
---|
Cross-reference lookup | Summary |
---|
For reference, all shapes in this process flow are documented below. Do not change shape settings unless advised to do so in our .
Shape | Notes |
---|
Script | Summary |
---|
Cross-reference lookup | Summary |
---|
You'll find installed process flows in the . For product documentation please see .
A is a generic integration of a third-party business system/application. Connector instances (configured by you as part of the , or later via your ), are added to process flows via the . All connectors installed with this blueprint are shown below.
You'll find installed connectors in the . For product documentation please see .
Custom scripts are implemented via the , and are typically used when source data needs to be manipulated beyond the capabilities that standard provide. All scripts installed with this blueprint are shown below.
Script title | Summary |
---|
You'll find installed scripts in the . For product documentation please see .
Cross-reference lookups are used for cases where some values are commonly known by other terms. If source data includes values that always need to be changed to an alternative term, a can be used to required data fields (via the shape). All cross-reference lookups installed with this blueprint are shown below.
Cross-reference lookup name | Cross-reference lookup description |
---|
You'll find installed cross-reference lookups in the . For product documentation please see .
Caches are specified in the and used to store data (temporarily) at given points in a process flow. This means that data from a previous point in time can be referenced later in the same process flow or by other process flows, via a . All caches installed with this blueprint are shown below.
Cache name | Cache type |
---|
You'll find installed caches in the . For product documentation please see .
Data pools are used by the in process flows. They store unique key field values that have passed through the shape so subsequent records can be checked and matched for duplication. All data pools installed with this blueprint are shown below.
Data pool name | Unique key | Applicable process flows |
---|
Format to PVX Data
Format json to Peoplevox data.
Strip Data Array
Strips data array for graphQL request.
Format PVX Event Fulfilment Data
Formats event fulfilment data to line items array.
Set PVX Time Filter
Sets a time filter variable in Peoplevox format.
PVX XML to JSON
Formats Peoplevox data into json.
PVX Returns Combine Report Data Lines
Combines report data by sales order number.
Calculate Shopify Refunds
Calculates refunds from suggested refund data.
Flatten Products
Flattens products to one list of variants.
Generate Sku Query
Generates a Shopify GraphQL query for provided SKUs.
Calculate Inventory Adjust
Calculates inventoryItemAdjustments.
Combine Fulfilment Lines
Combines report data by sales order number.
N/A
This app does not include any cross-reference lookups.
Stock Event Data
Flow run
Original Return Data
Flow run
Original Fulfilment Data
Flow run
Fulfilment Order Line ID
Flow run
Order Data
Flow run
Returns ID
return code
-
-
-
-
Orders
Flow run
-
-
-
Trigger
Having installed the blueprint, edit this shape and define your preferred run schedule. Please see the installation guide for specific notes.
Connector
This shape includes parameters that you should review/update. Please see the installation guide for specific notes.
Source instance
: Shopify
Source endpoint
: GET Retrieve a list of orders
Parameters
: created_at_min
financial_status
status
fulfillment_status
updated_at_min
Filter
There should be no need to change any settings for this shape. For reference, required settings are:
Source instance
: N/A
Source endpoint
: N/A
Filters
: Set as: *.source_name
string
equals
VS_Patchworks
Keep matching
: ON
Flow control
There should be no need to change any settings for this shape. For reference, required settings are:
Source instance
: N/A
Source endpoint
: N/A
Batch level
: *
Batch size
: 1
Script
These settings should not be changed. For reference, required settings are:
Script
: Save Order URI ID to Meta Var
Version
: v5 (latest)
Flow control
There should be no need to change any settings for this shape. For reference, required settings are:
Source instance
: N/A
Source endpoint
: N/A
Batch level
: *.fulfillments
Batch size
: 1
De-dupe
There should be no need to change any settings for this shape. For reference, required settings are:
Source instance
: N/A
Source endpoint
: N/A
Entity
: Fulfillments
Behaviour
: Filter records
Data Pool
: FulfillmentOrder
Key field
: *.id
Behaviour
: JSON
Add to cache
These settings should not be changed. For reference, required settings are:
Cache
: (Flow run) FulfillmentOrder
Cache key
: FulfillmentOrder
Append
: OFF
Save all pages
: ON
Map
Generally, field mappings should not be changed. However please refer to the installation guidelines for this process flow for any fields that are noted for special attention.
Source instance
: None
Source endpoint
: None
Connector
If instance credentials are provided as part of the blueprint installation, there should be no need to change any settings for this shape. For reference, the required settings are:
Source instance
: Virtualstock Supplier
Source endpoint
: POST Dispatch an order
Variables
: Set as OrderURI
/ [[meta.JLorderId]]
Load from cache
These settings should not be changed. For reference, required settings are:
Cache
: (Flow run) FulfillmentOrder
Cache key
: FulfillmentOrder
Fail on cache miss
: OFF
Load all pages
: ON
De-dupe
There should be no need to change any settings for this shape. For reference, required settings are:
Source instance
: N/A
Source endpoint
: N/A
Entity
: Fulfillments
Behaviour
: Track records
Data Pool
: FulfillmentOrder
Key field
: *.id
Behaviour
: JSON
Save Order URI ID to Meta Var
Extracts URI from Shopify notes.
Carrier map
Maps Shopify tracking companies to Virtualstock carriers (and vice versa). You need to update this table with your own values - please see the installation guide for details.
SKU Lookup
Maps Virtualstock Supplier part numbers to Shopify SKUs. You need to update this table with your own values - please see the installation guide for details.
Replace negative qtys with 0 | Replaces negative inventory quantities to zero quantities |
Extract ProductId from URL | Extracts the URI from product details |
Check if customer exists in Shopify | Checks if customers already exist in Shopify. |
Convert Order ID to Metadata | Converts |
Set Inventory ID | Sets |
Set Product ID | Sets |
Set Shopify Customer ID | Sets |
- | - |
Sales Cache | Flow run |
Stock Cache | Flow run |
It is strongly recommended that you provide authentication credentials for Shopify and Virtualstock Supplier connector instances as part of the installation process. This approach means that newly installed process flows are pre-configured with the required instance/endpoint details.
However, if you don't have your credentials but want to install the blueprint anyway (or if you missed this step during installation), you can add instances retrospectively and then update process flows manually.
Step 1 Follow the steps in our Adding an instance guide to add one instance for Shopify and one for Virtualstock Supplier.
Step 2 Access the Orders process flow and edit settings for each connector shape in the flow (there are 4). Ensure that each one is set as per our Orders summary page.
Step 3 Access the Fulfillments process flow and edit settings for each connector shape in the flow (there are 2). Ensure that each one is set as per our Fulfillments summary page.
Step 4 Access the Inventory process flow and edit settings for each connector shape in the flow (there are 3). Ensure that each one is set as per our Inventory summary page.
Step 5 Continue with this installation guide.
Trigger |
Connector |
Script | These settings should not be changed. For reference, the required settings are:
|
Flow control | There should be no need to change any settings for this shape. For reference, the required settings are:
|
Flow control | There should be no need to change any settings for this shape. For reference, the required settings are:
|
Set variables | There should be no need to change any settings for this shape. For reference, the required settings are:
|
Add to cache | These settings should not be changed. For reference, the required settings are:
|
Map |
Filter | There should be no need to change any settings for this shape. For reference, the required settings are:
|
Connector | If instance credentials are provided as part of the blueprint installation, there should be no need to change any settings for this shape. For reference, the required settings are:
|
Add to cache | These settings should not be changed. For reference, required settings are:
|
Load from cache | These settings should not be changed. For reference, the required settings are:
|
Script | These settings should not be changed. For reference, the required settings are:
|
Map |
Connector | If instance credentials are provided as part of the blueprint installation, there should be no need to change any settings for this shape. For reference, the required settings are:
|
SKU Lookup |
Trigger |
Connector | If instance credentials are provided as part of the blueprint installation, there should be no need to change any settings for this shape. For reference, the required settings are:
|
Flow control | There should be no need to change any settings for this shape. For reference, required settings are:
|
Map |
Add to cache | These settings should not be changed. For reference, required settings are:
|
Script | These settings should not be changed. For reference, required settings are:
|
Connector | If instance credentials are provided as part of the blueprint installation, there should be no need to change any settings for this shape. For reference, the required settings are:
|
Add to cache | These settings should not be changed. For reference, required settings are:
|
Load from cache | These settings should not be changed. For reference, required settings are:
|
Script | These settings should not be changed. For reference, required settings are:
|
Connector | If instance credentials are provided as part of the blueprint installation, there should be no need to change any settings for this shape. For reference, the required settings are:
|
Route | If instance credentials are provided as part of the blueprint installation, there should be no need to change any settings for this shape. For reference, the required settings are:
|
(Route 1) Script | These settings should not be changed. For reference, required settings are:
|
(Route 1) Map |
(Route 1) Connector | If instance credentials are provided as part of the blueprint installation, there should be no need to change any settings for this shape. For reference, the required settings are:
|
(Route 2) Connector | These settings should not be changed. For reference, required settings are:
|
Phone Number Formatter | Corrects formatting for UK telephone numbers. |
SKU Search Script | Creates GraphQL input for Shopify. |
Match Shopify Variant Id to SKU | Replaces sales order SKUs with variant Ids. |
Save Order URI ID to Meta Var | Extracts URI from Shopify notes. |
Calculate dispatch date using orderDate |
Carrier map |
SKU Lookup |
Lightspeed Customers | customer email |
The SEKO Logistics & Shopify blueprint includes everything you need to sync:
Inventory data from SEKO to Shopify
Fulfillments from SEKO to Shopify
Sales orders from Shopify to SEKO web sales orders
Process flows are built to implement powerful data flows between connector instances in an intuitive, visual way - this is where we define if, when, what, and how data is synced. All process flows installed with this blueprint are shown below.
You'll find installed process flows in the manage process flows area of your dashboard. For product documentation please see Process flows.
A connector is a generic integration of a third-party business system/application. Connector instances (configured by you as part of the blueprint install process, or later via your connectors page), are added to process flows via the connector shape. All connectors installed with this blueprint are shown below.
You'll find installed connectors in the manage connectors area of your dashboard. For product documentation please see Connectors & instances.
Custom scripts are implemented via the script shape, and are typically used when source data needs to be manipulated beyond the capabilities that standard transform functions provide. All scripts installed with this blueprint are shown below.
You'll find installed scripts in the scripts area of your dashboard. For product documentation please see Custom scripting.
Cross-reference lookups are used for cases where some values are commonly known by other terms. If source data includes values that always need to be changed to an alternative term, a cross-reference lookup can be used to transform required data fields (via the map shape). All cross-reference lookups installed with this blueprint are shown below.
You'll find installed cross-reference lookups in the cross-reference lookups area of your dashboard. For product documentation please see Cross-reference lookups.
Caches are specified in the add to cache shape, and used to store data (temporarily) at given points in a process flow. Typically, this is done so the data at that point in time can be referenced later in the same process flow, or by other process flows, via a load from cache shape. All caches installed with this blueprint are shown below.
You'll find installed caches in the data caches area of your dashboard. For product documentation please see Cache shapes.
Data pools are used by the de-dupe shape in process flows. They store unique key field values that have passed through the shape so subsequent records can be checked and matched for duplication. All data pools installed with this blueprint are shown below.
The Shopify & Virtualstock Supplier blueprint includes everything you need to sync orders, fulfillments, and inventory between Virtualstock Supplier and Shopify. The high-level architecture is illustrated below:
Orders are pulled from Virtualstock Supplier and created in Shopify with a paid
and unfulfilled
status. When a fulfilment partner ships an order in Shopify, Patchworks pulls shipment information and sends this (together with a tracking number) to Virtualstock Supplier. Finally, inventory is synced from Shopify to Virtualstock Supplier.
In Patchworks, an operation is counted whenever a request is made to send or receive a payload to/from an endpoint. The operations count for installed process flows is shown below:
* You can change the frequency at which process flows run - please see our installation guide for details.
Please see our installation guide.
Please see our available process flows section.
Cancellations both from Virtualstock Supplier and From Shopify
Returns/Refunds
Product Creation
Lead Time updates to Virtualstock Supplier
In Shopify, you need to create an app/sales channel for Patchworks and then grant access for Patchworks to access your data. This is completed in two parts:
Part 1: Shopify Admin API scopes. Create a Patchworks app/sales channel and enable general API scopes for Patchworks to access your data.
Part 2: Shopify Storefront API scopes. Enable specific scopes for Patchworks to access products associated with the Patchworks app/sales channel.
Admin API scopes must be set to allow the Shopify connector to access your data via the Shopify Admin API. This is a standard requirement for the Shopify connector, irrespective of whether it's been installed as part of an app or as a standalone connector.
Please follow the steps detailed on our Shopify (prebuilt connector) page under Obtaining credentials, then go to Part 2.
Storefront API scopes are not required for general use but they ARE needed for the Shopify & Virtualstock Supplier blueprint. Please follow the steps below to grant the required access permissions.
Step 1 Still in the Shopify admin portal with your Patchworks app/integration, select the review configuration option from the overview tab:
Step 2 Scroll to the end of the page and select the configure button for Storefront API integration:
Step 3 In the list of scopes, scroll down to the Products section and enable the following three items:
unauthenticated_read_product_listings
unauthenticated_read_product_inventory
unauthenticated_read_product_tags
For example:
Step 4 Save your changes.
Step 5 Go to the next stage.
Cross-reference lookup tables are used to convert given Shopify values to Virtualstock Supplier values. Conversion values are defined here and then called in process flow runs via cross reference lookup transformations applied to field mappings.
The following cross-reference lookup tables are installed as part of the Shopify & Virtualstock Supplier blueprint:
Cross-reference lookup | Notes |
---|---|
You need to update these with your required values. You can add just a few that you know will cover testing requirements and come back to complete these tables later, or you can add everything now - it's up to you.
The steps below show how to update cross-reference lookup tables manually however, you can also import values (recommended for larger updates).
For more information about cross-reference lookups, please see our cross-reference lookups pages.
Step 1 Select process flows > cross-reference lookups from the left-hand navigation menu (or click here). You will see two installed cross-reference tables: Carrier Mapping and SKU Lookup. For example:
Step 2 Click the Carrier Mapping entry to view existing entries for converting Shopify carrier values (on the left) to Virtualstock Supplier carrier values (on the right):
Step 3 Add/update/remove existing entries as appropriate (placeholder values can be edited or removed).
Your Virtualstock Supplier merchant (e.g. John Lewis) should provide your required values.
When we apply this table to a cross-reference lookup field transformation, we can choose whether the conversion is left-to-right or right-to-left.
Step 4 Check the default value and change it as appropriate (leave blank for no default). If you change the default value, click the update button to confirm.
Step 5 Save changes.
Step 6 Navigate back to the Cross-Reference lookups page and click the SKU Lookup entry to view existing entries for converting Virtualstock Supplier part numbers (on the left) to Shopify SKUs (on the right), and versa:
When we apply this table to a cross-reference lookup field transformation, we can choose whether the conversion is left-to-right or right-to-left.
Step 7 Add/update/remove existing entries as appropriate (placeholder values can be edited or removed).
Step 8
Ensure that the default value is set to n/a
. This is important as a subsequent filter will check for this.
Step 9 Save changes.
Step 10 Go to the next stage.
In this stage you will locate the Shopify & Virtualstock Supplier blueprint in the Patchworks marketplace, then configure for required connectors and install the blueprint.
Having completed all the steps detailed below, the Shopify to Virtualstock Supplier blueprint will be installed and all required resources become available in your dashboard. These include:
Step 1 Log in to the Patchworks dashboard and navigate to the .
Step 2 Ensure the is selected, then locate the Shopify & Virtualstock Supplier app:
Having purchased a blueprint from the Patchworks website, it will be available in your apps marketplace within 24 hours.
Step 3 Click the Shopify & Virtualstock Supplier blueprint to view details:
Step 4 Scroll down to the Connectors section and select the Add instance option for Shopify:
...then enter details for the Shopify store that you want to use for testing:
Adding connector instance credentials here saves some time later since this will auto-configure relevant connector shapes in related process flows.
Step 5 Move over to the Virtualstock Supplier connector and select the Add instance option:
...then enter details for Virtualstock Supplier that you want to use for testing:
The Shopify & Virtualstock Supplier blueprint syncs Shopify products associated with your Patchworks sales channel (created in the ). As such, you should ensure that any products you want to sync between Shopify and Virtualstock Supplier are added to this sales channel.
Your Patchworks sales channel should ONLY include products you want to sync between these two systems - adding products that don't need to be synced increases processing time.
Step 1 In Shopify, access your product list and find the first product you want to sync with Virtualstock Supplier.
Step 2 In the Publishing section, select the manage sales channels option:
It doesn't matter if the products you want to sync with Virtualstock Supplier are in other channels too.
Step 4 Repeat steps 1 to 3 for all other products that need to be synced with Virtualstock Supplier.
When you're satisfied that your process flows are working as expected with test credentials, you're ready to go live. This is a two-stage process:
Currently, all connector shapes in your three process flows are configured with authentication credentials for access to sandbox/testing systems. These must now be changed to live/production credentials.
To do this, follow the instructions on to edit your Shopify and Virtualstock Supplier connector instances and apply new authentication credentials for your live/production environments.
Updating existing Shopify and Virtualstock Supplier connector instances with production credentials means you don't have to amend any process flows - the new credentials are applied automatically. This is the quickest and simplest approach.
However, some people prefer to create NEW connector instances with production credentials, so they can switch between the two - they may even duplicate process flows so a 'test' and 'production' version is always available. If you prefer to do this, the following guides may be useful:
Currently, your three Shopify & Virtualstock Supplier process flows are in a draft state, and disabled. For a process flow to run according to your defined trigger schedule, it must be deployed and enabled.
When you are ready, follow the instructions on the pages linked below for all three of your Shopify & Virtualstock Supplier process flows:
In this stage you will access the [[Inventory]] Virtualstock >> Shopify process flow.
Here, we pull products from Shopify (via their ) that are assigned to the Patchworks sales channel - i.e. only SKUs associated with Virtualstock Supplier. This data is manipulated before Virtualstock Supplier part numbers are updated with a free stock
quantity.
The process flow is pre-configured with all required settings, including any connector instances you defined as part of the . On this page, we guide you through recommended checks so you can ensure the flow meets your requirements.
Step 1 Select process flows > process from the left-hand navigation menu (or click ). Your process flow list is displayed - for example:
If you've used Patchworks before installing the Shopify & Virtualstock Supplier blueprint, you might see more process flows than the three shown here.
Step 2 Click the [[Inventory]] Virtualstock >> Shopify entry to open the process flow in edit mode.
The default setting is to run twice per day at 08:05 a.m
. and 06:05 p.m
This schedule is recommended to keep the inventory flow away from times when other process flows may be running since an inventory sync can take longer.
When setting your schedule, keep your rate limits in mind - how many calls can you make to Shopify at one time, and how many calls can you make to Virtualstock Supplier?
Step 4 Access settings for the first connector shape (Shopify) and review/update parameter values:
These parameters are associated with Shopify's Retrieve product listings published to your app endpoint - they determine which products are retrieved.
To be retrieved, a product must match ALL defined parameters.
Click the edit icon associated with each parameter and set it as required. Default settings are:
Before saving/exiting these settings, ensure the source instance is for a test/sandbox environment.
Step 5 Access settings for other connector shapes (there are three in all) and double-check that the source instance is for a test/sandbox environment - for example:
Step 6 When you're satisfied that the flow is ready to test, click the initialise flow button from the actions bar:
The process flow should run and complete successfully. Check that the outcome is as expected in Virtualstock Supplier.
The Veeqo & TikTok blueprint includes everything you need to sync orders from TikTok to Veeqo.
Process flows are built to implement powerful data flows between connector instances in an intuitive, visual way - this is where we define if, when, what, and how data is synced. All process flows installed with this blueprint are shown below.
You'll find installed process flows in the . For product documentation please see .
A is a generic integration of a third-party business system/application. Connector instances (configured by you as part of the , or later via your ), are added to process flows via the . All connectors installed with this blueprint are shown below.
You'll find installed connectors in the . For product documentation please see .
Having installed the app, edit this shape and define your preferred run schedule. The default setting is to run twice per day at 08:05 a.m. and 06:05 p.m. Please see the for specific notes.
This shape includes parameters that you should review/update. Please see the for specific notes.
Source instance
: Shopify
Source endpoint
: GET Retrieve product listings that are published to your app
Parameters
: updated_at_min
Generally, field mappings should not be changed. However please refer to the for this process flow for any fields that are noted for special attention.
Source instance
: None
Source endpoint
: None
Generally, field mappings should not be changed. However please refer to the for this process flow for any fields that are noted for special attention.
Source instance
: None
Source endpoint
: None
Maps Virtualstock Supplier part numbers to Shopify SKUs. You need to update this table with your own values - please see the for details.
Having installed the blueprint, edit this shape and define your preferred run schedule. Please see the for specific notes.
Generally, field mappings should not be changed. However please refer to the for any fields that are noted for special attention.
Source instance
: None
Source endpoint
: None
Generally, field mappings should not be changed. However please refer to the for any fields that are noted for special attention.
Source instance
: None
Source endpoint
: None
Takes Shopify's order created date and adds 5 days to calculate the supplier delivery date. If required, you can change the number of days used for this calculation - please see the for details.
Maps Shopify tracking companies to Virtualstock carriers (and vice versa). You need to update this table with your own values - please see the for details.
Maps Virtualstock Supplier part numbers to Shopify SKUs. You need to update this table with your own values - please see the for details.
Script title | Summary |
---|---|
Cross-reference lookup name | Cross-reference lookup description |
---|---|
Cache name | Cache type |
---|---|
Data pool name | Unique key | Applicable process flows |
---|---|---|
Item | Notes |
---|---|
Process flow | Operations count | Default run frequency* |
---|---|---|
Please see our page for general guidance about adding new instances. For Shopify requirements please refer to our page.
Please see our page for general guidance about adding new instances. For specific Virtualstock Supplier requirements, please see our page.
Step 6 Click the install button at the top of the page to the app:
For guidance on blueprint installation please see our page.
Step 7 Once the blueprint is installed successfully, go to the .
Step 3 Select your Patchworks app/sales channel (created in the ) and save changes:
Step 5 Go to the .
For the first few runs of each process flow, we recommend checking your for warnings and errors - also check Shopify and Virtualstock Supplier to ensure that syncs are being processed as expected.
Step 3 Access settings for the and edit the default schedule to reflect the frequency at which you want this process flow to run:
Parameter | Default setting |
---|
Step 7 Go to the .
Custom scripts are implemented via the , and are typically used when source data needs to be manipulated beyond the capabilities that standard provide. All scripts installed with this blueprint are shown below.
Script title | Summary |
---|
You'll find installed scripts in the . For product documentation please see .
Cross-reference lookups are used for cases where some values are commonly known by other terms. If source data includes values that always need to be changed to an alternative term, a can be used to required data fields (via the shape). All cross-reference lookups installed with this blueprint are shown below.
Cross-reference lookup name | Cross-reference lookup description |
---|
You'll find installed cross-reference lookups in the . For product documentation please see .
Caches are specified in the , and used to store data (temporarily) at given points in a process flow. Typically, this is done so the data at that point in time can be referenced later in the same process flow, or by other process flows, via a . Allcaches installed with this blueprint are shown below.
Cache name | Cache type |
---|
You'll find installed caches in the . For product documentation please see .
Data pools are used by the in process flows. They store unique key field values that have passed through the shape so subsequent records can be checked and matched for duplication. All data pools installed with this blueprint are shown below.
Data pool name | Unique key | Applicable process flows |
---|
Add lineNumber to SalesOrderLineItem and Remove zero qty lines
Add lineNumber
to SalesOrderLineItem
and remove zero quantity lines.
SKU Search Script
Extracts and formats product codes.
GQL Set Onhand Inv Level
Set the Onhand
inventory level input to Shopify GQL.
Add SetQuantities to Stock Update GQL
Add SetQuantities
to stock update GQL
-
-
AvailableStock
Flow run
FulfillmentOrder
Flow run
FulfillmentOrderMulti
Flow run
-
-
-
Virtualstock & Shopify staging/sandbox credentials
Virtualstock Supplier credentials are provided by the associated Virtualstock merchant- e.g. John Lewis.
Virtualstock & Shopify live/production credentials
Virtualstock Supplier credentials are provided by the associated Virtualstock merchant- e.g. John Lewis.
List of all Shopify SKUs and corresponding Virtualstock Supplier part numbers
This will usually be in the form of a spreadsheet that's issued by the Virtualstock Supplier merchant. For example, John Lewis provide a spreadsheet named Smartsheet or JL SKUs. Note: for testing, you only require enough SKUs/part numbers to fulfill required tests.
List of Shopify carriers that will be used for Virtualstock Supplier orders
The Slug for these carriers is usually provided by the Virtualstock Supplier merchant (e.g. John Lewis).
Test scenarios
Some Virtualstock merchants mandate specific test scenarios - for example, John Lewis require three test orders to be processed before live/production credentials are released.
Confirmation of predefined values to be used for acknowledgement back to Virtualstock Supplier.
Supplier_delivery_date
. This is usually orderdate
plus 5-7 days
Fulfillment_route
. This is usually set to Direct to customer
.
4 per order
Every 10 minutes
2 per fulfillment
Hourly
3 per sync
2 x daily
updated_at_min | Retrieves any orders updated in the last |
- | - |
- | - |
- | - |
- | - | - |
SKU Lookup
Convert Virtualstock Supplier part numbers to Shopify SKUs (and vice versa).
In Shopify, the variantId
is used when creating a sales order. Patchworks makes a GraphQL call into Shopify to search for variantId
based on the SKU
, therefore the SKU
must be unique.
Carrier Mapping
Convert your Shopify tracking_company
values to Virtualstock Supplier carrier
values.
The Orders process flow includes a field mapping which takes Shopify's order.created_at
date and (via a script transform function on the mapping row) adds 5 days
before sending this to Virtualstock Supplier as the supplier_delivery_date
.
The 5 days
that gets added here can be changed by amending the script that is used by the script transform function on the mapping row.
The required steps are detailed below:
Step 1 Select process flows > scripts from the left-hand navigation menu (or click here).
Step 2 Click the Calculate dispatch date using orderDate entry:
Step 3
Move down to the code panel and change the existing 5 days
to your required number:
Do not make any other changes!
Step 4 Save and deploy the script:
Step 1 Select process flows > process flows from the left-hand navigation menu (or click here).
Step 2 Access the Orders process flow.
Step 3 Scroll down the flow and access settings for the LAST map shape:
Step 4
Click the transform icon associated with the order.created_at
> supplier_delivery_date
row:
Step 5 Click the edit icon associated with the other script function:
Step 6 Select the latest version of the Calculate dispatch date using orderDate script:
Step 7 Accept changes and save the shape.
In this stage you will access the [[Orders]] Virtualstock >> Shopify process flow.
The process flow is pre-configured with all required settings, including any connector instances you defined as part of the installation stage. On this page, we guide you through recommended checks so you can ensure the flow meets your requirements.
Step 1 Select process flows > process from the left-hand navigation menu (or click here). Your process flow list is displayed - for example:
If you've used Patchworks before installing the Shopify & Virtualstock Supplier blueprint, you might see more than the three process flows shown here.
Step 2 Click the [[Orders]] Virtualstock >> Shopify entry to open the process flow in edit mode.
Step 3 Access settings for the trigger shape and edit the default schedule to reflect the frequency you want this process flow to run:
For guidance on defining trigger schedules, please see our Trigger shape page.
Any schedule you define here won't affect the number of new orders received - just how frequently you collect them.
New orders are determined by order status (rather than any time-based conditions). When the process flow runs, any orders with an ORDER
status are pulled from Virtualstock Supplier and sent into Shopify - you can see this if you check the settings for the first connector shape in the flow:
When this operation is completed successfully, the order changes to an ORDER_ACK
status, so it will never be picked up again in subsequent flow runs.
Step 4 Access settings for the first map shape and scan down the list to ensure the default settings meet your requirements. Here we are mapping FROM Virtualstock Supplier TO Shopify.
Generally, default mappings do not need to be changed however, the following fields should be checked with particular care and changes can be made if necessary:
The following fields must NOT be changed:
Order Line Properties
Order notes
Order source_name
If you would like to map additional fields (for example, billing address), this is fine. For guidance on defining field mappings, please see our Working with field mappings page.
Step 5 Access settings for the second map shape and scan down the list to ensure the default settings meet your requirements. Here we are mapping FROM Shopify TO Virtualstock Supplier.
Generally, default mappings do not need to be changed however, the following fields should be checked with particular care:
It should not be necessary to map additional fields here.
Step 6 In Virtualstock Supplier, make sure you have some test orders (with an ORDER status) using part numbers that you added to the SKU lookup table previously.
Step 7 Access settings for every connector shape in the flow (there are four) and double-check that the source instance is for a sandbox environment - for example:
Step 8 When you're satisfied that the flow is ready to test, click the initialise flow button from the actions bar:
The process flow should run and complete successfully. Check that the outcome is as expected in Shopify and Virtualstock Supplier.
Step 9 Go to the next stage.
Field | Notes |
---|---|
Field | Notes |
---|---|
Order.Inventory_behaviour
This affects your Shopify stock levels, and whether or not you will allow Shopify to receive the order if Shopify is out of stock. The default setting is: decrement_obeying_policy
. For more information, please see Shopify's API documentation.
part_number
> variant_id
This field mapping uses a cross-reference-lookup transform function to convert Shopify SKUs to Virtualstock Supplier part numbers. Make sure that your SKU Lookup cross-reference table has been updated accordingly.
supplier_delivery_date
The supplier delivery date is generated using a script transform function on this field. Here, we call the Calculate dispatch date using order date script, which calculates the supplier delivery date by adding a given number of days to the order creation date.
By default, 5
days are added. If you want to change this value, see Changing the supplier delivery date calculation.
Fulfillment_route
This attribute is used to send an acknowledgement back to Virtualstock Supplier after an order is created in Shopify.
By default, a custom string transform sends a text value of: Direct to customer
. If necessary, you can change this value by editing the transform function. For guidance, please see our Working with field mapping transforms page.
In this stage you will access the [[Fulfillments]] Virtualstock >> Shopify process flow.
This flow assumes that the sales order is now in Shopify, and has been picked, packed, and shipped by the warehouse (with a tracking number). Now, Patchworks picks up any shipped or partially shipped orders from Shopify, sending tracking IDs and expected delivery dates to Virtualstock Supplier.
The process flow is pre-configured with all required settings, including any connector instances you defined as part of the installation stage. On this page, we guide you through recommended checks so you can ensure the flow meets your requirements.
Step 1 Select process flows > process from the left-hand navigation menu (or click here). Your process flow list is displayed - for example:
If you've used Patchworks before installing the Shopify & Virtualstock Supplier blueprint, you might see more process flows than the three shown here.
Step 2 Click the [[Fulfillments]] Virtualstock >> Shopify entry to open the process flow in edit mode.
Step 3 Access settings for the trigger shape and edit the default schedule to reflect the frequency at which you want this process flow to run:
The default, hourly schedule is recommended but if you change this setting, be sure to check the updated_at_min
parameter in the connector shape to align with this (see next step). For guidance on defining trigger schedules, please see our Trigger shape page.
Step 4 Access settings for the first connector shape (Shopify) and update parameter values:
These are parameters associated with Shopify's Retrieve a list of orders endpoint - they determine which orders are retrieved.
To be retrieved, an order must match ALL defined parameters.
Click the edit icon associated with each parameter and set it as required. Default settings are:
Step 5 Access settings for the map shape and scan down the list to ensure that the default settings meet your requirements. Here we are mapping FROM Shopify TO Virtualstock Supplier.
Generally, default mappings do not need to be changed however, the following fields should be checked with particular care:
It should not be necessary to map additional fields here.
Step 6 Access settings for the Virtualstock Supplier connector shape and double-check that the source instance is for a sandbox environment - for example:
Step 7 When you're satisfied that the flow is ready to test, click the initialise flow button from the actions bar:
The process flow should run and complete successfully. Check that the outcome is as expected in Shopify and in Virtualstock Supplier.
Step 8 Go to the next stage.
Parameter | Default setting |
---|---|
Field | Notes |
---|---|
created_at_min
Retrieves any orders created in the last 10 days
.
updated_at_min
Retrieves any orders updated in the last 1 hour
. So, we are retrieving orders created in the last 10 days (see above) but ONLY if they have been updated in the last hour.
This parameter is set on the basis that the process flow runs every hour - if you changed your schedule frequency in Step 3, you should update this value accordingly.
financial_status
Retrieves any orders with a financial status of paid
.
status
Retrieves any orders with a status of any
.
fullfillment_status
Retrieves any orders with a fulfillment status of shipped,partial
(covering cases where complete orders are shipped and where partial orders have been shipped).
tracking_company
> carrier
This field mapping uses a cross-reference-lookup transform function to convert Shopify tracking company values to Virtualstock Supplier carrier values. Make sure that your Carrier Mapping cross-reference lookup table has been updated accordingly.
supplier_dispatch_date
No checks/changes are required but it's worth noting that the Virtualstock Supplier supplier_dispatch_date
is set to the Shopify fulfillment created_at date
.
supplier_delivery_date
The supplier delivery date is calculated using a custom dynamic date transform function. The default is 3 days
on from Shopify's fullfillment created_at
date. If required, you can edit this transform function and change the number of days used for this calculation.
For more information please see our Working with field transformations page.
Sync sales orders, fulfillments, and inventory between Shopify and Virtualstock Supplier.
is the Warehouse Management System for eCommerce businesses, online retailers and direct to consumer brands.
is a cloud-based, fully hosted commerce platform which can be used to create and manage online stores.
(formerly Vend) is a retail POS, inventory management, and eCommerce solution.
is a cloud-based, fully hosted commerce platform which can be used to create and manage online stores.
is a cloud-based solution that helps businesses manage all aspects of their operations.
is a cloud-based, fully hosted commerce platform which can be used to create and manage online stores.
is a cloud-based, fully hosted commerce platform which can be used to create and manage online stores.
provides complete supply chain solutions, specialising in transportation, logistics, forwarding and warehousing.
by Amazon is multichannel shipping software with discounted rates, automation and inventory control.
is an eCommerce solution integrated within TikTok, enabling merchants and creators to showcase and sell products.