Required updates for Shopify APIs (2020-01: API version)

Stephen Brandt

Updated May 01, 2025 18:01

Note

This article applies to custom Shopify integrations built in integrator.io. No changes are required for the

Shopify released a quarterly API update with changes affecting versioning and pagination. (Pagination is already handled by integrator.io and does not require any changes to your integrations.)

The new Shopify version requirement will affect all integration flows that use the old Shopify APIs. If you are impacted by these changes, follow the steps below to enable compliance in your Shopify connections, exports, and imports.

Tip

According to Shopify,

A new API version [is released] every three months at the beginning of the quarter. Version names are date-based to be meaningful and semantically unambiguous (for example, 2020-01).

Back up search parameters

Before making any changes to your flows below, save a copy of the Search parameters in all of your exports and imports:

Copy the value for each setting and paste it into a new document

– or –
Record a screen capture of each dialog (Ctrl+PrtSc on a PC; Command+Shift+3 on a Mac) and paste each image into a new document

Modify the flows

Add the API version to your Shopify connection and reauthorize it.
Update the description in your Shopify flow exports and imports.
Go back to the updated flow and add the Query parameters that you saved.
Run each flow to make sure it is querying the Shopify API without errors.

1. Add the API version to your Shopify connection and reauthorize it

Previously, the Shopify connection did not require a Version field (shown below):

OAuth 2.0 authentication (old)

Basic authentication (old)

Now, you will see a Version field when setting up or editing the connection, to comply with the Shopify API changes.

Select the version number, according to the new requirement, and reauthorize the connection. By default the value of this field will be 2020-07.

OAuth 2.0 authentication (new)

Basic authentication (new)

2. Update the description in your Shopify flow exports and imports

The next step requires you to update each Shopify export and import, by making a minor change to its description and saving it. Editing the Shopify resource forces it to apply the new connection and update the schema for the new Shopify API version.

Open an export or an import and edit the Description field, simply by adding a space character ( ), for example. Click Save, and repeat for every Shopify export and import in all of your flows.

3. Go back to the updated flow and add the Query parameters that you saved

Open each export and import that you updated above, and click Configure search parameters. At this point, the Search parameters are now empty for all fields.

Return to the Search parameters that you stored earlier in Back up search parameters . Restore each setting in the export or import and click Save.

4. Run each flow to make sure it is querying the Shopify API without errors

Review and retry the steps above, if you’re experiencing problems connecting or with the flow of data.

If you have questions or need help, contact customer support.