注文タイプAPIの基本

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

注文タイプを追加する

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

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

メールアドレス [e-mail] とパスワード testを使用して、 http://localhost:8080 で Liferay にサインインします。 プロンプトが表示されたら、パスワードを learnに変更します。

Liferayが起動したら、

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

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

   unzip liferay-t5n8.zip
   

2. 注文タイプはインスタンスにスコープされ、作成にはnameが必要です。

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

   ./OrderTypes_POST_ToInstance.sh
   

   JSONレスポンスには、新しく追加された注文タイプが表示されます：

   {
      "actions" : {
         "permissions" : {
            "method" : "PATCH",
            "href" : "http://localhost:9090/o/headless-commerce-admin-order/v1.0/order-types/48698"
         },
         "get" : {
            "method" : "GET",
            "href" : "http://localhost:9090/o/headless-commerce-admin-order/v1.0/order-types/48698"
         },
         "update" : {
            "method" : "PATCH",
            "href" : "http://localhost:9090/o/headless-commerce-admin-order/v1.0/order-types/48698"
         },
         "delete" : {
            "method" : "DELETE",
            "href" : "http://localhost:9090/o/headless-commerce-admin-order/v1.0/order-types/48698"
         }
      },
      "active" : false,
      "customFields" : { },
      "description" : { },
      "displayDate" : "2023-03-23T16:30:00Z",
      "displayOrder" : 0,
      "externalReferenceCode" : "fd8fbd90-0f19-0d4d-46db-c7807f3660ce",
      "id" : 48698,
      "name" : {
         "en_US" : "Foo"
      },
      "workflowStatusInfo" : {
         "code" : 0,
         "label" : "approved",
         "label_i18n" : "Approved"
      }
   }
   

3. グローバル メニュー () → コマース → 注文タイプに移動します。 新しく追加された注文タイプが表示されます。

   

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

   javac -classpath .:* *.java
   

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

   java -classpath .:* OrderTypes_POST_ToInstance
   

cURLコマンドの検証

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

curl \
	"http://localhost:8080/o/headless-commerce-admin-order/v1.0/order-types" \
	--data-raw '
		{
			"name": {
				"en_US": "Foo"
			}
		}' \
	--header "Content-Type: application/json" \
	--request "POST" \
	--user "[e-mail]:learn"

ここでは、コマンドの引数を紹介します。

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

注

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

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

Javaクラスを調べる

OrderTypes_POST_ToInstance.java クラスは、 OrderTypeResource サービスを呼び出して注文タイプを追加します。

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

	OrderTypeResource orderTypeResource = builder.authentication(
		"[e-mail]", "learn"
	).build();

	System.out.println(
		orderTypeResource.postOrderType(
			new OrderType() {
				{
					name = new HashMap<String, String>() {
						{
							put("en_US", "Foo");
						}
					};
				}
			}));
}

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

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

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

注

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

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

重要

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

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

インスタンスから注文タイプを取得する

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

OrderTypes_GET_FromInstance.sh

コマンド：

./OrderTypes_GET_FromInstance.sh

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-order/v1.0/order-types" \
	--user "[e-mail]:learn"

OrderTypes_GET_FromInstance.java

コマンド：

java -classpath .:* OrderTypes_GET_FromInstance

コード：

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

	OrderTypeResource orderTypeResource = builder.authentication(
		"[e-mail]", "learn"
	).build();

	System.out.println(
		orderTypeResource.getOrderTypesPage(
			null, null, Pagination.of(1, 2), null));
}

インスタンスの OrderType オブジェクトがJSONで表示されます。

注文タイプのページネーション、検索、並び替え

返された注文タイプのページネーション、検索、並べ替えができます。 詳細については、 getOrderTypesPage メソッドを参照してください。 nameフィールドを使用して、結果の検索や並べ替えをします。

ソートクエリ	説明
name:desc	nameで降順にソートします。

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

注文タイプを取得する

cURLとJava get コマンドで、特定の注文タイプを取得します。 1234 を注文タイプのIDに置き換えてください。

ヒント

OrderTypes_GET_FromInstance.[java|sh] を使用してすべての注文タイプのリストを取得し、具体的に必要な注文タイプの id をメモします。

OrderTypes_GET_ById.sh

コマンド：

./OrderTypes_GET_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-order/v1.0/order-types/${1}" \
	--user "[e-mail]:learn"

OrderTypes_GET_ById.java

コマンド：

java -classpath .:* -DorderTypeId=1234 OrderTypes_GET_ById

コード：

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

	OrderTypeResource orderTypeResource = builder.authentication(
		"[e-mail]", "learn"
	).build();

	System.out.println(
		orderTypeResource.getOrderType(
			Long.valueOf(System.getProperty("orderTypeId"))));
}

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

注文タイプをパッチする

cURLとJavaの パッチ コマンドで既存の注文タイプを更新します。 1234 を注文タイプのIDに置き換えてください。

OrderTypes_PATCH_ById.sh

コマンド：

./OrderTypes_PATCH_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-order/v1.0/order-types/${1}" \
	--data-raw '
		{
			"name": {
				"en_US": "Bar"
			}
		}' \
	--header "Content-Type: application/json" \
	--request "PATCH" \
	--user "[e-mail]:learn"

OrderTypes_PATCH_ById.java

コマンド：

java -classpath .:* -DorderTypeId=1234 OrderTypes_PATCH_ById

コード：

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

	OrderTypeResource orderTypeResource = builder.authentication(
		"[e-mail]", "learn"
	).build();

	orderTypeResource.patchOrderType(
		Long.valueOf(System.getProperty("orderTypeId")),
		new OrderType() {
			{
				name = new HashMap<String, String>() {
					{
						put("en_US", "Bar");
					}
				};
			}
		});
}

注文タイプを削除する

cURL および Java の delete コマンドで、既存の注文タイプを削除します。 1234 を注文タイプのIDに置き換えてください。

OrderTypes_DELETE_ById.sh

コマンド：

./OrderTypes_DELETE_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-commerce-admin-order/v1.0/order-types/${1}" \
	--request "DELETE" \
	--user "[e-mail]:learn"

OrderTypes_DELETE_ById.java

コマンド

java -classpath .:* -DorderTypeId=1234 OrderTypes_DELETE_ById

コード：

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

	OrderTypeResource orderTypeResource = builder.authentication(
		"[e-mail]", "learn"
	).build();

	orderTypeResource.deleteOrderType(
		Long.valueOf(System.getProperty("orderTypeId")));
}

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

関連トピック

• 注文APIの基本
• 規約APIの基本