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

製品APIの基本

アプリケーションメニューから製品を管理できますが、Liferay の REST API を使用することもできます。これらのサービスを呼び出して、製品を作成・管理します。

製品の追加

新しい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に変更します。

次に、次の手順に従います。

製品 API の基礎をダウンロードして解凍します。

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

unzip liferay-z8v2.zip

製品はカタログにスコープされており、カタログIDは必須パラメーターの1つです。これを取得するには、 グローバルメニュー () を開き、 コマース → カタログに移動します。製品を追加するカタログを選択し、製品名の横にあるIDをメモしてください。

注

Liferay DXP 2024.Q4+/Portal GA129+では、製品を追加するときにカタログの外部参照コードを使用できます。

cURLスクリプトを使用して、新製品をカタログに追加します。コマンドラインで、curlフォルダに移動します。カタログ ID をパラメータとして、 Products_POST_ToCatalog.sh スクリプトを実行します。

./Products_POST_ToCatalog.sh 1234

JSONのレスポンスには、新製品が追加されたことが示されています。

"actions" : {
 "get" : {
   "method" : "GET",
   "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/products/47738"
 },
 "update" : {
   "method" : "PATCH",
   "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/products/47738"
 },
 "delete" : {
   "method" : "DELETE",
   "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/products/47738"
 }
},
"active" : true,
"catalogId" : 47734,
"categories" : [ ],
"createDate" : "2022-10-14T09:58:20Z",
"customFields" : [ ],
"description" : {
   "en_US" : ""
},
"displayDate" : "2022-10-14T09:58:00Z",
"expando" : { },
"externalReferenceCode" : "5ad0eabb-6c69-6eaf-75aa-ec4000408c66",
"id" : 47738,
"metaDescription" : {
   "en_US" : ""
},
"metaKeyword" : {
   "en_US" : ""
},
"metaTitle" : {
   "en_US" : ""
},
"modifiedDate" : "2022-10-14T09:58:20Z",
"name" : {
   "en_US" : "Foo"
},
"productAccountGroupFilter" : false,
"productChannelFilter" : false,
"productId" : 47739,
"productStatus" : 0,
"productType" : "simple",
"productTypeI18n" : "Simple",
"shortDescription" : {
   "en_US" : ""
},
"skuFormatted" : "",
"tags" : [ ],
"thumbnail" : "/o/commerce-media/default/?groupId=47735",
"urls" : {
   "en_US" : "foo"
},
"version" : 1,
"workflowStatusInfo" : {
   "code" : 0,
   "label" : "approved",
   "label_i18n" : "Approved"
}

これを確認するには、 グローバルメニュー () を開き、 コマース → 製品に移動します。新製品が追加されたことを確認します。
また、Javaクライアントを使用してThe RESTサービスを呼び出すことができます。 curl フォルダから、 java フォルダに移動します。ソースファイルをコンパイルします。
```
javac -classpath .:* *.java
```
Products_POST_ToCatalog クラスを実行します。 catalogIdの値を、カタログのIDに置き換えます。
```
java -classpath .:* -DcatalogId=1234 Products_POST_ToCatalog
```

cURLコマンドの検証

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

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/products" \
	--data-raw '
		{
			"active": true,
			"catalogId": "'"${1}"'",
			"name": {
				"en_US": "Foo"
			},
			"productType": "simple"
		}' \
	--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/products"`	RESTサービスのエンドポイント
`-d "{\"active\": true, \"catalogId\": \"${1}\", \"name\": {\"en_US\": \"Foo\"}, \"productType\": \"simple\"}"`	投稿するデータ
`-u "test@liferay.com:learn"`	基本的な認証情報

注

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

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

Javaクラスを調べる

Products_POST_ToCatalog.java クラスは、製品関連のサービスを呼び出して製品を追加します。

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

	ProductResource productResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		productResource.postProduct(
			new Product() {
				{
					active = true;
					catalogId = Long.valueOf(
						System.getProperty("catalogId"));
					name = new HashMap<String, String>() {
						{
							put("en_US", "Foo");
						}
					};
					productType = "simple";
				}
			}));
}

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

