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

カタログ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が起動したら、

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

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

unzip liferay-q2v8.zip

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

./Catalogs_POST_ToInstance.sh

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

{
   "actions" : {
      "get" : {
         "method" : "GET",
         "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/catalog/46110"
      },
      "update" : {
         "method" : "PATCH",
         "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/catalog/46110"
      },
      "delete" : {
         "method" : "DELETE",
         "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/catalog/46110"
      }
   },
   "currencyCode" : "USD",
   "defaultLanguageId" : "en_US",
   "externalReferenceCode" : "246ad89e-8da1-546c-0d62-06ac7061e1da",
   "id" : 46110,
   "name" : "Able",
   "system" : false
}

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



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


cURLコマンドの検証
Catalogs_POST_ToInstance.sh スクリプトは、cURL コマンドを使用して REST サービスを呼び出します。
curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/catalogs" \
	--data-raw '
		{
			"currencyCode": "USD",
			"defaultLanguageId": "en_US",
			"name": "Able"
		}' \
	--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/catalogs" RESTサービスのエンドポイントを指定します。
-d "{\"currencyCode\": \"USD\", \"defaultLanguageId\": \"en_US\", \"name\": \"Able\"}" 投稿するデータを入力します。
-u "test@liferay.com:learn" 基本認証の認証情報を入力します。




注


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


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

	CatalogResource catalogResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		catalogResource.postCatalog(
			new Catalog() {
				{
					currencyCode = "USD";
					defaultLanguageId = "en_US";
					name = "Able";
				}
			}));
}

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


行（省略形） 説明


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


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


注


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


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


重要


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


以下は、cURLとJavaを使用して、他の Catalog RESTサービスを呼び出す例です。
インスタンスからカタログを取得する
cURLまたはJavaコマンドで、Liferayインスタンスのすべてのカタログをリストアップします。
Catalogs_GET_FromInstance.sh
コマンド：
./Catalogs_GET_FromInstance.sh

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

Catalogs_GET_FromInstance.java
コマンド：
java -classpath .:* Catalogs_GET_FromInstance

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

	CatalogResource catalogResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Page<Catalog> page = catalogResource.getCatalogsPage(
		null, null, Pagination.of(1, 2), null);

	System.out.println(page);
}

インスタンスの Catalog オブジェクトはJSONでフォーマットされています。
カタログの絞り込み、ページ分割、検索、並び替え
このAPIでは、カタログの絞り込み、ページ分割、検索、並べ替えを行うためのパラメーターも許可します。 詳細については、 getCatalogsPage メソッドを参照してください。 nameフィールドを使用して、結果の絞り込み、検索、並べ替えを行います。


フィルタークエリ 説明


name eq 'Able' カタログ名はAbleと同じでなければなりません。
  




ソートクエリ 説明


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


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


ヒント


すべてのカタログのリストを取得するには、 Catalogs_GET_FromInstance.[java|sh] を使用し、必要なカタログの id を書き留めます。


Catalog_GET_ById.sh
コマンド：
./Catalog_GET_ById.sh 1234

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

Catalog_GET_ById.java
コマンド：
java -classpath .:* -DcatalogId=1234 Catalog_GET_ById

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

	CatalogResource catalogResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		catalogResource.getCatalog(
			Long.valueOf(System.getProperty("catalogId"))));
}

Catalog のフィールドがJSONに一覧表示されます。
カタログにパッチを当てる
cURLとJava patch コマンドで既存のカタログを更新します。 1234をカタログのIDに置き換えます。
Catalog_PATCH_ById.sh
コマンド：
./Catalog_PATCH_ById.sh 1234

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

Catalog_PATCH_ById.java
コマンド：
java -classpath .:* -DcatalogId=1234 Catalog_PATCH_ById

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

	CatalogResource catalogResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	catalogResource.patchCatalog(
		Long.valueOf(System.getProperty("catalogId")),
		new Catalog() {
			{
				name = "Bar";
			}
		});
}

カタログを削除する
cURL と Java delete コマンドで既存のカタログを削除します。 1234をカタログのIDに置き換えます。
Catalog_DELETE_ById.sh
コマンド：
./Catalog_DELETE_ById.sh 1234

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

Catalog_DELETE_ById.java
コマンド
java -classpath .:* -DcatalogId=1234 Catalog_DELETE_ById

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

	CatalogResource catalogResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	catalogResource.deleteCatalog(
		Long.valueOf(System.getProperty("catalogId")));
}

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

製品APIの基本


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

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

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

フィルタークエリ	説明
`name eq 'Able'`	カタログ名はAbleと同じでなければなりません。