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

価格表APIの基本

アプリケーションメニューやREST APIで価格表を管理することができます。 headless-admin-commerce-pricingを呼び出し、価格表を作成・管理します。

価格表の追加

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/pricing/developer-guide/liferay-c2v4.zip -O

unzip liferay-c2v4.zip

価格表はカタログに紐づいているため、作成するにはカタログIDが必要です。

カタログの ID を取得するには、 グローバルメニュー () を開き、 コマース → カタログ に移動します。カタログを選択し、そのIDをコピーしてください。

cURLスクリプトを使用して、カタログに新しい価格表を追加します。コマンドラインで、 curl フォルダーに移動します。適切なカタログ ID 値をパラメータとして指定して、 PriceLists_POST_ToCatalog.sh スクリプトを実行します。

./PriceLists_POST_ToCatalog.sh 1234

JSONレスポンスには、新しい価格表が追加されたことが示されています。

{
   "アクション" : {
      "パーミッション" : {
      "メソッド" : "PATCH"、
      "href" : "http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/price-lists/46002"
      },
      "get" : {
      "method" : "GET"、
      "href" : "http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/price-lists/46002"
      }、
      "update" : {
      "メソッド" : "PATCH"、
      "href" : "http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/price-lists/46002"
      },
      "delete" : {
      "method" : "DELETE",
      "href" : "http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/price-lists/46002"
      }
   },
   "active" : true,
   "author" : "テスト テスト"、
   "catalogBasePriceList" : false、
   "catalogId" : 1234、
   "catalogName" : "マスター"、
   "createDate" : "2023-01-04T12:41:03Z"、
   "currencyCode" : "USD"、
   "customFields" : { },
   "displayDate" : "2023-01-04T12:41:00Z",
   "externalReferenceCode" : "b314f22b-72ff-c47c-4fb6-c34539257821"、
   "id" : 46002、
   "name" : "Able"、
   "netPrice" : true,
   "parentPriceListId" : 0,
   "priority" : 0.0,
   "type" : "価格表"、
   "workflowStatusInfo" : {
      "コード" : 0、
      "ラベル" : "承認済み"、
      "label_i18n" : "承認済み"
   }
}

価格表の追加を確認するには、 グローバルメニュー () を開き、 コマース → 価格表 に移動します。新しい価格表が表示されました。
または、Javaクライアントを使用してRESTサービスを呼び出します。 java フォルダに移動し、ソースファイルをコンパイルします。
```
javac -classpath .:* *.java
```
PriceLists_POST_ToCatalog クラスを実行し、 catalogId を適切な値に置き換えます。
```
java -classpath .:* -DcatalogId=1234 PriceLists_POST_ToCatalog
```

cURLコマンドを調べてみましょう

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

curl \
	"http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/price-lists" \
	--data-raw '
		{
			"catalogId": "'"${1}"'"、
			"currencyCode": "USD"、
			"name": "Able"、
			"type": "price-list"
		}' \
	--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-pricing/v2.0/price-lists"`	RESTサービスのエンドポイントを指定します。
`-d "{\"catalogId\": ${1}, \"currencyCode\": \"USD\", \"name\": \"Able\", \"タイプ\": \"価格表\"}"`	投稿するデータを入力します。
`-u "test@liferay.com:learn"`	基本認証の認証情報を入力します。

注記

ここでは、デモンストレーション目的で基本認証を使用しています。本番環境では、 OAuth2 を介してユーザーを認証する必要があります。 OAuth2 を使用した React アプリケーションの例については、 OAuth2 を使用してユーザーを認証するを参照してください。

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

Javaクラスを調べます

PriceLists_POST_ToCatalog.java クラスは、 PriceListResource サービスを呼び出すことで価格リストを追加します。

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

	PriceListResource priceListResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		priceListResource.postPriceList(
			new PriceList() {
				{
					catalogId = Long.valueOf(
						System.getProperty("catalogId"));
					currencyCode = "USD";
					name = "Able";
					type = PriceList.Type.PRICE_LIST;
				}
			}));
}

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

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

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

