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

注文タイプAPIの基本

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

注文タイプの追加

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/order-management/developer-guide/liferay-t5n8.zip -O

unzip liferay-t5n8.zip

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

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

./OrderTypes_POST_ToInstance.sh

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

{
   "アクション" : {
      "パーミッション" : {
         "メソッド" : "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" : {
         "メソッド" : "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" : { },
   "説明" : { },
   "表示日時" : "2023-03-23T16:30:00Z",
   "表示順序" : 0,
   "externalReferenceCode" : "fd8fbd90-0f19-0d4d-46db-c7807f3660ce",
   "id" : 48698,
   "name" : {
      "en_US" : "Foo"
   },
   "workflowStatusInfo" : {
      "code" : 0,
      "ラベル" : "承認済み"、
      "label_i18n" : "承認済み"
   }
}

グローバルメニュー () → コマース → 注文タイプ に移動します。新しく追加された注文タイプが表示されます。
または、Javaクライアントを使用してRESTサービスを呼び出します。 java フォルダに移動し、ソースファイルをコンパイルします。
```
javac -classpath .:* *.java
```
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 "test@liferay.com: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 "test@liferay.com: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(
		"test@liferay.com", "learn"
	).build();

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

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

注記

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

残りのサンプル 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 "test@liferay.com: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(
		"test@liferay.com", "learn"
	).build();

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

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

ページネーション、検索、および並べ替えの順序タイプ

返された注文タイプは、ページ分割、検索、および並べ替えが可能です。詳細については、 getOrderTypesPage メソッドを参照してください。 name フィールドを使用して、結果を検索および並べ替えます。

ソートクエリ	説明
`名前:説明`	`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 "test@liferay.com: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(
		"test@liferay.com", "learn"
	).build();

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

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

注文タイプをパッチする

cURLとJava patch コマンドを使用して、既存の注文タイプを更新します。 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 "test@liferay.com: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(
		"test@liferay.com", "learn"
	).build();

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

注文タイプを削除する

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 "test@liferay.com: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(
		"test@liferay.com", "learn"
	).build();

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

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

Capability: