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

倉庫APIの基本

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

倉庫を追加する

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

Warehouse API の基本をダウンロードして解凍します。

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

unzip liferay-v9s5.zip

倉庫はインスタンスごとにスコープが設定されます。 cURLスクリプトを使用して、新しい倉庫を追加します。コマンドラインで、 curl フォルダーに移動します。 Warehouses_POST_ToInstance.sh スクリプトを実行します。

./Warehouses_POST_ToInstance.sh

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

{
   "アクション" : {
      "パーミッション" : {
         "メソッド" : "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" : {
         "メソッド" : "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、
   "緯度" : 0.0、
   "経度" : 0.0,
   "name" : {
      "en_US" : "Foo"
   },
   "regionISOCode" : ""、
   "street1" : ""、
   "street2" : ""、
   "street3" : ""、
   "type" : ""、
   "zip" : ""
}

倉庫の追加を確認するには、 グローバルメニュー () を開き、 コマース → 倉庫に移動します。新しい倉庫が現れた。

注記

新しい倉庫は現在稼働していません。有効化する前に、緯度と 経度の座標を設定してください。
または、Javaクライアントを使用してRESTサービスを呼び出します。 java フォルダに移動し、ソースファイルをコンパイルします。
```
javac -classpath .:* *.java
```
Warehouses_POST_ToInstance クラスを実行します。
```
java -classpath .:* Warehouses_POST_ToInstance
```

cURLコマンドを調べてみましょう

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

注記

ここでは、デモンストレーション目的で基本認証を使用しています。本番環境では、 OAuth2 を介してユーザーを認証する必要があります。 OAuth2 を使用した React アプリケーションの例については、 OAuth2 を使用してユーザーを認証するを参照してください。

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

Javaクラスを調べます

Warehouses_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`メソッドを呼び出し、投稿するデータを渡します。

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

注記

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

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

重要

サービスの詳細については、 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

コード：

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.getWarehousesPage(
			null, Pagination.of(1, 2), null));
}

インスタンスの ウェアハウス オブジェクトは JSON 形式でフォーマットされています。

倉庫のフィルタリング、ページネーション、およびソート

このAPIは、倉庫のフィルタリング、ページネーション、およびソートを行うためのパラメータも受け付けます。詳細については、 getWarehousesPage メソッドを参照してください。クエリで次の ウェアハウス フィールドを使用して、結果をフィルタリングおよびソートできます。

アクティブ
市
国別ISOコード
緯度
経度
名前
地域ISOコード
ストリート1

フィルタークエリ	説明
`アクティブeq true`	倉庫が有効になっている必要があります。
`名前が「Foo」と等しい`	倉庫名は ‘Foo' と等しくなければなりません
`緯度 12.0`	倉庫の緯度が12.0でなければなりません。

ソートクエリ	説明
`名前:説明`	名前で降順に並べ替えます。
`国ISOコード:説明`	国のISOコードで降順に並べ替えます。

詳細については、 APIクエリパラメータをお読みください。

倉庫を取得する

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

ヒント

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

Warehouses_GET_ById.sh

コマンド：

./Warehouses_GET_ById.sh 1234

コード：

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

Warehouses_GET_ById.java

コマンド：

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

倉庫 フィールドは JSON でリストされています。

倉庫をパッチする

cURL と Java patch コマンドを使用して、既存のウェアハウスを更新します。 1234 を倉庫の ID に置き換えてください。

Warehouses_PATCH_ById.sh

コマンド：

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

Warehouses_PATCH_ById.java

コマンド：

java -classpath .:* -DwarehouseId=1234 Warehouses_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", "バー");
					}
				};
			}
		});
}

倉庫を削除する

cURLとJava delete コマンドを使用して既存のウェアハウスを削除します。 1234 を倉庫の ID に置き換えてください。

Warehouses_DELETE_ById.sh

コマンド：

./Warehouses_DELETE_ById.sh 1234

コード：

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

Warehouses_DELETE_ById.java

コマンド

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

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

Capability: