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, and endpoints from an Order-to-Cash cycle perspective for the Shopify Connector. For additional details, please refer to the Shopify Documentation.

Orders

The below resource has changed; please ensure that the required parameters are passed.

• GetOrdersRequest: Pass an additional parameter ContentType with the value application/json
  
  

Products

The below resource has changed; please ensure that the required parameters are passed.

• GetProductsRequest: Pass an additional parameter ContentType with the value application/json

Inventory

The below resource has changed; please ensure that the required parameters are passed.

• GetLocationsRequest: Pass an additional parameter ContentType with the value application/json

Shipping and Fulfillment

The behavior of the Fulfillment APIs has changed; please ensure that the implementation of fulfillment is updated, as described  below:

• CreateOrderFulfilmentRequest cannot be utilized directly with only the Order ID, as Fulfillment Order ID and Fulfillment Line Item ID are mandatory fields. Below are steps to create a fulfillment request:
  • Use GetFulillmentOrderRequest and pass the Order ID to retrieve the Fulfillment Order ID and Fulfillment Line Item ID.
  • Then, use CreateOrderFulfillmentRequest and pass Fulfillment Order ID and Fulfillment Line Item ID in the request body to create the Fulfillment.
  • Refer to Shopify documentation for additional information.