Shopify Cart Transform API とは？実装方法まで徹底解説！

目次

• はじめに
• Cart Transform API とは
• Shopify Functions の API の種類
• Cart Transform API アプリの作り方
  • 事前準備
  • アプリ作成
  • アプリに Cart Transform API の機能を追加
  • 作成したアプリを開発ストアにインストール
  • ストアで Cart Transform API を有効化
  • Cart Transform API の動作確認
  • Cart Transform API を用いたアプリの紹介
• まとめ

はじめに

今回の記事では Shopify Functions の概要から具体的な Cart Transform API の実装方法まで丁寧に解説していきます。

今回の記事でわかること

• Shopify Functions の概要
• Cart Transform API の概要
• Cart Transform API の実装方法

今回の記事を読んで、カート内の商品の表示のカスタマイズを可能にする Cart Transform API についてマスターしていきましょう！

Cart Transform API とは

Cart Transform API とは、Shopify Functions の機能の中の一つで、カート内の商品を柔軟にカスタマイズできるようになります。

Shopify Functions とは Shopify のバックエンドに独自のカスタムロジックを追加することができる便利なツールです。これを利用することで、配送方法や決済オプションのカスタマイズ、ディスカウント設定の調整などが簡単にできるようになります。

また、Shopify Functions はアプリの機能を拡張する形でストアに導入されます。これにより、 Shopify Functions を搭載したアプリをストアで見つけて導入することも、自分でカスタムアプリを開発してストアに直接追加することも可能です。

Shopify Functions の API の種類

Shopify Functions では、Cart Transform API だけではなく、多種多様な API が提供されており、それぞれ異なるカスタマイズ処理を実行できます。現在利用可能な API の種類とその概要を一覧表にしてまとめました。

Function API	Description
Delivery Customization API	顧客に表示される配送オプションの名前変更、順序変更、並び替えが可能
Order Discount API	カート内の全ての商品に適用される割引を作成可能
Product Discount API	カート内の特定の商品または商品バリアントに適用される割引を作成可能
Shipping Discount API	配送料に対して送料無料や割引などのロジックを作成可能
Payment Customization API	決済方法の名前変更、順序変更、並び替えが可能
Cart TransForm API	カート内の商品を拡張し、カート内の商品の表示を更新可能
Cart and checkout validation API	カートとチェックアウトの独自のバリデーションを作成可能
Fulfillment Constraints	Shopify での注文処理のためのロジックを独自でカスタマイズ可能

Cart Transform API アプリの作り方

ここからは実際に Cart Transform API を使用したアプリの作成方法を解説していきます。

今回はカート内の商品をギフトカードとのセット商品としてバンドルするという処理を行なっていきます。

事前準備

アプリ開発を行う前の事前準備をしていきます。

開発ストアの作成

今回作成するアプリをインストールするストアを作成します。

アプリ作成に必要なツールをインストール

Shopify Functions が組み込まれているアプリを開発するために以下のものが必要になるのでローカル PC にインストールしてください。

• Node.js
• Node.js のパッケージマネージャ（npm, yarn)
• ShopifyCLI

以上で事前準備は終了です。

アプリ作成

ここからは実際に Cart Transform API が搭載されたアプリを作成していきます。

アプリの本体を作成

Cart Transform API はアプリの拡張機能になるので、まずはアプリ本体を作成していきます。

1. ターミナルを立ち上げて、アプリを作成したいディレクトリで以下のコマンドを実行します。

npm init @shopify/app@latest

2. コマンド実行後、プロジェクト名や使用する言語などを聞かれるのでそれぞれ以下のように答えてください。

Your project name?（アプリのディレクトリ名）
 -> cart-transform-api-app

Get Started building your app?（Remix を使用するかどうか）
 -> Start with Remix

For your Remix template, which language do you want?（使用する言語）
 -> Typescript

3. アプリのディレクトリに移動します。

 cd cart-transform-api-app/

4. アプリに必要なライブラリをインストールします。

npm install

5. 以下のコマンドを実行して、アプリのローカルサーバーを起動します。

npm run dev

コマンド実行後、いくつか質問されるので以下のように答えてください。

Create this project as a new app on Shopify
（パートナーダッシュボードに新規でアプリを作成するかどうか）
  -> Yes, create it as a new app

App name（アプリ名）
  -> cart-transform-api-app