注記

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

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

重要

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

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

インスタンスから価格表を取得する

cURLまたはJavaコマンドを使用して、Liferayインスタンス内のすべての価格表を一覧表示します。

PriceLists_GET_FromInstance.sh

コマンド：

./PriceLists_GET_FromInstance.sh

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/price-lists" \
	--user "test@liferay.com:learn"

PriceLists_GET_FromInstance.java

コマンド：

java -classpath .:* PriceLists_GET_FromInstance

コード：

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

	PriceListResource priceListResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Page<PriceList> page = priceListResource.getPriceListsPage(
		null, null, Pagination.of(1, 2), null);

	System.out.println(page);
}

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

価格表のフィルタリング、ページネーション、検索、および並べ替え

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

アカウントID
アカウントグループID
カタログID
チャネルID
注文タイプID
名前
カタログ基本価格表
タイプ
作成日

フィルタークエリ	説明
`名前が「Able」と等しい`	価格表名はAbleに等しくなければなりません。
`createDate gt 2022-12-31T12:00:00Z`	価格表作成日は2022年12月31日12:00:00より後である必要があります。
`catalogId/any(x:(x eq 43956) and (x eq 43199))`	カタログ43956と43199に関連する価格表と一致します。 `any`は、後続の式の少なくとも1つが`true`を返さなければならないことを意味します。

accountId、 accountGroupId、 catalogId、 channelId、および orderTypeId フィルタフィールドはコレクションフィールドです。コレクションフィールドによるフィルタリングは、上記の表の3行目に示すように行う必要があります。

ソートクエリ	説明
`作成日:説明`	createDateの降順でソートします。
`作成日:説明、タイプ:説明`	最初にcreateDateの降順でソートし、次にtypeの降順でソートします。

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

価格表を入手する

cURL または Java get コマンドを使用して、特定の価格表を取得します。 1234 を価格表の ID に置き換えてください。

ヒント

PriceLists_GET_FromInstance.[java|sh] を使用してすべての価格表のリストを取得し、特に必要な価格表の id をメモしてください。

PriceLists_GET_ById.sh

コマンド：

./PriceLists_GET_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/price-lists/${1}" \
	--user "test@liferay.com:learn"

PriceLists_GET_ById.java

コマンド：

java -classpath .:* -DpriceListId=1234 PriceLists_GET_ById

コード：

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

	PriceListResource priceListResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		priceListResource.getPriceList(
			Long.valueOf(System.getProperty("priceListId"))));
}

PriceList フィールドは JSON でリストされます。

価格表を修正する

cURL と Java patch コマンドを使用して、既存の価格表を更新します。 1234 を価格表の ID に置き換えてください。

PriceLists_PATCH_ById.sh

コマンド：

./PriceLists_PATCH_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/price-lists/${1}" \
	--data-raw '
		{
			"name": "Baker"
		}' \
	--header "Content-Type: application/json" \
	--request "PATCH" \
	--user "test@liferay.com:learn"

PriceLists_PATCH_ById.java

コマンド：

java -classpath .:* -DpriceListId=1234 PriceLists_PATCH_ById

コード：

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

	PriceListResource priceListResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	priceListResource.patchPriceList(
		Long.valueOf(System.getProperty("priceListId")),
		new PriceList() {
			{
				name = "Baker";
			}
		});
}

価格表を削除する

cURLとJava delete コマンドを使用して、既存の価格表を削除します。 1234 を価格表の ID に置き換えてください。

PriceLists_DELETE_ById.sh

コマンド:

./PriceLists_DELETE_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-pricing/v2.0/price-lists/${1}" \
	--request "DELETE" \
	--user "test@liferay.com:learn"

PriceLists_DELETE_ById.java

コマンド

java -classpath .:* -DpriceListId=1234 PriceLists_DELETE_ById

コード:

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

	PriceListResource priceListResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	priceListResource.deletePriceList(
		Long.valueOf(System.getProperty("priceListId")));
}

API Explorer は PriceList サービスとスキーマを表示し、各サービスをテストするためのインターフェースを備えています。