Warehouse API の基礎知識

アプリケーションメニューやREST APIから倉庫を管理することができます。 headless-commerce-admin-inventory サービスを呼び出して、倉庫を作成・管理します。

倉庫の追加

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

docker run -it -m 8g -p 8080:8080 。

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

Liferayが起動したら。

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

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

    unzip liferay-v9s5.zip

  2. ウェアハウスはインスタンスにスコープされる。 cURLスクリプトを使用して、新しい倉庫を追加します。 コマンドラインで、 curl フォルダに移動します。 Warehouse_POST_ToInstance.sh スクリプトを実行する。

    ./Warehouse_POST_ToInstance.sh

    JSONレスポンスには、新しい倉庫が追加されたことが示されています。

    {
   "actions" : {
      "permissions" : {
         "method" : "PATCH",
         "href" : "http://localhost:8080/o/headless-commerce-admin-inventory/v1.0/warehouses/46429"
      },
      "get" : {
         "method" : "GET",
         "href" : "http://localhost:8080/o/headless-commerce-admin-inventory/v1.0/warehouses"
      },
      "update" : {
         "method" : "PATCH",
         "href" : "http://localhost:8080/o/headless-commerce-admin-inventory/v1.0/warehouses/46429"
      },
      "delete" : {
         "method" : "DELETE",
         "href" : "http://localhost:8080/o/headless-commerce-admin-inventory/v1.0/warehouses/46429"
      }
   },
   "active" : false,
   "city" : "",
   "countryISOCode" : "",
   "description" : { },
   "externalReferenceCode" : "c441eb70-dcd4-e040-92e5-eae0727cc958",
   "id" : 46429,
   "latitude" : 0.0,
   "longitude" : 0.0,
   "name" : {
      "en_US" : "Foo"
   },
   "regionISOCode" : "",
   "street1" : "",
   "street2" : "",
   "street3" : "",
   "type" : "",
   "zip" : ""
}

  3. 倉庫の追加を確認するには、 Global Menu(Applications Menu icon) を開き、 Commerce → Warehouses に移動してください。 新しいウェアハウスが表示されます。

    ウェアハウスが追加されたことを確認する。

    note

    新倉庫は非稼働です。 アクティブにする前に latitude と longitude の座標を設定する。

  4. または、Javaクライアントを使用してRESTサービスを呼び出します。 javaフォルダに移動し、ソースファイルをコンパイルします。

    javac -classpath .:* *.java

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

    java -classpath .:* Warehouse_POST_ToInstance

cURLコマンドの検証

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

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

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

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

Javaクラスを調べる

Warehouse_POST_ToInstance.java クラスは、 WarehouseResource サービスを呼び出して倉庫を追加します。

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

	WarehouseResource warehouseResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		warehouseResource.postWarehouse(
			new Warehouse() {
				{
					active = false;
					name = new HashMap<String, String>() {
						{
							put("en_US", "Foo");
						}
					};
				}
			}));
}

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

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

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

note

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

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

important

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

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

インスタンスからウェアハウスを取得する

cURLまたはJavaコマンドで、Liferayインスタンスのすべての倉庫をリストアップします。

Warehouses_GET_FromInstance.sh

コマンド：

./Warehouses_GET_FromInstance.sh

コード：

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

Warehouses_GET_FromInstance.java

コマンド：

java -classpath .:* Warehouses_GET_FromInstance

コード：


	WarehouseResource warehouseResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		warehouseResource.getWarehousesPage(
			null, Pagination.of(1, 2), null));
}

}

インスタンスの 倉庫 のオブジェクトは JSON でフォーマットされています。

倉庫のフィルタリング、ページ分割、並べ替え

このAPIは、倉庫をフィルタリング、ページ分割、ソートするためのパラメータも受け付けます。 詳しくは、 getWarehousesPage メソッドをご覧ください。 クエリで以下の Warehouse フィールドを使用して、結果をフィルタリングおよびソートすることができます。

  • 有効
  • 市区町村
  • カントリーアイエスオーコード
  • 緯度
  • 経度
  • name
  • リージョンISOCODE
  • ストリートワン
フィルタークエリ説明
active eq trueウェアハウスがアクティブであることが必要です。
name eq 'Foo'倉庫名は’Foo’と同じでなければなりません。
latitude eq 12.0倉庫の緯度が12.0になること。
ソートクエリ説明
name:desc名前の降順で並べる
countryISOCode:desc国のISOコードで降順に並べる

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

ウェアハウスを取得する

cURL または Java get コマンドで特定の倉庫を取得します。 1234 を倉庫のIDに置き換えてください。

tip

Warehouses_GET_FromInstance.[java|sh]を使用して、すべての倉庫のリストを取得し、特に欲しい倉庫の id をメモします。

Warehouse_GET_ById.sh

コマンド：

./Warehouse_GET_ById.sh 1234

コード：

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

Warehouse_GET_ById.java

コマンド：

java -classpath .:* -DwarehouseId=1234 Warehouse_GET_ById

コード：

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

	WarehouseResource warehouseResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		warehouseResource.getWarehouseId(
			Long.valueOf(System.getProperty("warehouseId"))));
}

Warehouse のフィールドは、JSONで表示されます。

倉庫にパッチを貼る

cURLとJava patch コマンドで既存の倉庫を更新します。 1234 を倉庫のIDに置き換えてください。

Warehouse_PATCH_ById.java

コマンド：

./Warehouse_PATCH_ById.sh 1234

コード：

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

Warehouse_PATCH_ById.java

コマンド：

java -classpath .:* -DwarehouseId=1234 Warehouse_PATCH_ById

コード：

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

	WarehouseResource warehouseResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	warehouseResource.patchWarehouseId(
		Long.valueOf(System.getProperty("warehouseId")),
		new Warehouse() {
			{
				name = new HashMap<String, String>() {
					{
						put("en_US", "Bar");
					}
				};
			}
		});
}

倉庫を削除する

cURL と Java delete コマンドで既存の倉庫を削除する。 1234 を倉庫のIDに置き換えてください。

Warehouse_DELETE_ById.sh

コマンド：

./Warehouse_DELETE_ById.sh 1234

コード：

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

Warehouse_DELETE_ById.java

コマンド：

java -classpath .:* -DwarehouseId=1234 Warehouse_DELETE_ById

コード：

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

	WarehouseResource warehouseResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	warehouseResource.deleteWarehouseId(
		Long.valueOf(System.getProperty("warehouseId")));
}

RESTサービスの使用 では、 Warehouse のサービスやスキーマが表示され、各サービスをテストするためのインターフェイスが用意されています。

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

Capabilities

Product

Contact Us

Connect

Powered by Liferay
© 2024 Liferay Inc. All Rights Reserved • Privacy Policy