本記事について
本記事では、Shopify連携におけるAPIのバージョンアップについての影響や、必要な対応について紹介しています。
リリース内容
リリースの概要
Shopify連携で利用しているAPIのバージョンアップを実施します。
[参考]リリースの背景
Shopify連携で利用しているAPI(REST API)が、2025年4月1日(火)以降にShopifyのサポート対象外となるためです。
必要な対応について
貴社で必要な対応
現時点で、貴社で実施する必要のある対応はありません。
ただし、今後実施していただく必要のある対応が出てくる可能性がございます。
弊社の対応
対応の概要
b→dash(弊社)側では、以下2つの対応を実施します。
❶ リリースの対応
❷ リリースの影響を受けるデータの加工と差し替え
対応の詳細
❶ リリースの対応
「2 リリース内容」をご参照ください。
❷ リリースの影響を受けるデータの加工と差し替え
❶の対応に伴って、以下4つの影響があります。
1.カラムの追加
2.カラムの値を取得できない
3.カラムの値の形式変更(※1)
4.オブジェクトの更新停止(※2)
「2.カラムの値を取得できない」という影響に関して、リリース後も代替のカラムの値を取得することができるように、
弊社側でデータ加工および後続データの差し替えを行います。
該当のお客様には、弊社カスタマーサクセス担当より別途ご連絡しております。
(※1)「3.カラムの値の形式変更」は、形式が大きく変わるカラムがありますのでご注意ください。
詳細は、『❸ カラムの値の形式変更』をご参照ください。
(※2)「4.オブジェクトの更新停止」は、後続データの利用がないため、影響はございません。
対応のスケジュール
・リリース前:代替のカラムの値を取得できるよう、データ加工および後続データの差し替えを行います。
・リリース後:バージョンアップされたAPIでデータを連携し、
既存データのエラーやリリース前に実施した対応が、正しく反映されていることを確認します。
[参考]リリースの対応に伴う影響の詳細
リリースの対応に伴う影響の詳細については、以下をご参照ください。
❶ カラムの追加
『OrdersItems』オブジェクト、『PayoutTransactions』オブジェクトにおいて、取得できるカラムが追加されます。
追加されるカラムは、以下の表をご参照ください。
# | オブジェクト名 | カラム名 | 備考 |
1 | OrdersItems | CurrentQuantity | - |
2 | PayoutTransactions | AdjustmentReason | - |
❷ カラムの値を取得できない
『InventoryItems』オブジェクト、『Products』オブジェクト、『ProductVariants』オブジェクトの”一部のカラム”において、値を取得できなくなります。
対象のカラムは、以下の表をご参照ください。
# | オブジェクト名 | カラム名 | 備考 |
1 | InventoryItems | CountryHarmonizedSystemCodes |
代替の方法で値を取得できないため、カラムを残したまま、
「空白」が格納されます。 |
2 | Products | Images |
『Products』オブジェクトと『ProductImages』オブジェクトを統合し、
『Products』オブジェクトの「Images」カラムに、 『ProductImages』オブジェクトの「src」カラムの値が格納されるように対応します。 また、後続のデータを差し替えることで、 「src」カラムの値を「画像URL」として利用できるようにします。 |
Options |
『Products』オブジェクトと『ProductOptions』オブジェクトを統合し、
『Products』オブジェクトの「ID」カラムに、 『ProductOptions』オブジェクトの「Producut ID」カラムの値が格納されるように対応します。 |
||
Variants |
『Products』オブジェクトと『ProductVariants』オブジェクトを統合し、
『Products』オブジェクトの「ID」カラムに、 『ProductVariants』オブジェクトの「Producut ID」カラムの値が格納されるように対応します。 |
||
PublishedScope |
代替の方法で値を取得できないため、カラムを残したまま、
「空白」が格納されます。 |
||
PublishedStatus |
代替の方法で値を取得できないため、カラムを残したまま、
「空白」が格納されます。 |
||
3 | ProductVariants | Grams |
代替の方法で値を取得できないため、カラムを残したまま、
「空白」が格納されます。 |
FulfillmentService |
代替の方法で値を取得できないため、カラムを残したまま、
「空白」が格納されます。 |
||
InventoryManagement |
代替の方法で値を取得できないため、カラムを残したまま、
「空白」が格納されます。 |
||
Option1 | 「title」カラムの値が分割して格納されるように対応します。 | ||
Option2 | 「title」カラムの値が分割して格納されるように対応します。 | ||
Option3 | 「title」カラムの値が分割して格納されるように対応します。 |
❸ カラムの値の形式変更
『ProductVariants』オブジェクトの”一部のカラム”において、取得する値の形式が変更されます。
対象のカラムは、以下の表をご参照ください。
# | オブジェクト名 | カラム名 | 備考 |
1 | ProductVariants | WeightUnit |
・リリース前:すべて小文字で、短縮されている (例:”kg”)
・リリース後:すべて大文字で、短縮されていない(例:”KILOGRAMS”) |
InventoryPolicy |
・リリース前:すべて小文字で、短縮されていない(例:”continue”)
・リリース後:すべて大文字で、短縮されていない(例:”CONTINUE”) |
❹ オブジェクトの更新停止
『ProductListings』オブジェクト、『Provinces』オブジェクト、『Reports』オブジェクト、『Countries』オブジェクトの”すべてのカラム”において、更新が停止されます。