行（省略形）	説明
`ProductResource.Builder builder = ...`	`ProductResource` サービスインスタンスを生成するための `Builder` を取得します。
`ProductResource productResource = builder.authentication(...).build();`	基本認証を指定し、 `ProductResource`サービスインスタンスを生成します。
`productResource.postProduct(...);`	`productResource.postProduct`メソッドを呼び出し、データをpostに渡します。

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

注

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

他の例のJavaクラスは、これと似ていますが、異なる ProductResource メソッドを呼び出します。

重要

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

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

インスタンスから製品を取得する

以下のcURLまたはJavaコマンドを実行することで、Liferayインスタンスの全製品を一覧表示することができます。

Products_GET_FromInstance.sh

コマンド：

./Products_GET_FromInstance.sh

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/products" \
	--user "test@liferay.com:learn"

Products_GET_FromInstance.java

コマンド：

java -classpath .:* Products_GET_FromInstance

コード：

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

	ProductResource productResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Page<Product> page = productResource.getProductsPage(
		null, null, Pagination.of(1, 2), null);

	System.out.println(page);
}

LiferayインスタンスのProductオブジェクトがJSONで一覧表示されます。

このAPIでは、製品のフィルタリング、ページ分割、検索、ソートを行うためのパラメーターも許可します。詳細については、 getProductsPage メソッドを参照してください。クエリでは、以下の製品フィールドを使用して、結果のフィルタリング、検索、ソートを行うことができます。

categoryIds
channelId
statusCode
customFields
createDate
modifiedDate
catalogId
name
productType

フィルタークエリ	説明
productType eq ‘simple'	製品種類がシンプル
contains(名前、 ‘バー')	製品名にBarを含む
カスタムフィールド/サンプルサイズは ‘100.0 と等しい	sampleSizeというカスタムフィールドは100に等しい

ソートクエリ	説明
createDate:desc	createDateで降順に並べ替え
name:asc	名前で昇順に並べ替え
createDate:desc,name:desc	最初にcreateDateで降順に並べ替え、次に名前で降順に並べ替え

詳細については、 API クエリパラメータを参照してください。

製品を入手する

以下のcURLまたはJavaコマンドで、特定の製品を取得します。 1234を製品のIDに置き換えてください。

ヒント

すべての製品のリストを取得するには、 Products_GET_FromInstance.[java|sh] を使用し、具体的に必要な製品の productId をメモします。

Products_GET_ById.sh

コマンド：

./Products_GET_ById.sh 1234

コード：

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

Products_GET_ById.java

コマンド：

java -classpath .:* -DproductId=1234 Products_GET_ById

コード：

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

	ProductResource productResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		productResource.getProduct(
			Long.valueOf(System.getProperty("productId"))));
}

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

製品にパッチを当てる

以下のcURLとJavaのコマンドで、既存の製品を更新します。 1234をお使いの製品のIDに置き換えてください。

Products_PATCH_ById.sh

コマンド：

./Products_PATCH_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/products/${1}" \
	--data-raw '
		{
			"name": {
				"en_US": "Bar"
			}
		}' \
	--header "Content-Type: application/json" \
	--request "PATCH" \
	--user "test@liferay.com:learn"

Products_PATCH_ById.java

コマンド：

java -classpath .:* -DproductId=1234 Products_PATCH_ById

コード：

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

	ProductResource productResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	productResource.patchProduct(
		Long.valueOf(System.getProperty("productId")),
		new Product() {
			{
				name = new HashMap<String, String>() {
					{
						put("en_US", "Bar");
					}
				};
			}
		});
}

製品を削除する

以下のcURLとJavaのコマンドで、既存の製品を削除します。 1234をお使いの製品のIDに置き換えてください。

Products_DELETE_ById.sh

コマンド：

./Products_DELETE_ById.sh 1234

コード：

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

Products_DELETE_ById.java

コマンド

java -classpath .:* -DproductId=1234 Products_DELETE_ById

コード：

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

	ProductResource productResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	productResource.deleteProduct(
		Long.valueOf(System.getProperty("productId")));
}

API エクスプローラーには、すべての 製品 サービスとスキーマが一覧表示され、各サービスを試すためのインターフェースがあります。

-RESTサービスの利用

Capability: