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

規約APIの基本

アプリケーションメニューやREST APIで利用規約を管理できます。 利用規約を作成および管理するには、 headless-admin-commerce-order の /terms エンドポイントを使用します。

規約の追加

新しい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が起動したら、

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

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

    unzip liferay-a9v8.zip

  2. 利用規約を作成するには、ラベル、名前、重要度、タイプの4つのパラメーターが必要です。

    パラメーター値のタイプ説明/
    例
    ラベルテキストボックスロケール/値のプロパティをコンマで区切って入力してください:
    {"en_US": "Foo", "es_ES": "Bar"}
    名前テキストボックス利用規約項目の一意の名前を入力してください:
    "name": "foo"
    重要度数値（double）一意の数値優先度を入力してください:
    "優先度": 1.2
    種類テキストボックス"支払条件" または "配送条件"を指定します:
    "タイプ": "支払条件"

    cURLスクリプトを使用して、インスタンスに利用規約を追加します。 コマンドラインで、curlフォルダに移動します。 Terms_POST_ToInstance.sh スクリプトを実行します。

    ./Terms_POST_ToInstance.sh

    JSONレスポンスには、新しく追加された利用規約が表示されます。

    {
   "actions" : {
      "permissions" : {
         "method" : "PATCH",
         "href" : "http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms/46418"
      },
      "get" : {
         "method" : "GET",
         "href" : "http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms/46418"
      },
      "update" : {
         "method" : "PATCH",
         "href" : "http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms/46418"
      },
      "delete" : {
         "method" : "DELETE",
         "href" : "http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms/46418"
      }
   },
   "active" : false,
   "description" : {
      "en_US" : ""
   },
   "displayDate" : "2023-03-03T13:16:00Z",
   "externalReferenceCode" : "7fa19a0c-4c98-6c36-f1bc-5a2c4257220c",
   "id" : 46418,
   "label" : {
      "en_US" : "Foo"
   },
   "name" : "foo",
   "priority" : 0.0,
   "type" : "payment-terms",
   "typeLocalized" : "Payment Terms",
   "typeSettings" : "",
   "workflowStatusInfo" : {
      "code" : 0,
      "label" : "approved",
      "label_i18n" : "Approved"
   }
}

  3. グローバル メニュー (Applications Menu icon) → コマース → 利用規約に移動します。 新しく追加された規約が表示されます。

    利用規約の追加を確認する。

  4. または、Javaクライアントを使用してRESTサービスを呼び出します。 java 

    javac -classpath .:* *.java

  5. Terms_POST_ToInstance クラスを実行します。

    java -classpath .:* Terms_POST_ToInstance

cURLコマンドの検証

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

curl \
	"http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms" \
	--data-raw '
		{
			"label": {
				"en_US": "Foo"
			},
			"name": "foo",
			"priority": 0,
			"type": "payment-terms"
		}' \
	--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-order/v1.0/terms"RESTサービスのエンドポイントを指定します。
-d "{\"label\": {\"en_US\": \"Foo\"}, \"name\": \"foo\", \"priority\": 0, \"type\": \"payment-terms\"}"投稿するデータを入力します。
-u "test@liferay.com:learn"基本認証の認証情報を入力します。
注

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

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

Javaクラスを調べる

Terms_POST_ToInstance.java クラスは、 TermResource サービスを呼び出して利用規約を追加します。

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

	TermResource termResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		termResource.postTerm(
			new Term() {
				{
					label = new HashMap<String, String>() {
						{
							put("en_US", "Foo");
						}
					};
					name = "foo";
					priority = 0D;
					type = "payment-terms";
				}
			}));
}

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

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

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

注

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

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

重要

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

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

インスタンスから規約を取得する

cURLまたはJavaコマンドで、Liferayインスタンスの全利用規約を一覧表示することができます。

Terms_GET_FromInstance.sh

コマンド：

./Terms_GET_FromInstance.sh

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms" \
	--user "test@liferay.com:learn"

Terms_GET_FromInstance.java

コマンド：

java -classpath .:* Terms_GET_FromInstance

コード：

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

	TermResource termResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		termResource.getTermsPage(null, null, Pagination.of(1, 2), null));
}

インスタンスのTermオブジェクトがJSONに一覧表示されます。

規約の絞り込み、ページ分割、検索、並び替え

返された利用規約の絞り込み、ページ分割、検索、並び替えを行うことができます。 詳細については、 getTermsPage メソッドを参照してください。 priorityおよびtypeフィールドを使用して、結果の絞り込み、検索、並べ替えを行います。

フィルタークエリ説明
type eq 'payment-terms'利用規約は、payment-termsタイプでなければなりません。
priority eq 0利用規約の重要度が0でなければなりません。
ソートクエリ説明
priority:descpriorityで降順に並び替えます。
priority:desc,type:descまずpriorityで降順に並べ替え、次にtypeで降順に並び替えます。

詳細については、 API クエリ パラメータ を参照してください。

規約を取得する

cURLとJavaのgetコマンドで特定の利用規約を取得します。 1234を利用規約のIDに置き換えます。

ヒント

すべての利用規約のリストを取得するには、 Terms_GET_FromInstance.[java|sh] を使用し、具体的に必要な利用規約の id を書き留めておきます。

用語_GET_ById.sh

コマンド：

./Terms_GET_ById.sh 1234

コード：

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

用語_GET_ById.java

コマンド：

java -classpath .:* -DtermId=1234 Terms_GET_ById

コード：

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

	TermResource termResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		termResource.getTerm(Long.valueOf(System.getProperty("termId"))));
}

TermフィールドはJSONでフォーマットされています。

規約にパッチを当てる

cURLとJava patchコマンドで既存の利用規約を更新します。 1234を利用規約のIDに置き換えます。

用語_PATCH_ById.sh

コマンド：

./Terms_PATCH_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-order/v1.0/terms/${1}" \
	--data-raw '
		{
			"label": {
				"en_US": "Bar"
			}
		}' \
	--header "Content-Type: application/json" \
	--request "PATCH" \
	--user "test@liferay.com:learn"

用語_PATCH_ById.java

コマンド：

java -classpath .:* -DtermId=1234 Terms_PATCH_ById

コード：

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

	TermResource termResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	termResource.patchTerm(
		Long.valueOf(System.getProperty("termId")),
		new Term() {
			{
				label = new HashMap<String, String>() {
					{
						put("en_US", "Bar");
					}
				};
			}
		});
}

規約を削除する

cURLとJavaの delete コマンドで既存の規約を削除します。 1234を利用規約のIDに置き換えます。

用語_DELETE_ById.sh

コマンド：

./Terms_DELETE_ById.sh 1234

コード：

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

用語_DELETE_ById.java

コマンド

java -classpath .:* -DtermId=1234 Terms_DELETE_ById

コード：

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

	TermResource termResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	termResource.deleteTerm(Long.valueOf(System.getProperty("termId")));
}

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

Capability:
Commerce
Resource Type:
Official Documentation
Feature:
API Development
Orders and Fulfillment
Deployment Approach:
Liferay PaaS
Liferay SaaS
Liferay Self-Hosted