割引APIの基本

アプリケーションメニューやREST APIで割引を管理することができます。 割引を作成および管理するには、 headless-admin-commerce-pricing サービスを呼び出します。

割引を追加する

新しいLiferay DXPインスタンスを起動し、以下を実行します。

docker run -it -m 8g -p 8080:8080 liferay/dxp:2025.q1.6-lts

メールアドレス [e-mail] とパスワード testを使用して、 http://localhost:8080 で Liferay にサインインします。 プロンプトが表示されたら、パスワードを learnに変更します。

Liferayが起動したら、

1. Discount API Basicsをダウンロードして解凍します。

   curl https://resources.learn.liferay.com/commerce/latest/en/pricing/developer-guide/liferay-r6f7.zip -O
   

   unzip liferay-r6f7.zip
   

2. 割引はインスタンスにスコープされます。 cURLスクリプトを使用して、新しい割引を追加します。 コマンドラインで、curlフォルダに移動します。 Discounts_POST_ToInstance.sh スクリプトを実行します。

   ./Discounts_POST_ToInstance.sh
   

   JSONレスポンスには、新しい割引が追加されたことが示されています。

   {
      "actions" : {
         "permissions" : {
            "method" : "PATCH",
            "href" : "http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/discounts/46111"
         },
         "get" : {
            "method" : "GET",
            "href" : "http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/discounts/46111"
         },
         "update" : {
            "method" : "PATCH",
            "href" : "http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/discounts/46111"
         },
         "delete" : {
            "method" : "DELETE",
            "href" : "http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/discounts/46111"
         }
      },
      "active" : false,
      "amountFormatted" : "0.00%",
      "couponCode" : "",
      "customFields" : { },
      "displayDate" : "2023-02-27T12:31:00Z",
      "externalReferenceCode" : "9df9ffc2-be00-680b-2a2c-69f572bbe65c",
      "id" : 46111,
      "level" : "L1",
      "limitationTimes" : 0,
      "limitationTimesPerAccount" : 0,
      "limitationType" : "unlimited",
      "numberOfUse" : 0,
      "rulesConjunction" : false,
      "target" : "Products",
      "title" : "Foo",
      "useCouponCode" : false,
      "usePercentage" : true
   }
   

3. 割引の追加を確認するには、 グローバル メニュー () を開き、 コマース → 割引に移動します。 新しい割引が表示されます。

   

4. または、Javaクライアントを使用してRESTサービスを呼び出します。 java

   javac -classpath .:* *.java
   

5. Discounts_POST_ToInstance クラスを実行します。

   java -classpath .:* Discounts_POST_ToInstance
   

クーポンコードを追加する

割引にクーポンコードを追加するには、useCouponCodeをtrueに設定し、 couponCodeフィールドに値を設定します。 クーポンコードの利用を制限する場合は、下表の設定をご利用ください。

制限の種類	設定	説明
合計使用回数	"制限タイプ" : "合計に制限あり" "制限時間" : 5 (任意の整数)	クーポンコードは合計5回まで使用可能です。
1アカウントあたりの使用回数	"制限タイプ": "アカウントに制限あり" "アカウントあたりの制限時間" : 5 (任意の整数)	1アカウントにつき5回までクーポンコードを使用することができます。
合計使用回数とアカウント別の使用回数	"limitationType" : "アカウントと合計に制限あり" "limitationTimesPerAccount": 2 (任意の整数) "limitationTimes" : 5 (任意の整数)	クーポンコードは1アカウントにつき2回まで使用でき、合計5回まで使用できます。

cURLコマンドの検証

Discounts_POST_ToInstance.sh スクリプトは、cURL コマンドを使用して REST サービスを呼び出します。

curl \
	"http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/discounts" \
	--data-raw '
		{
			"level": "L1",
			"limitationType": "unlimited",
			"target": "products",
			"title": "Foo",
			"usePercentage": true
		}' \
	--header "Content-Type: application/json" \
	--request "POST" \
	--user "[e-mail]:learn"

ここでは、コマンドの引数を紹介します。

引数	説明
-H "Content-Type: application/json"	リクエストボディの形式をJSONに設定します。
-X POST	指定されたエンドポイントで呼び出す HTTP メソッドを設定します。
"http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/discounts"	RESTサービスのエンドポイントを指定します。
-d "{\"level\": \"L1\", \"limitationType\": \"unlimited\", \"target\": \"products\", \"title\": \"Foo\", \"usePercentage\": true}"	投稿するデータを入力します。
-u "[e-mail]:learn"	基本認証の認証情報を入力します。

注

ここでは、デモのために基本的な認証を使用しています。 本番環境では、 OAuth2経由でユーザーを認証する必要があります。 OAuth2 を使用したサンプル React アプリケーションについては、 OAuth2 を使用してユーザーを承認する を参照してください。

他のcURLコマンドも同様のJSON引数を使用しています。

Javaクラスを調べる

Discounts_POST_ToInstance.java クラスは、 DiscountResource サービスを呼び出して割引を追加します。

