Shopify Edition Summer ’24「Shopify APIアップデート関連まとめ」

1. Branding API のアップデート

Shopify のチェックアウトページのカスタマイズは、Shopify Plus プランを利用することで、Branding API を通じて可能になります。詳しくは、以下のリンクをご覧ください。

https://shopify.dev/docs/apps/build/checkout/styling

2024-04 バージョンの checkoutBrandingUpsert ミューテーションでは、checkoutBrandingInput フィールドの customizations に新たに以下の項目が追加されました：

• buyerJourney: パンくずリストの表示・非表示
• cartLink: カートアイコンの表示・非表示
•  expressCheckout: エクスプレスチェックアウトエリアのカスタマイズ
• footer: フッターエリアのカスタマイズ

さらに、designSystem フィールドには、新たに2つのカラースキーマ (scheme3, scheme4) が追加されました。

よりカスタマイズする箇所が増え、マーチャントが理想とするデザインが実現できるようになりました。

2. Return API に交換機能を追加

Shopify では注文のキャンセル処理として返金・返品・交換を行うことが出来ます。

https://help.shopify.com/ja/manual/orders/refunds-returns/creating-returns#create-a-return-creating-a-return-for-an-order

現在、これらの処理は管理画面から行われていますが、交換機能はAPIでは提供されていませんでした。しかし、今回のアップデートで交換機能が提供される予定となりました。

Admin APIのReturn API、2024-07 バージョンから exchangeLineItems フィールドを利用して交換機能を使用できるようになる予定です。

https://shopify.dev/docs/api/admin-graphql/2024-07/input-objects/ExchangeLineItemInput

3. Checkout API が非推奨、Storefront Cart APIへ移行が必要

Storefront API、 Admin API で提供されていた Checkout API が非推奨となり、Storefront Cart API への移行が必要となりました。

以下のページで詳しい説明があります。 

https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/cart/migrate-to-cart-api

Storefront Cart API の特徴は以下

• GraphQL の利用が可能
• クライアント・サーバーサイドからともに利用可能
• API のレート制限なし、ボットからの不正なアクセスを防止
• Checkout API では実現不可能だった、ログイン処理、配送先住所の入力、定期購買商品の追加などをサポート

弊社でも一部プロダクトで利用し始めているところですが、入力内容が事前にわかっている場合、入力を省略することができ便利と感じています。

4. Customer Account API のアップデート

今年新たに追加された Customer Account API において、2024-07 バージョンには metafieldsSet と metafieldsDelete ミューテーションが追加されました。

これにより、Customer Account API を使用してメタフィールドの変更や削除が可能となります。

https://shopify.dev/docs/api/customer/2024-07/mutations/metafieldsSet