Jan 27, 2025 - Action required: New Shopify API
Action required: New Shopify API
Jan 27, 2025
As of the 27th of January, Channable will migrate to Shopify’s new API, as the current version is being deprecated. If you have a Shopify connection that uses any of the fields outlined in this article, you need to take action now to prevent product or project issues.Affected fields
Channable field name | Old format - example value | New format - example value |
created_at | '2020-08-13T09:50:02-04:00' | '2020-08-13T13:50:02Z' |
published_at | '2020-08-13T09:50:02-04:00' | '2020-08-13T13:50:02Z' |
parent_created_at | "web" | None - field deprecated |
published_scope | "web" | None - field deprecated |
grams | 10 | None - field deprecated |
inventory_management | "shopify" | None - field deprecated |
price_{currency_code} | '21.50' | The deprecated price_eur field |
shipping_weight | 10g | 10GRAMS |
fulfillment_service | "manual' | None - field deprecated |
What you need to do
- Step 1: Refresh your Shopify connection to allow Channable permission to use Shopify’s new APIs
- Step 2: Re-map or edit affected fields in Channable (only possible from the 27th of January)
Step 1: Refresh your Shopify connection
Refresh your Shopify connection by following these steps:
- Go to Company settings > Connections and locate your Shopify connection.
- Click Edit.
- Click Refresh connection. You’ll be taken to Shopify.
- Sign in to Shopify.
- Accept the access scopes that Channable has requested access to.
Note: If you do not receive a prompt to grant permission when you are redirected to Shopify, please verify if you have the right permissions in Shopify as described here. - You will be redirected back to Channable. Click Create to replace your existing Shopify connection with the new one.
Your Shopify connection will be refreshed. If your connection refresh is successful, "read_locations" will be present at the field Scope.
Step 2: Re-map or edit affected fields
Once you have refreshed your Shopify connection, you need to re-map or edit the affected fields.
The exact action that you need to take depends on the fields that you use, and what the update to the Shopify API has changed.
The deprecated 'price_currency' field
price_usd
and price_gbp
will be imported automatically and Channable will automatically re-map these fields. You only need to complete this step if you use the price_eur
field or any other custom price currency field. Option 1
- Go to Setup and locate your Shopify import.
- In the ‘Edit’ column, click Edit mapping.
- Map one of the new currency fields to each of the old fields. Each 'Project field' can only be mapped to one 'Import field'.
Option 2
- Find all of the locations where the deprecated
price_eur
field is in use. - Each time the
price_eur
is used, select one of the new price_{country_code} fields.
Note: If we do not support a price field for the country you want to select, please contact Support and we will be able to assist you with the setup.
Other deprecated fields
The following fields have been deprecated by the update to the Shopify API:
- published_scope
- grams
- inventory_management
- price_{currency}
These fields will be automatically removed from any Shopify imports, so you do not need to re-map these.
However, if these fields are used in any rules/AI rules/exports, you will need to modify or remove them from those places. Otherwise, the export/rule/AI rule will fail when the Shopify API migration takes place.
New value formatting for some fields
The values of the following fields will be automatically reformatted:
-
created_at
,published_at
,parent_created_at
: Values will no longer be localized, but be in the UTC timezone. For example a value will change from '2020-08-13T09:50:02-04:00' to "2020-08-13T13:50:02Z" -
Shipping_weight
: Weight notation will no longer be abbreviated, but written out in all caps. For example, a value will change from "10g" to "10GRAMS" or "2kg" to "2KILOGRAMS"