Which store would you like to use to view your project?
（どのストアでアプリの動作を確認したいか）
  -> shipping-discount-api-demo（事前準備で作成した開発ストアを入力してください）

Have Shopify automatically update your app's URL in order to create a preview experience?
（アプリをプレビューするための URL を Shopify が自動で生成してくれる）
  -> Yes, automatically update

ここまででアプリ本体の作成は完了です。

アプリに Cart Transform API の機能を追加

ここからは、作成したアプリの本体に Cart Transform API の拡張機能を追加していきます。

1. アプリのディレクトリに移動します。

 cd cart-transform-api-app/

2. 以下の拡張機能を作成するコマンドを実行して、アプリに拡張機能を追加します。

npx shopify app generate extension

コマンド実行後の質問には以下のように答えてください。

Type of extension?（作成する拡張機能の種類）
  ->  Cart transformer - Function

Name your extension?（作成される拡張機能の名前）
  -> 何も入力しない

What would you like to work in?（使用する言語）
  -> TypeScript

3. インストールした拡張機能のディレクトリに移動します。

cd extensions/cart-transformer/

4. run.graphql を以下のコードに書き換えます。

query RunInput {
  cart {
    lines {
      id
      quantity
      merchandise {
        __typename
        ... on ProductVariant {
          id
          product {
            title
          }
        }
      }
    }
  }
}

run.graphql にはディスカウントで必要な情報を取得してくる GraphQL クエリを作成しています。 どのような情報が取得できるかはこちらのドキュメントで詳しく確認できます。

今回のバリデーションの実行に必要な情報と run.graphql の内容の対応関係は以下のようになっています。

ディスカウントに必要な情報	run.graphql
カートラインアイテムの id	cart.lines.id
商品のバリアントの id	merchandise.id
商品のタイトル	merchandise.product.title

5. run.graphql を元に型 RunInput を生成します。
   以下のコマンドを実行して型を生成します。この型は、次に編集するrun.ts ファイルで使用されます。run.ts は実際にバリデーション処理を書いていくファイルです。

npm run typegen

6. run.ts を以下のコードに書き換えます。

import { time } from 'console';
import type {
  RunInput,
  FunctionRunResult,
  ProductVariant,
  ExpandOperation,
} from '../generated/api';

export function run(input: RunInput): FunctionRunResult {
  // ギフトカードのバリアント id（自分のストアのギフトカードのバリアントIDに書き換える）
  const giftCardVariantId = 'gid://shopify/ProductVariant/40587100880973';

  return {
    operations: input.cart.lines.map(
      (
        lineItem,
      ): {
        expand: ExpandOperation;
      } => ({
        expand: {
          cartLineId: lineItem.id,
          title: `${(lineItem.merchandise as ProductVariant).product.title} - ギフトカードつき`,
          image: null,
          expandedCartItems: [
            {
              merchandiseId: (lineItem.merchandise as ProductVariant).id,
              quantity: lineItem.quantity,
            },
            {
              merchandiseId: giftCardVariantId,
              quantity: 1,
            },
          ],
        },
      }),
    ),
  };
}

7. アクセススコープの更新
   shopify.app.toml の scopes を以下のように更新してください。

scopes = "write_products,write_cart_transforms"

8. アプリのディレクトリに移動してアプリをデプロイします。

cd ../.. && npm run deploy

コマンド実行後の質問には以下のように答えてください。

Include `shopify.app.toml` configuration on `deploy`?
  -> Yes, always

Release a new version of cart-chekout-validation-demo?
  -> Yes, release this new version

ここまででアプリに Shopify Functions の中の Cart Transform API を搭載することができました。

作成したアプリを開発ストアにインストール

次に、作成したアプリを開発ストアにインストールします。
パートナーダッシュボードの「アプリ管理」から今回作成したアプリを選択します。

アプリ詳細画面に遷移したら「ストアを選択する」をクリックしてください。

アプリの機能を試すストアを選択します。最初に作成した開発ストアを選択してください。

「インストール」をクリックしてアプリをストアにインストールします。

ここまでで、Cart Transform API を搭載したアプリを開発ストアにインストールすることができました。

ストアで Cart Transform API を有効化

次に、開発ストアで Cart Transform API を有効化します。

Cart Transform API を有効化させるためには、GraphQL Admin API を叩く必要があります。今回は Shopify が提供している「Shopify GraphiQL App」というアプリを使用して Admin GraphQL を叩いていきます。「Shopify GraphiQL App」についてはこちらの記事で詳しく解説しているのでよければ読んでみてください。

こちらから「Shopify GraphiQL App」をインストールできます。

▼ 「Shopify GraphiQL App」インストール画面

「Shop URL」の項目にはアプリをインストールストアのドメインを入力します。最初に作成した開発ストアのドメインを入力してください。

「Admin API」の項目では、「Shopify GraphiQL App」に許可するアクセススコープを選択します。「Select all」をクリックしてください。

「Install」をクリックしてアプリをストアにインストールしていきます。

「インストール」をクリックしてください。

ここからは、Admin GraphQL を叩いて Cart Transform API を有効化していきます。

下記のクエリを使用して Cart Transform API を有効化します。YOUR_FUNCTION_ID_HERE の部分は、アプリを作成してきたディレクトリの .env ファイルに SHOPIFY_CART_TRANSFORMER_ID=xxxxxxxxxxxxxxxxxx という行があると思うので、そこの xxxxxxxxxxxxxxxxxx に該当する部分に書き換えてください。

mutation {
  cartTransformCreate(functionId: "YOUR_FUNCTION_ID_HERE", blockOnFailure: false) {
    cartTransform {
      id
      functionId
    }
    userErrors {
      field
      message
    }
  }
}

以上で、Cart Transform API の有効化は完了です。

Cart Transform API の動作確認

Cart Transform API の動作確認を行なっていきます。

各商品がギフトカードとのセット商品になっていて正常に動作していますね

Cart Transform API を用いたアプリの紹介

以下のようなアプリでは、Cart Transform API を用いて実装されています。

シンプルセット販売｜お手軽クロスセル

「シンプルセット販売｜お手軽クロスセル」はクロスセルを促すアプリです。セット購入時に割り引きを設定して、クロスセルを促します。こちらからアプリをインストールできます。

詳しい使い方については、以下のご利用ガイドをご覧ください。
Shopify でセット販売（クロスセル）を簡単に実現できるアプリについて徹底解説｜ご利用ガイド

シンプル延長保証｜お手軽保証付き商品販売

「シンプル延長保証｜お手軽保証付き商品販売」は Shopify ストアに保証付与機能を導入できるアプリです。こちらのアプリを利用すれば、任意の商品に対して任意の保証商品を付与できます。こちらからアプリをインストールできます。

詳しい使い方については、以下のご利用ガイドをご覧ください。
Shopify に保証商品や保険商品を作成し延長保証機能を実現できるアプリについて徹底解説｜ご利用ガイド

シンプルボリュームディスカウント｜お手軽まとめ買い割引

「シンプルボリュームディスカウント｜お手軽まとめ買い割引」は、商品毎にボリュームディスカウントを実現できるアプリです。割引率・定額割引による割引ができます。こちらからアプリをインストールできます。

詳しい使い方については、以下のご利用ガイドをご覧ください。
Shopify で商品毎にボリュームディスカウント（まとめ買い割引）を実現できるアプリについて徹底解説｜ご利用ガイド

まとめ

今回は Shopify Functions の概要から Cart Transform API を使用して、Shopify Functions の具体的な実装方法まで解説しました。

今回紹介したカート内商品をギフトカードと組み合わせるアイデアは入門編にすぎません。商品のメタフィールドを駆使した割引や、顧客データに基づく複雑な割引設定など、さらに高度なカスタマイズが可能です。

また、Shopify Functions は、Cart Transform API だけではなく、多彩な機能を提供しています。ディスカウント、配送、決済オプションのカスタマイズが可能で、これらの機能をフルに活用することで、開発の可能性を格段に広げることができます。この機会に、Shopify Functions の深い知識を身につけていきましょう！

最後まで読んでいただきありがとうございました！

これらの記事では、Shopify Functions を解説しています。

• Shopify Delivery Customization API とは？実装方法まで徹底解説！
• Shopify Payment Customization API とは？実装方法まで徹底解説！
• Shopify Order Discount API とは？実装方法まで徹底解説！
• Shopify Shipping Discount API とは？実装方法まで徹底解説！ > Cart and checkout validation API とは？実装方法まで徹底解説！