public static void main(String[] args) throws Exception {
	DiscountResource.Builder builder = DiscountResource.builder();

	DiscountResource discountResource = builder.authentication(
		"[e-mail]", "learn"
	).build();

	System.out.println(
		discountResource.postDiscount(
			new Discount() {
				{
					level = "L1";
					limitationType = "unlimited";
					target = "products";
					title = "Foo";
					usePercentage = true;
				}
			}));
}

このクラスは、わずか3行のコードでRESTサービスを呼び出します。

行（省略形）	説明
DiscountResource.Builder builder = ...	DiscountResourceサービスインスタンスを生成するためのBuilderを取得します。
DiscountResource discountResource = builder.authentication(...).build();	基本認証を使用し、 DiscountResource サービスインスタンスを生成します。
discountResource.postDiscount(...);	discountResource.postDiscountメソッドを呼び出し、投稿するデータを渡します。

プロジェクトには、依存関係としてcom.liferay.headless.commerce.admin.pricing.client.jarファイルが含まれていることに注意してください。 すべての REST アプリケーションのクライアント JAR 依存関係情報は、インストールの API エクスプローラーの /o/api (例: http://localhost:8080/o/api) で確認できます。

注

メイン メソッドのコメントは、クラスの実行を示しています。

残りのサンプルJavaクラスは、異なる DiscountResourceメソッドを呼び出します。

重要

サービスの詳細については、 DiscountResource を参照してください。

以下は、cURLとJavaを使用して、他の Discount RESTサービスを呼び出す例です。

インスタンスから割引を取得する

cURLやJavaのコマンドで、Liferayインスタンスのすべての割引をリストアップします。

Discounts_GET_FromInstance.sh

コマンド：

./Discounts_GET_FromInstance.sh

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/discounts" \
	--user "[e-mail]:learn"

Discounts_GET_FromInstance.java

コマンド:

java -classpath .:* Discounts_GET_FromInstance

コード:

public static void main(String[] args) throws Exception {
	DiscountResource.Builder builder = DiscountResource.builder();

	DiscountResource discountResource = builder.authentication(
		"[e-mail]", "learn"
	).build();

	Page<Discount> page = discountResource.getDiscountsPage(
		null, null, Pagination.of(1, 2), null);

	System.out.println(page);
}

インスタンスのDiscountオブジェクトはJSONでフォーマットされています。

割引を受ける

cURLまたはJava getコマンドで特定の割引を取得します。 1234を割引のIDに置き換えます。

ヒント

すべての割引のリストを取得するには、 Discounts_GET_FromInstance.[java|sh] を使用し、具体的に必要な割引の id を書き留めておきます。

割引_GET_ById.sh

コマンド：

./Discounts_GET_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/discounts/${1}" \
	--user "[e-mail]:learn"

Discounts_GET_ById.java

コマンド：

java -classpath .:* -DdiscountId=1234 Discounts_GET_ById

コード：

public static void main(String[] args) throws Exception {
	DiscountResource.Builder builder = DiscountResource.builder();

	DiscountResource discountResource = builder.authentication(
		"[e-mail]", "learn"
	).build();

	System.out.println(
		discountResource.getDiscount(
			Long.valueOf(System.getProperty("discountId"))));
}

DiscountフィールドがJSONに一覧表示されます。

割引にパッチを当てる

cURLとJava patchコマンドで既存の倉庫を更新します。 1234を割引のIDに置き換えます。

割引_PATCH_ById.sh

コマンド：

./Discounts_PATCH_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/discounts/${1}" \
	--data-raw '
		{
		"limitationType": "unlimited",
		"target": "subtotal",
		"title": "Bar"
		}' \
	--header "Content-Type: application/json" \
	--request "PATCH" \
	--user "[e-mail]:learn"

Discounts_PATCH_ById.java

コマンド：

java -classpath .:* -DdiscountId=1234 Discounts_PATCH_ById

コード：

public static void main(String[] args) throws Exception {
	DiscountResource.Builder builder = DiscountResource.builder();

	DiscountResource discountResource = builder.authentication(
		"[e-mail]", "learn"
	).build();

	discountResource.patchDiscount(
		Long.valueOf(System.getProperty("discountId")),
		new Discount() {
			{
				limitationType = "unlimited";
				target = "subtotal";
				title = "Bar";
			}
		});
}

割引を削除する

cURLとJava deleteコマンドで既存の割引を削除します。 1234を割引のIDに置き換えます。

割引_DELETE_ById.sh

コマンド：

./Discounts_DELETE_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/discounts/${1}" \
	--request "DELETE" \
	--user "[e-mail]:learn"

割引_DELETE_ById.java

コマンド：

java -classpath .:* -DdiscountId=1234 Discounts_DELETE_ById

コード：

public static void main(String[] args) throws Exception {
	DiscountResource.Builder builder = DiscountResource.builder();

	DiscountResource discountResource = builder.authentication(
		"[e-mail]", "learn"
	).build();

	discountResource.deleteDiscount(
		Long.valueOf(System.getProperty("discountId")));
}

API エクスプローラー には、 Discount サービスとスキーマが表示され、各サービスをテストするためのインターフェースがあります。

関連トピック

• 価格表APIの基本