Shopify API / Connector Upgrade Guidelines (Jan 2024)

First published on: 01/23/2024/7:42 pm

Overview

Shopify has deprecated certain fields from their Order API version 2023-01 onwards : 

• gateway 

• payment_details 

• processing_methods 

The properties 'gateway' and 'payment_details' can now be accessed through the corresponding Transaction API. 

The Saltbox Shopify Connector has already been made compatible with this change, and there is no mandatory upgrade for the connector itself. However, certain mapping adjustments are necessary to accommodate these API changes. This document provides guidance on upgrading the Shopify API version within the Saltbox project and outlines the required mapping upgrades for the Order workflow. 

This Shopify API upgrade will impact the following workflow: Getting Shopify Order. 

Some fields have been moved and a mapping upgrade is required. 

All Saltbox customers with an active Shopify connection have already or will be impacted. Failure to upgrade customer environments may lead to failed workflows. 

Projects in the implementation phase will also need to undergo the necessary upgrades.

Step 1: Project Backup

To ensure safekeeping of the Saltbox development and production projects, it is advisable and considered standard practice to create a backup. 

1. Click Export and Download Project.

2. Select all the workflows and click Export project. 

Step 2: Connector Upgrade (Optional)

Upgrade Saltbox Shopify connector to version 3.6.0 (Optional) 

Step 3: Connector Configuration Upgrade

To upgrade to the latest version of Shopify API (2024-01), change the base URL located on the Shopify connector configuration page and test the connection. 

Step 4: Workflow Upgrade

It is recommended to disable the workflows prior to making changes to ensure that customer data remains unaffected and to prevent any potential errors. Be sure to restart the engine after activating or deactivating workflows.

SHOPIFY ORDERS 

Workflows that are affected include, but are not limited to: 

• Shopify Order to SAP B1 Order

Impacted Data Source (Workflow Trigger): 

• Get a List of Orders 

During the process of generating an Incoming Payment in SAP B1, the integration workflows utilize the 'gateway' and 'payment_details' sections retrieved from the Shopify API. 

Old Version (2023-01 or older version)

payment_detail and gateway were related to orders element. 

New Version (2024-01 or later version)

In order to obtain the payment details and gateway information using the updated Shopify API version, please ensure to enable the 'Include Payment Transactions' checkbox on the workflow trigger page. 

With the new Shopify API version, ‘payment_details’ and ‘gateway’ are related to transactions element. 

In light of the hierarchical adjustments made to these fields, it is necessary to upgrade the corresponding workflow action mapping accordingly. 

Step 5: Test Workflow(s)

It is recommended to perform thorough testing and monitoring of all workflows running on the Saltbox integration project subsequent to the workflow mapping upgrades. In the event of any concerns or issues, please do not hesitate to contact the Saltbox Product Success team. 

Previous

Next