フィードバックを送信

Order Type API 基本編

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

オーダータイプを追加する

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

docker run -it -m 8g -p 8080:8080 liferay/dxp:2024.q2.11。

メールアドレス test@liferay.com とパスワード test を使用して、http://localhost:8080でLiferayにサインインしてください。プロンプトが表示されたら、パスワードを learn に変更します。

Liferayが起動したら、

Order Type API Basics](./liferay-t5n8.zip)をダウンロードし、解凍してください。

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

unzip liferay-t5n8.zip

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

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

./OrderType_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"
   }
}

Global Menu() → Commerce → Order Types に移動します。新しく追加された注文タイプが表示されます。
または、Javaクライアントを使用してRESTサービスを呼び出します。 javaフォルダに移動し、ソースファイルをコンパイルします。
```
javac -classpath .:* *.java
```
OrderType_POST_ToInstance クラスを実行します。
```
java -classpath .:* OrderType_POST_ToInstance
```

cURLコマンドの検証

OrderType_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"`	基本認証の認証情報を入力します。

note

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

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

Javaクラスを調べる

OrderType_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", "Foo");
						}
					};
				}
			}));
}

このクラスは、次の3行のコードのみを使用してRESTサービスを呼び出します。

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

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

note

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

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

important

サービスの詳細は OrderTypeResource を参照ください。

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

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

LiferayインスタンスからcURLやJavaのコマンドで全ての注文タイプをリストアップできます。

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:desc`	`名前` で降順に並びます。

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

オーダータイプを取得する

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

tip

OrderTypes_GET_FromInstance.[java|sh]を使用して、すべてのオーダータイプのリストを取得し、特に欲しいオーダータイプの id をメモします。

OrderType_GET_ById.sh

コマンド：

./OrderType_GET_ById.sh 1234

コード：

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

OrderType_GET_ById.java

コマンド：

java -classpath .:* -DorderTypeId=1234 OrderType_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の パッチ コマンドで既存の注文タイプを更新します。 1234 を注文種別のIDに置き換えてください。

OrderType_PATCH_ById.sh

コマンド：

./OrderType_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"

OrderType_PATCH_ById.java

コマンド：

java -classpath .:* -DorderTypeId=1234 OrderType_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", "Bar");
					}
				};
			}
		});
}

オーダータイプを削除する

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

OrderType_DELETE_ById.sh

コマンド：

./OrderType_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"

OrderType_DELETE_ById.java

コマンド：

java -classpath .:* -DorderTypeId=1234 OrderType_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")));
}

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

Capability: