Shopify Fulfillment API deprecation¶
Summary¶
Shopify has announced it is deprecating some endpoints on its Fulfillment API on June 30, 2023.
Customers with Integration Studio projects using the deprecated Fulfillment API endpoints must make configuration changes as soon as possible, or operations using the deprecated API endpoints will begin failing after June 30, 2023.
Note
Shopify had previously announced a deprecation date of March 31, 2023, which was later extended to June 30, 2023.
Impacted projects and required user action¶
Integration Studio projects using the Shopify connector are impacted if both of these conditions are met:
- The Shopify connection is configured with API version 2022-04.
- Shopify Create or Update activities associated with that connection are configured with deprecated Fulfillment API endpoints.
Follow these steps to determine if your projects using the Shopify connector are impacted and take the required user action:
-
Check the API version being used by each Shopify connection under Optional Settings > API Version.
If the selection is API version 2022-04, proceed to the next step. Otherwise, the project is not impacted.
Note
It is not required to change the selected API version to a later version, as calls to the 2022-04 API version will automatically be redirected by Shopify to the next oldest supported version. However, if you choose to change the selected API version at this time, see additional considerations in Change the API version.
-
Open each Shopify Create or Update activity being used by the connection and check whether the following objects and sub-objects are selected.
If present, change the object / sub-object selection as follows:
Shopify Activity Deprecated Object > Sub-object Recommendation Create Shipping and fulfillment > Fulfillment Change the selection to Shipping and fulfillment > Fulfillment for Fulfillment Order Create Shipping and fulfillment > Fulfillment Complete Note
These sub-objects do not have a direct replacement API endpoint. For recommendations see Shopify's migration guide Migrate to fulfillment orders.
Create Shipping and fulfillment > Open Fulfillment Update Shipping and fulfillment > Fulfillment -
Once the configuration changes are made, you must redeploy the affected operations for the changes to take effect.
Note
Integration Studio projects interacting with Shopify's APIs directly, such as by using the HTTP or HTTP v2 connector, may also be impacted. We recommend reviewing Shopify's migration guide Migrate to fulfillment orders to determine whether your projects are affected and make the appropriate updates.
If required user action is not taken¶
After June 30, 2023, Shopify API calls to the 2022-04 API version will be redirected by Shopify to the next oldest supported version, as Shopify automatically does that for calls of unsupported API versions.
Because the API versions after 2022-07 do not support the deprecated Fulfillment API endpoints, Integration Studio operations that are deployed with the deprecated Shopify API endpoints will begin failing after June 30, 2023. Errors returned from the Shopify API will be reported in the operation logs.