What & Why

At around midnight 19th July 2023 Shopify introduced an undocumented change/bug which causes orders to stop downloading.

The issue has been reported by other users here and here.

To workaround this issue we have issued a new Shopify connector.

Who needs to update?

If you are using IMan to integrate with Shopify, it is likely that you will need to update your Shopify connector.

How to Apply The Update

Download, unblock, unzip and apply the attached connector for IMan 5.1 using the install instructions – replacing the existing Shopify connector.

Updating the Order Reader

The patched connector does half the job.

The Order Reader must be updated also to set the Financial Status parameter to eiother paid OR paid,unpaid. For each integration with an Order Reader:

  • Load the integration and go to the Transform Setup tab.
  • Open the Order Reader by double clicking it.

  • Change the financial status parameter to one of the two values: paid – this change does mean that orders without paid status will not be downloaded OR unpaid,paid – if the previous status was either empty or ‘any’.

  • Press Apply, close the screen.
  • Save the integration to commit the changes.

Resetting the Last Run Date

It is likely that no orders have downloaded since Shopify introduced the issue. You will need to reset the last run date, for the orders to pick up any missed ones.

What & Why

Shopify have been implementing two new features:

These two features necessitate changes to the Shopify connector.

Who needs to update?

If you are using IMan to integrate with Shopify, it is likely that you will need to update your Shopify connector.

You will be supplied a new connector.

We will providing connectors for v4.2 and v5.1 – Customers on v5.0 will need to upgrade to 5.1.

Private App & Token Based Authentication

To comply with the token authorisation we have added the ability for the connector to continue to authenticate using the old Basic Auth/Private App method and the new method.

Customers do not need to update to the newer Token based authentication, but we recommend doing so.

Fulfillment Changes

The new fulfilment handling will be transparent, requiring no changes to the IMan configuration.

The only potential issue is where the translation process (as described in the Fulfillment API documentation linked above) may fail.

The newer fulfillment method requires read/write to the fulfillment services APIs – This may require creating a new private app with those permissions.

What & Why?

Shopify have evolved and refined their API over the last couple of years. We need to issue a new connector in a response to this evolution of the Shopify API.

We typically try to keep you/your sites are stable as possible, but a change to Shopify’s Paging mechanism requires this update and a possible IMan upgrade.

What do I need to do?

You will need to upgrade to the latest IMan version IMan v4.1 PU5 (other product updates for v4.1 may function, but we have not tested).

Take the Shopify connector provided by ourselves, test and deploy.

When do I need to do this?

For those customers using the Product Variant download you must complete the update by 31st March 2020.

Otherwise you have until 30th June 2020.

If you do not upgrade your Shopify integration will stop functioning.

Are there any breaking changes?

The biggest area of change is to the Order download. There have been multiple generations of changes to the Order download, with new fields being added. We don’t believe there are breaking changes, so existing integrations should continue to function. However it is your responsibility to test, check and modify any integration to respond to those changes.

Are there any Improvements

Yes!

  • Dependent on the version of your connector there may be additional Shopify touchpoints you can take advantage of.
  • The order download has had many fields added: more shipping fields; inclusion of payments; various discount fields; tax fields and adding of presentment amounts for currency type fields.

Upgrade Steps

  • Upgrade IMan to v41 PU5 (if required). Use our Upgrade FAQ if you are not familiar with the process.
  • Install the Shopify connector (use the Apply Patches FAQ). The new connector is versioned. The System Connector will need to be changed use the new version.
  • Test and change any integrations.

There may be a possibility to retain your existing (set of) System Connectors pointed to the old connector whilst having a new (set of) System Connectors pointed to the new (versioned) connector. You could then migrate the integration from the old to the new one at a time.

If adopting this approach please exercise caution since the schemas between the versions are different.

Can I have a test license?

No, unless you/your client has purchased one.

Lookups

Any lookups to Shopify stores should continue to function. Shopify will use the oldest active API version if the URL used in the lookup does not included a version.

If you wish to ensure consistent behaviour we recommend you pinning the lookup to a specific version by adding it to the URL.

What & Why

Shopify introduced a breaking to the Shopify API requiring an update to the Shopify connector.

More information about the change can found here.

Who needs to update?

You will know if you need a new connector as the store owner will have been sent an ‘Action Required’ email similar to the one below.

Shopify should also alert you to the required change through the Shopify Admin backend.

This change will only be affecting some of our customers as we have been providing a compatible connector for several months.

Versions & Compatibility

We have released updated connectors for three versions of IMan.

If you are running IMan version 3.2 or earlier you will need to upgrade IMan to the latest version.

Steps to Update

  • Download the relevant connector per your IMan version.
  • Install the new connector per the Apply patch FAQ.
  • To verify connectivity try downloading orders in the Preview.
  • If this is successful, we recommend performing a full order cycle (dependent on your integration). Download an order (or orders). If successfully then run a fulfilment upload.
  • Finally test any other Shopify integrations (such as inventory, product, pricing sync’s).

Annnouncement

On 1st August 2018, Shopify will alter their API to support inventory in multiple locations.

This change is breaking such that existing integrations that update inventory will no continue to update inventory.

Prior to this change inventory updates could be done as part of a broader update to products and product_variants.

A full discussion on the changes can be found on the Shopify site.

A guide on how inventory can be updated using IMan can be found in the Shopify documentation.

Please be aware the inventory update will now be separate to any other product update and may require additional integrations.

This also requires an update Shopify connector found below:

Connectors can installed per the patch instructions.

We will not be releasing an update to IMan versions 3.0 and below.

Contact

Realisable Software Ltd provides code-free, cost-effective applications integration solutions for SMEs. Our core IMan product is designed to integrate almost any application with a number of Sage solutions and online payment processors.

Looking to purchase IMan, please see our resellers here.

Realisable Software
Ph: +44 (0) 208 123 1017

Copyright © Realisable. All rights reserved.
Realisable is a registered trademark

Close

Request Demo

Realisable Software Ltd provides code-free, cost-effective applications integration solutions for SMEs. Our core IMan product is designed to integrate almost any application with a number of Sage solutions and online payment processors.

Looking to purchase IMan, please see our resellers here.

Realisable Software
Ph: +44 (0) 208 123 1017

Copyright © Realisable. All rights reserved.
Realisable is a registered trademark

Close

Access Downloads

Realisable Software Ltd provides code-free, cost-effective applications integration solutions for SMEs. Our core IMan product is designed to integrate almost any application with a number of Sage solutions and online payment processors.

Looking to purchase IMan, please see our resellers here.

Realisable Software
Ph: +44 (0) 208 123 1017

Copyright © Realisable. All rights reserved.
Realisable is a registered trademark

Close