ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、こちらまでご連絡ください。

オプションAPIの基本

アプリケーションメニューまたは REST API を使用して、オプションテンプレートを管理できます。オプションを作成および管理するには、 headless-commerce-admin-catalog サービスを呼び出します。

オプションの追加

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

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

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

Liferayが起動したら、

オプション API の基礎をダウンロードして解凍します。

curl https://resources.learn.liferay.com/commerce/latest/en/product-management/developer-guide/liferay-d3g5.zip -O

unzip liferay-d3g5.zip

オプションはインスタンスにスコープされ、各オプションは一意の keyを指定する必要があります。

cURLスクリプトを使用して、新しいオプションを追加してください。コマンドラインで、curlフォルダに移動します。 Options_POST_ToInstance.sh スクリプトを実行します。

./Options_POST_ToInstance.sh

JSONレスポンスは、新しいオプションが追加されたことを示します。

{
   "actions" : {
      "get" : {
         "method" : "GET",
         "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options/46438"
      },
      "update" : {
         "method" : "PATCH",
         "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options/46438"
      },
      "delete" : {
         "method" : "DELETE",
         "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options/46438"
      }
   },
   "description" : { },
   "externalReferenceCode" : "f73e12cd-feae-9e78-5921-6b65f6b993f6",
   "facetable" : false,
   "fieldType" : "select",
   "id" : 46438,
   "key" : "foo",
   "name" : {
      "en_US" : "Foo"
   },
   "required" : false,
   "skuContributor" : false
}

オプションの追加を確認するには、 グローバルメニュー () を開き、 コマース → オプションに移動します。新しいオプションが表示されます。
または、Javaクライアントを使用してRESTサービスを呼び出します。 java
```
javac -classpath .:* *.java
```



Options_POST_ToInstance クラスを実行します。
java -classpath .:* Options_POST_ToInstance





項目タイプ API値


テキストボックス "fieldType": "text"
プルダウン "fieldType": "select"
ラジオボタン "fieldType": "radio"
複数選択 "fieldType": "checkbox_multiple"
日付 "fieldType": "date"
数値 "fieldType": "numeric"
ブール値 "fieldType": "checkbox"


cURLコマンドの検証
Options_POST_ToInstance.sh スクリプトは、cURL コマンドを使用して REST サービスを呼び出します。
curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options" \
	--data-raw '
		{
			"fieldType": "select",
			"key": "foo",
			"name": {
				"en_US": "Foo"
			}
		}' \
	--header "Content-Type: application/json" \
	--request "POST" \
	--user "test@liferay.com:learn"

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


引数 説明


-H "Content-Type: application/json" リクエストボディの形式をJSONに設定します。
-X POST 指定されたエンドポイントで呼び出す HTTP メソッドを設定します。
"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options" RESTサービスのエンドポイントを指定します。
-d "{\"fieldType\": \"select\", \"key\": \"foo\", \"name\": {\"en_US\": \"Foo\"}}" 投稿するデータを入力します。
-u "test@liferay.com:learn" 基本認証の認証情報を入力します。




注


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


他のcURLコマンドも同様のJSON引数を使用しています。
Javaクラスを調べる
Options_POST_ToInstance.java クラスは、 OptionResource サービスを呼び出してオプションを追加します。
public static void main(String[] args) throws Exception {
	OptionResource.Builder builder = OptionResource.builder();

	OptionResource optionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		optionResource.postOption(
			new Option() {
				{
					fieldType = Option.FieldType.SELECT;
					key = "foo";
					name = new HashMap<String, String>() {
						{
							put("en_US", "Foo");
						}
					};
				}
			}));
}

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


行（省略形） 説明


OptionResource.Builder builder = ... OptionResource サービスインスタンスを生成するための Builder を取得します。
OptionResource optionResource = builder.authentication(...).build(); 基本認証を使用し、OptionResourceサービスインスタンスを生成します。
optionResource.postOption(...); optionResource.postOptionメソッドを呼び出し、投稿するデータを渡します。


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


注


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


残りの例のJavaクラスは、異なる OptionResource のメソッドを呼び出します。


重要


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


以下は、cURLとJavaを使用して他の Option RESTサービスを呼び出す例です。
インスタンスからオプションを取得する
cURLやJavaのコマンドで、Liferayインスタンスの全オプションをリストアップします。
Options_GET_FromInstance.sh
コマンド：
./Options_GET_FromInstance.sh

コード：
curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options" \
	--user "test@liferay.com:learn"

Options_GET_FromInstance.java
コマンド:
java -classpath .:* Options_GET_FromInstance

コード:
public static void main(String[] args) throws Exception {
	OptionResource.Builder builder = OptionResource.builder();

	OptionResource optionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		optionResource.getOptionsPage(
			null, null, Pagination.of(1, 2), null));
}

