記事のサマリー(TL;DR)
- REST Admin API version 2027-01以降、Gift Cardリソースのline_item_idプロパティは読み取り専用になり、作成(create)・更新(update)リクエストに含めてもShopifyはその値を無視する。
- 対象となるのは、REST Admin APIのGift Cardリソースを使い、作成・更新時にline_item_idを送信しているアプリで、API version 2027-01以降へのアップグレードを予定している場合。
- line_item_idを読み取り専用で利用している、またはAPI version 2027-01より前のバージョンを使い続けるアプリには影響しない。
対象者と移行前に必要な対応
この変更は、次の条件すべてに当てはまる場合に影響します。
- アプリがREST Admin APIのGift Cardリソースを使用している
- Gift Cardの作成・更新時にline_item_idを含めている
- API version 2027-01以降へのアップグレードを予定している
Gift Cardのレスポンスからline_item_idを読み取るだけのアプリ、またはAPI version 2027-01より前のバージョンにとどまるアプリは、この変更の影響を受けません。
API version 2027-01へアップグレードする前に、以下の対応が必要です。
- line_item_idを送信しているREST Gift Cardの作成・更新呼び出しを特定する
- それらのリクエストのペイロードからline_item_idを削除する
- 既存の関連付けが必要な場合は、引き続きGift CardレスポンスからのIine_item_idの読み取りを続ける
移行を確認するには、line_item_idを含めずに作成・更新リクエストを送信し、同じギフトカードを読み取って、line_item_idの値が変化していないことを確認します。
詳細
何が変わるのか
REST Admin API version 2027-01以降では、アプリはGift Cardの作成・更新リクエストを通じて、ギフトカードのline-item(注文明細)との関連付けを追加・置き換え・解除できなくなります。Shopifyは、これらのリクエストに含まれるline_item_idの値を無視します。Gift Cardのレスポンスには、引き続き既存のline-itemおよび注文との関連付けが含まれます。これより前のAPIバージョンは、現在の動作を維持します。
なぜこの変更が重要なのか
ギフトカードのline-item関連付けは、そのギフトカードを発行した注文明細を記録するものです。line_item_idを読み取り専用にすることで、アプリがギフトカードとその注文との関連付けを変更できないようにします。
破壊的変更と移行方法
REST Admin API version 2027-01以降でも、Shopifyはline_item_idを含む作成・更新リクエストを受け付けますが、そのプロパティは無視されます。ギフトカードは既存のline-item関連付けを保持したままになります。
Shopifyの外部から、ギフトカードのline-item関連付けを追加・置き換え・解除するための代替APIは用意されていません。
必要な対応
本番トラフィックをREST Admin API version 2027-01以降へ移行する前に、Gift Cardの作成・更新リクエストでline_item_idの送信を停止する必要があります。対応しない場合、Shopifyは元の関連付けを維持するため、アプリ側の記録とShopify側の記録が一致しなくなる可能性があります。
関連ドキュメント
- REST Admin API Gift Card resource for 2027-01
- Shopify API versioning
[“Shopify”, “REST Admin API”, “Gift Card”, “API変更”, “破壊的変更”, “APIバージョニング”]