Shopify Version Upgrade Process (2024-10 Release)

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.

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.

2024-04

Deprecations

• Checkout Resource
• OrderRisk Resource

Breaking Changes

• Fulfillment request validation:
  • You can no longer have multiples of the same fulfillment_order_id within the line_items_by_fulfillment_order parameter, for POST calls to the REST Admin API that create a fulfillment for one or many fulfillment orders.

2024-07

Deprecations

• Country Resource
• Province Resource

Breaking Changes

• Shopify Payment Transactions resource now returns the adjustment_reason property to describe the reason an adjustment was made.

2024-10

Breaking Changes

• If your app retrieves a Location resource, then you need to request the read_locations access scope.
• You can now refund multiple shipping lines using the Refunds resource in the REST Admin API.
• The merchant_business_entity_id property has been added to Order resource.