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

カタログAPIの基本

アプリケーションメニューやREST APIでカタログ管理できます。 headless-commerce-admin-catalogサービスを呼び出し、カタログを作成・管理します。

カタログを追加する

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

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

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

Liferayが起動したら、

カタログ API の基本をダウンロードして解凍します。

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レスポンスには、新しいカタログが追加されたことが示されています。

{
   "アクション" : {
      "取得" : {
         "メソッド" : "GET"、
         "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/catalog/46110"
      },
      "更新" : {
         "メソッド" : "PATCH",
         "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/catalog/46110"
      },
      "delete" : {
         "メソッド" : "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" : "可能"、
   "システム" : 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\": \"可能\"}"`	投稿するデータを入力します。
`-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 = "可能";
				}
			}));
}

このクラスは、わずか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 ) で確認できます。

注記

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

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

重要

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

以下は、cURLとJavaを使用して他の カタログ 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);
}

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

カタログのフィルタリング、ページ分割、検索、および並べ替え

このAPIは、カタログのフィルタリング、ページネーション、検索、ソートを行うためのパラメータも受け付けます。詳細については、 getCatalogsPage メソッドを参照してください。 name フィールドを使用して、結果をフィルタリング、検索、および並べ替えることができます。

フィルタークエリ	説明
`名前が「Able」と等しい`	カタログ名はAbleと同じでなければなりません。

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

詳細については、 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"))));
}

カタログ フィールドは 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エクスプローラーは、 カタログ のサービスとスキーマを表示し、各サービスをテストするためのインターフェースを備えています。