インスタンスのOptionオブジェクトはJSONでフォーマットされています。
オプションの絞り込み、ページネーション、検索、並び替え
このAPIでは、オプションの絞り込み、ページ分割、検索、並べ替えを行うためのパラメーターも許可します。 詳細については、 getOptionsPage メソッドを参照してください。 クエリでは、以下のOptionフィールドを使用して、結果の絞り込み、検索、および並べ替えを行うことができます。

fieldType
key
name



フィルタークエリ 説明


name eq 'Able' オプション名はAbleと同じでなければなりません。
fieldType eq 'select' オプションタイプを必ず選択しなければなりません。




ソートクエリ 説明


key:desc キーで降順に並べ替えます。
name:desc 名前で降順に並べ替えます。


詳細については、 API クエリ パラメータ を参照してください。
オプションの取得
cURLまたはJava getコマンドで特定のオプションを取得します。 1234をオプションのIDに置き換えます。


ヒント


すべてのオプションのリストを取得するには、 Options_GET_FromInstance.[java|sh] を使用し、必要なオプションの id をメモします。


オプション_GET_ById.sh
コマンド：
./Options_GET_ById.sh 1234

コード：
curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options/${1}" \
	--user "test@liferay.com:learn"

Options_GET_ById.java
コマンド：
java -classpath .:* -DoptionId=1234 Options_GET_ById

コード：
public static void main(String[] args) throws Exception {
	OptionResource.Builder builder = OptionResource.builder();

	OptionResource optionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		optionResource.getOption(
			Long.valueOf(System.getProperty("optionId"))));
}

Option のフィールドはJSONで記載されています。
オプションにパッチを適用する
cURLとJava patch コマンドで既存のオプションを更新します。 1234をオプションのIDに置き換えます。
オプション_PATCH_ById.sh
コマンド：
./Options_PATCH_ById.sh 1234

コード：
curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options/${1}" \
	--data-raw '
		{
			"fieldType": "radio",
			"key": "bar",
			"name": {
				"en_US": "Bar"
			}
		}' \
	--header "Content-Type: application/json" \
	--request "PATCH" \
	--user "test@liferay.com:learn"

オプション_PATCH_ById.java
コマンド：
java -classpath .:* -DoptionId=1234 Options_PATCH_ById

コード：
public static void main(String[] args) throws Exception {
	OptionResource.Builder builder = OptionResource.builder();

	OptionResource optionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	optionResource.patchOption(
		Long.valueOf(System.getProperty("optionId")),
		new Option() {
			{
				fieldType = Option.FieldType.RADIO;
				key = "bar";
				name = new HashMap<String, String>() {
					{
						put("en_US", "Bar");
					}
				};
			}
		});
}

オプションの削除
cURL と Java delete コマンドで既存のオプションを削除します。 1234をオプションのIDに置き換えます。
オプション_DELETE_ById.sh
コマンド:
./Options_DELETE_ById.sh 1234

コード：
curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options/${1}" \
	--request "DELETE" \
	--user "test@liferay.com:learn"

オプション_DELETE_ById.java
コマンド
java -classpath .:* -DoptionId=1234 Options_DELETE_ById

コード:
public static void main(String[] args) throws Exception {
	OptionResource.Builder builder = OptionResource.builder();

	OptionResource optionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	optionResource.deleteOption(
		Long.valueOf(System.getProperty("optionId")));
}

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

商品オプションの使用
RESTサービスの使用


					
							
								
									Capability:
								
									
										
											Commerce
										
									
							
							
								
									Resource Type:
								
									
										
											Official Documentation
										
									
							
							
								
									Feature:
								
									
										
											Catalogs
										
									
									
										
											Product Information
										
									
									
										
											Products
										
									
							
							
								
									Deployment Approach:
								
									
										
											Liferay PaaS
										
									
									
										
											Liferay SaaS
										
									
									
										
											Liferay Self-Hosted

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

項目タイプ	API値
テキストボックス	`"fieldType": "text"`
プルダウン	`"fieldType": "select"`
ラジオボタン	`"fieldType": "radio"`
複数選択	`"fieldType": "checkbox_multiple"`
日付	`"fieldType": "date"`
数値	`"fieldType": "numeric"`
ブール値	`"fieldType": "checkbox"`

引数	説明
`-H "Content-Type: application/json"`	リクエストボディの形式をJSONに設定します。
`-X POST`	指定されたエンドポイントで呼び出す HTTP メソッドを設定します。
`"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options"`	RESTサービスのエンドポイントを指定します。
`-d "{\"fieldType\": \"select\", \"key\": \"foo\", \"name\": {\"en_US\": \"Foo\"}}"`	投稿するデータを入力します。
`-u "test@liferay.com:learn"`	基本認証の認証情報を入力します。

フィルタークエリ	説明
`name eq 'Able'`	オプション名はAbleと同じでなければなりません。
`fieldType eq 'select'`	オプションタイプを必ず選択しなければなりません。

ソートクエリ	説明
`key:desc`	キーで降順に並べ替えます。
`name:desc`	名前で降順に並べ替えます。