製品APIの基本

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

製品の追加

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

docker run -it -m 8g -p 8080:8080 liferay/dxp:2024.q1.1。

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

次に、以下の手順を実行します。

Product API Basics をダウンロードし、解凍してください。

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

unzip liferay-z8v2.zip

製品はカタログにスコープされ、カタログIDは必須パラメータの1つである。 Global Menu() を開き、 Commerce → Catalogs を開きます。商品を追加するカタログを選択し、商品名の横にあるIDをメモしてください。

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

./Product_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"
}

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

cURLコマンドの検証

Product_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"`	基本的な認証情報

Note

ここでは、デモのためにベーシック認証を使用しています。本番環境では、 OAuth 2.0を使用する経由でユーザーを認可する必要があります。 OAuth2を活用したReactアプリケーションのサンプルは、 OAuth2によるユーザーの認証をご覧ください。

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

Javaクラスを調べる

Product_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();`	Basic 認証を指定し、 `ProductResource` サービスインスタンスを生成します。
`productResource.postProduct(...);`	`productResource.postProduct` メソッドを呼び出し、データをpostに渡します。

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

Note

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

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

Important

サービスの詳細は 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 メソッドをご覧ください。クエリでは、以下のProductフィールドを使用して、結果のフィルタリング、検索、並べ替えを行うことができます。

categoryIds
channelId
statusCode
customFields
createDate
modifiedDate
catalogId
name
productType

フィルタークエリ	説明
productType eq ‘simple’	製品タイプ＝シンプル
contains(name, ‘Bar’)	製品名にはBarを含む
customFields/sampleSize eq ‘100.0’.	sampleSizeというカスタムフィールドは100に等しい

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

詳しくは、 APIクエリパラメータをお読みください。

製品を入手する

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

tip

Products_GET_FromInstance.[java|sh] を使用して、すべての製品のリストを取得し、特に必要な製品の productId をメモしてください。

Product_GET_ById.sh

コマンド:

./Product_GET_ById.sh 1234

コード:

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

Product_GET_ById.java

コマンド:

java -classpath .:* -DproductId=1234 Product_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に置き換えてください。

Product_PATCH_ById.sh

コマンド:

./Product_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"

Product_PATCH_ById.java

コマンド:

java -classpath .:* -DproductId=1234 Product_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に置き換えてください。

Product_DELETE_ById.sh

コマンド:

./Product_DELETE_ById.sh 1234

コード:

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

Product_DELETE_ById.java

コマンド

java -classpath .:* -DproductId=1234 Product_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")));
}

RESTサービスの使用には、 Product の全サービスとスキーマがリストアップされており、各サービスを試用するためのインターフェイスが用意されています。

Capability:

Commerce

Deployment Approach:

Liferay PaaS

Liferay SaaS

Liferay Self-Hosted

Feature:

Product Information

Products

Cloud

Commerce

Content Management System

Development and Tooling

Digital Asset Management

DXP Self-Hosted Installation, Maintenance, and Administration

Integration

Personalization

Platform

Search

Security

Sites

Analytics Cloud

Commerce

DXP

Liferay Cloud

Reference