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

目次

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

はじめに

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

今回の記事でわかること

• Shopify Functions の概要
• Order Discount API の概要
• Order Discount API の実装方法

今回の記事を読んで、柔軟なディスカウントを可能にする Order Discount API についてマスターしていきましょう！

Order Discount API とは

Order Discount API とは、Shopify Functions の機能の中の一つです。

Shopify Functions は、Shopify のバックエンドでカスタム処理を追加できる便利な機能です。これを使えば、配送や決済のカスタマイズ、さらにはディスカウント設定の調整も手軽に実施できます。

さらに、Shopify Functions はアプリの機能拡張としてストアに組み込まれます。そのため、 Shopify Functions を含むアプリをストアで見つけてインストールするか、あるいはオリジナルのカスタムアプリを作成し、直接ストアに追加することができます。

Shopify Functions の API の種類

Shopify Functions は、Order Discount API 以外にもさまざまな 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 での注文処理のためのロジックを独自でカスタマイズ可能

Order Discount API アプリの作り方

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

今回は合計の商品注文数が 10 個を超える場合に注文金額を 20%引きにするというディスカウントを作成していきます。

事前準備

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

開発ストアの作成

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

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

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

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

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

アプリ作成

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

アプリの本体を作成

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

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

npm init @shopify/app@latest

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

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

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

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

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

 cd order-discount-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（アプリ名）
  -> order-discount-api-app

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

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

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

アプリに Order Discount API の機能を追加

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

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

 cd order-discount-api-app/

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

npx shopify app generate extension

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

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

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

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

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

cd extensions/product-discount/

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

query RunInput {
  cart {
    lines {
      quantity
    }
  }
}

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

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

ディスカウントに必要な情報	run.graphql
商品の注文数	quantity

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

npm run typegen

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

import type { RunInput, FunctionRunResult } from '../generated/api';
import { DiscountApplicationStrategy } from '../generated/api';

const EMPTY_DISCOUNT: FunctionRunResult = {
  discountApplicationStrategy: DiscountApplicationStrategy.First,
  discounts: [],
};

export function run(input: RunInput): FunctionRunResult {
  // 合計注文数
  const totalOrders = input.cart.lines.reduce((acc, lineItem) => acc + lineItem.quantity, 0);

  // 合計注文数が 20 を超える場合にディスカウントを実行する
  if (totalOrders > 10) {
    return {
      discountApplicationStrategy: DiscountApplicationStrategy.First,
      discounts: [
        {
          targets: [
            {
              orderSubtotal: {
                excludedVariantIds: [],
              },
            },
          ],
          value: {
            percentage: {
              value: '20',
            },
          },
          message: '合計注文数が10を超えたので20%OFF!',
        },
      ],
    };
  }

  return EMPTY_DISCOUNT;
}

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

scopes = "write_products,write_discounts"

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 の中の Order Discount API を搭載することができました。

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

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

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

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

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

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

ストアで Order Discount API を有効化

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

Order Discount 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 を叩いて Order Discount API を有効化していきます。

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

mutation {
  discountAutomaticAppCreate(
    automaticAppDiscount: {
      title: "Volume discount"
      # .env ファイルの「SHOPIFY_PRODUCT_DISCOUNT_ID」を設定する
      functionId: "YOUR_FUNCTION_ID_HERE"
      startsAt: "2022-06-22T00:00:00"
    }
  ) {
    automaticAppDiscount {
      discountId
    }
    userErrors {
      field
      message
    }
  }
}

以上で、Order Discount API を有効化することができました。

有効化できているか確認してみましょう。

ストア管理画面左側のサイドバーから「ディスカウント」をクリックしてください。

「Volume discount」が作成されていれば有効化されています。

以上で、Order Discount API の有効化は完了です。

Order Discount API の動作確認

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

合計注文数が 10 個を超える注文が 20% OFF になっていて正常に動作していますね。

まとめ

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

今回紹介したカート内の商品の合計注文数に基づくディスカウントは非常にシンプルな例ですが、商品のメタフィールドを活用したディスカウントや、顧客情報をもとにしたより複雑なディスカウント設定も可能です。

Shopify Functions は、今回取り上げた Order Discount API だけでなく、さまざまな種類が存在します。ディスカウントや配送、決済方法のカスタマイズが可能で、これらをマスターすることで開発の可能性が格段に広がります。ぜひこの機会に深く学んでみてください！

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