Shopify Version Upgrade Process

The following steps describe how to update the Shopify Connector.

1. Please make sure that your CIC Studio version is compatible with the Shopify Connector upgrade.

   The following CIC Studio versions are supported for the upgrade:

   • CIC 2023: Supported for v5.2.4 and later.
   • CIC 2020: Supported for v5.1.17 (including the latest patch).
   • CIC: Private Cloud Edition - Clarify: Supported for v5.1.18 and later.

   Please install an updated version of Studio if you do not have a supported CIC Studio version.

2. Update the Connector to the latest version.

   Notes:

   • It is recommended to make a backup copy of the existing connector project before updating.
   • Should the connector project update fail, then delete the existing connector project from the workspace, and create a new connector project.
   • Once the connector project has been updated, there may be errors in some existing integration projects within the workspace; the user will need to update the specific flows accordingly.
3. Provide access to Customer Data. Please refer to these steps provided by Shopify.

Changes to frequently used APIs

Since Shopify has introduced mandatory changes, impacted integration flows will have to be updated to meet business requirements. This section describes some of the impacts to integration flows, properties & endpoints from an Order to Cash cycle perspective for the Shopify Connector. For complete details, please refer to the Shopify Documentation.

Fulfillment

The following resource has changed. Please ensure that the required parameters are passed.

GetFulfillmentOrderList: Pass additional parameters “include_financial_summaries” and “include_order_reference_fields” with values accordingly.

Summary of changes introduced by Shopify (since previous Connector release in 2023)

Breaking Changes

2023-04

1. Requests for Transaction will now return total_unsettled_set. This represents the remaining amount to be captured on the transaction. total_unsettled_set is returned in both shop and presentment money objects with currency. If you are leveraging manual capture and the authorized amount from Transaction, then you should switch to referencing total_unsettled_set. The authorized amount can differ from the total amount to capture due to adjustments during order finalization such as tax adjustments.
2. When requesting the Asset API, access to create, update, and delete assets is no longer accessible for public apps. Refer to this guide for more details on the change, exemptions, and how to migrate your apps.
3. The following properties have been removed from the Order resource: (Verify with actual response).

• • gateway
  • payment_details
  • Processing_method

2023-7

1. As of API version 2023-07, we're deprecating creating app credits through the Admin API. Both the REST resource and the GraphQL mutation include the capability to create app credits deprecated. Going forward, you should create app credits using the appCreditCreate mutation in the Partner API. This change allows Shopify to implement new features for app credit creation, such as allowing Partners to issue credits to stores that have uninstalled their app.
2. As of API version 2023-07, we're deprecating the order shipping line delivery_category property. The property hasn't been in use since 2020-06-12 and will no longer be present.

2023-10

1. As of API version 2023-10, the UsageCharge resource's billing_on property is deprecated.

2024-01

1. We have removed the following deprecated properties on the Order and Customer resources:

• • accepts_marketing
  • accepts_marketing_updated_at
  • marketing_opt_in_level

Removed Fields

2023-04

1. The following properties have been removed from the Order resource:

• • gateway
  • payment_details
  • processing_method

2023-07

1. As of API version 2023-07, we're deprecating creating app credits through the Admin API. Both the REST resource and the GraphQL mutation include the capability to create app credits deprecated. Going forward, you should create app credits using the appCreditCreate mutation in the Partner API. This change allows Shopify to implement new features for app credit creation, such as allowing Partners to issue credits to stores that have uninstalled their app.
2. As of API version 2023-07, we're deprecating the order shipping line delivery_category property. The property hasn't been in use since 2020-06-12 and will no longer be present.

2023-10

1. As of API version 2023-10, the UsageCharge resource's billing_on property is deprecated.

2024-01

1. We've removed the following deprecated properties on the Order and Customer resources:

• • accepts_marketing
  • accepts_marketing_updated_at
  • marketing_opt_in_level