倉庫APIの基本
アプリケーションメニューやREST APIで倉庫管理できます。 倉庫を作成して管理するには、 headless-commerce-admin-inventory サービスを呼び出します。
倉庫の追加
新しいLiferay DXPインスタンスを起動し、以下を実行します。
docker run -it -m 8g -p 8080:8080 liferay/dxp:2025.q1.6-lts
メールアドレス test@liferay.com とパスワード testを使用して、 http://localhost:8080 で Liferay にサインインします。 プロンプトが表示されたら、パスワードを learnに変更します。
Liferayが起動したら、
-
Warehouse API の基礎をダウンロードして解凍します。
curl https://resources.learn.liferay.com/commerce/latest/en/inventory-management/developer-guide/liferay-v9s5.zip -Ounzip liferay-v9s5.zip -
倉庫はインスタンスにスコープされます。 cURLスクリプトを使用して、新しい倉庫を追加します。 コマンドラインで、
curlフォルダに移動します。Warehouses_POST_ToInstance.shスクリプトを実行します。./Warehouses_POST_ToInstance.shJSONレスポンスには、新しい倉庫が追加されたことが示されています。
{ "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" : "" } -
倉庫の追加を確認するには、 グローバル メニュー (
) を開き、 コマース → 倉庫に移動します。 新しい倉庫が表示されます。
注新しい倉庫は無効化されています。 アクティブ化する前に、
緯度と経度の座標を設定します。 -
または、Javaクライアントを使用してRESTサービスを呼び出します。
javajavac -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 エクスプローラーの /o/api (例: http://localhost:8080/o/api) で確認できます。
注
メイン メソッドのコメントは、クラスの実行を示しています。
残りのサンプル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));
}
インスタンスのWarehouseオブジェクトは、JSONでフォーマットされています。
倉庫の絞り込み、ページ分割、並び替え
このAPIでは、倉庫の絞り込み、ページ分割、並び替えを行うためのパラメータも許可します。 詳細については、 getWarehousesPage メソッドを参照してください。 クエリで以下のWarehouseフィールドを使用して、結果の絞り込みと並び替えを行うことができます。
- active
- city
- countryISOCode
- latitude
- longitude
- name
- regionISOCode
- street1
フィルタークエリ 説明 active eq true倉庫が有効になっている必要があります。 name eq 'Foo'倉庫名は ‘Foo'と等しくなければなりません latitude eq 12.0倉庫の緯度が12.0でなければなりません。
ソートクエリ 説明 name:desc名前で降順に並べ替えます。 countryISOCode:desc国のISOコードで降順に並べ替えます。
詳細については、 API クエリ パラメータ を参照してください。
倉庫を取得する
cURLまたはJava getコマンドで特定の倉庫を取得します。 1234を倉庫のIDに置き換えます。
ヒント
Warehouses_GET_FromInstance.[java|sh] を使用してすべての倉庫のリストを取得し、必要な倉庫の ID をメモします。
倉庫_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"
倉庫_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"))));
}
WarehouseフィールドがJSONに一覧表示されます。
倉庫にパッチを当てる
cURLとJava patch コマンドで既存の倉庫を更新します。 1234を倉庫のIDに置き換えます。
倉庫_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"
倉庫_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", "Bar");
}
};
}
});
}
倉庫を削除する
cURLとJava deleteコマンドで既存の倉庫を削除します。 1234を倉庫のIDに置き換えます。
倉庫_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"
倉庫_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 エクスプローラー には、 ウェアハウス のサービスとスキーマが表示され、各サービスをテストするためのインターフェースがあります。
関連トピック