価格表APIの基本
アプリケーションメニューやREST APIで価格表を管理することができます。 価格表を作成および管理するには、 headless-admin-commerce-pricing サービスを呼び出します。
価格表を追加する
新しい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が起動したら、
-
Price List API Basicsをダウンロードして解凍します。
curl https://resources.learn.liferay.com/commerce/latest/en/pricing/developer-guide/liferay-c2v4.zip -Ounzip liferay-c2v4.zip -
価格表はカタログにスコープされているので、作成するにはカタログIDが必要です。
カタログの ID を取得するには、 グローバル メニュー (
) を開き、 コマース → カタログに移動します。 カタログを選択し、そのIDをコピーします。
-
cURLスクリプトを使用して、新しい価格表をカタログに追加します。 コマンドラインで、
curlフォルダに移動します。 適切なカタログ ID 値をパラメータとして、PriceLists_POST_ToCatalog.shスクリプトを実行します。./PriceLists_POST_ToCatalog.sh 1234JSONレスポンスには、新しい価格表が追加されたことが示されています。
{ "actions" : { "permissions" : { "method" : "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" : { "method" : "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" : "Test Test", "catalogBasePriceList" : false, "catalogId" : 1234, "catalogName" : "Master", "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" : "price-list", "workflowStatusInfo" : { "code" : 0, "label" : "approved", "label_i18n" : "Approved" } } -
価格表の追加を確認するには、 グローバル メニュー (
) を開き、 コマース → 価格表に移動します。 新しい価格表が表示されます。
-
または、Javaクライアントを使用してRESTサービスを呼び出します。
javajavac -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\", \"type\": \"price-list\"}"投稿するデータを入力します。 -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) で確認できます。
注
メイン メソッドのコメントは、クラスの実行を示しています。
残りのサンプル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 メソッドを参照してください。 次の PriceListフィールドを使用して、結果の絞り込み、検索、並べ替えを行います。
- accountId
- accountGroupId
- catalogId
- channelId
- orderTypeId
- name
- catalogBasePriceList
- type
- createDate
フィルタークエリ 説明 name eq '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:desccreateDateの降順でソートします。 createDate:desc,type:desc最初に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とJavapatchコマンドで既存の価格表を更新します。 1234 を価格表のIDに置き換えます。
価格リスト_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とJavadeleteコマンドで既存の価格表を削除します。 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 エクスプローラー には、 PriceList サービスとスキーマが表示され、各サービスをテストするためのインターフェースがあります。
関連トピック