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

製品API - 複数のSKUを持つ製品の作成

製品APIまたは製品アプリケーションを使用することで、複数の有効なSKUを持つ製品を作成できます。 このような製品を作成するには、まず オプション API またはオプション アプリケーションを使用してオプション テンプレートを作成し、オプションに値が存在する必要があります。 オプション アプリケーションから値を追加するか、 オプション値 API を使用できます。

注

製品の「オプション」タブからオプションテンプレートを作成することもできます。 ただし、ここで追加される値は製品固有のものであり、グローバル メニュー (Applications Menu icon) → コマース → オプションにあるオプション テンプレートには追加されません。

複数のSKUを持つ商品を追加する

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

docker run -it -m 8g -p 8080:8080 liferay/dxp:2025.q1.6-lts

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

それでは、以下の手順に従ってください。

  1. Product API - 複数の SKU を持つ製品の追加 をダウンロードして解凍します。

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

    unzip liferay-q8t5.zip

  2. 製品はカタログに関連付けられており、カタログIDは必須パラメータの1つです。 複数の有効なSKUを持つためには、製品にオプションも必要となる。 オプションテンプレートを作成すれば、複数の製品で再利用できます。 オプションテンプレートを製品にリンクするには、オプションIDが必要です。

    カタログ ID を取得するには、 グローバル メニュー (Applications Menu icon) を開き、 コマース → カタログ に移動します。 商品を追加するカタログを選択し、その名前の横にあるIDをメモしてください。

    オプション ID を取得するには、 グローバル メニュー (Applications Menu icon) を開き、 コマース → オプション に移動します。 商品にリンクさせたいオプションを選択し、その名前の横に表示されるIDをメモしてください。

    重要

    この例では、 Able という名前で作成されたオプション テンプレートがあり、その中に Baker と Charlie という 2 つの値が含まれていることを想定しています。

  3. cURLスクリプトを使用して、複数のSKUを持つ新しい商品をカタログに追加します。 コマンドラインで、curlフォルダに移動します。 カタログ ID とオプション ID をパラメータとして指定し、 Products_POST_ToCatalog.sh スクリプトを実行します。

    ./Products_POST_ToCatalog.sh 1234 5678

    JSONレスポンスには、複数のSKUを持つ新製品が追加されたことが示されています。

    {
   "actions" : {
      "get" : {
         "method" : "GET",
         "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/products/46860"
      },
      "update" : {
         "method" : "PATCH",
         "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/products/46860"
      },
      "delete" : {
         "method" : "DELETE",
         "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/products/46860"
      }
   },
   "active" : true,
   "catalogId" : 1234,
   "categories" : [ ],
   "createDate" : "2023-06-09T11:32:27Z",
   "customFields" : [ ],
   "description" : {
      "en_US" : ""
   },
   "displayDate" : "2023-06-09T11:32:00Z",
   "expando" : { },
   "externalReferenceCode" : "82462cc8-1af3-0d14-30f2-d47b38946cf2",
   "id" : 46860,
   "metaDescription" : {
      "en_US" : ""
   },
   "metaKeyword" : {
      "en_US" : ""
   },
   "metaTitle" : {
      "en_US" : ""
   },
   "modifiedDate" : "2023-06-09T11:32:27Z",
   "name" : {
      "en_US" : "Foo"
   },
   "productAccountGroupFilter" : false,
   "productChannelFilter" : false,
   "productId" : 46861,
   "productStatus" : 0,
   "productType" : "simple",
   "productTypeI18n" : "Simple",
   "shortDescription" : {
      "en_US" : ""
   },
   "skuFormatted" : "(Multiple SKUs)",
   "tags" : [ ],
   "thumbnail" : "/o/commerce-media/default/?groupId=43744",
   "urls" : {
      "en_US" : "foo"
   },
   "version" : 1,
   "workflowStatusInfo" : {
      "code" : 0,
      "label" : "approved",
      "label_i18n" : "Approved"
   }
}

    skuFormatted フィールドには (複数の SKU) が表示され、複数の SKU が作成されていることが確認されます。

  4. グローバルメニュー (Applications Menu icon) を開き、 コマース → 製品 に移動してこれを確認してください。 関連付けられた製品オプションを表示するには、 オプション タブをクリックしてください。 SKU タブをクリックすると、承認済みのステータスを持つ 2 つの新しい SKU が表示されます。

    複数のSKUを持つ新製品が追加されていることを確認してください。

  5. Javaクライアントを使用してRESTサービスを呼び出すこともできます。 curl フォルダから、 java フォルダに移動します。 ソースファイルをコンパイルします。

    javac -classpath .:* *.java

  6. Products_POST_ToCatalog クラスを実行します。 catalogId と optionId を適切な値に置き換えてください。

    java -classpath .:* -DcatalogId=1234 -DoptionId=5678 Products_POST_ToCatalog

cURLコマンドの検証

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

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/products" \
	--data-raw '
		{
			"active": true,
			"catalogId": "'"${1}"'",
			"name": {
				"en_US": "Foo"
			},
			"productOptions": [
				{
					"fieldType": "select",
					"key": "able",
					"name": {
						"en_US": "Able"
					},
					"optionId": "'"${2}"'",
					"required": true,
					"skuContributor": true
				}
			],
			"productType": "simple",
			"skus": [
				{
					"published": true,
					"purchasable": true,
					"sku": "SKU-01",
					"skuOptions": [
						{
							"key": "able",
							"value": "Baker"
						}
					]
				},
				{
					"published": true,
					"purchasable": true,
					"sku": "SKU-02",
					"skuOptions": [
						{
							"key": "able",
							"value": "Charlie"
						}
					]
				}
			]
		}' \
	--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-catalog/v1.0/products"RESTサービスのエンドポイント
-d "{\"active\": true, \"catalogId\": \"${1}\", \"name\": {\"en_US\": \"Foo\"}, \"productOptions\": [{\"fieldType\": \"select\", \"key\": \"able\", \"name\": {\"en_US\": \"Able\"}, \"optionId\": \"${2}\", \"required\": true, \"skuContributor\": true}], \"productType\": \"simple\", \"skus\": [{\"published\": true, \"purchasable\": true, \"sku\": \"SKU-01\", \"skuOptions\": [{\"key\": \"able\", \"value\": \"Baker\"}]}, {\"published\": true, \"purchasable\": true, \"sku\": \"SKU-02\", \"skuOptions\": [{\"key\": \"able\", \"value\": \"Charlie\"}]}]}"投稿するデータ
-u "test@liferay.com:learn"基本的な認証情報
注

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

Javaクラスを調べる

Products_POST_ToCatalog.java クラスは、 ProductResource サービスを呼び出すことにより、複数の SKU を持つ製品を追加します。

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

	ProductResource productResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		productResource.postProduct(
			new Product() {
				{
					active = true;
					catalogId = Long.valueOf(
						System.getProperty("catalogId"));
					name = new HashMap<String, String>() {
						{
							put("en_US", "Foo");
						}
					};
					productOptions = new ProductOption[] {
						new ProductOption() {
							{
								fieldType = "select";
								key = "able";
								name = new HashMap<String, String>() {
									{
										put("en_US", "Able");
									}
								};
								optionId = Long.valueOf(
									System.getProperty("optionId"));
								required = true;
								skuContributor = true;
							}
						}
					};
					productType = "simple";
					skus = new Sku[] {
						new Sku() {
							{
								published = true;
								purchasable = true;
								sku = "SKU-01";
								skuOptions = new SkuOption[] {
									new SkuOption() {
										{
											key = "able";
											value = "Baker";
										}
									}
								};
							}
						},
						new Sku() {
							{
								published = true;
								purchasable = true;
								sku = "SKU-02";
								skuOptions = new SkuOption[] {
									new SkuOption() {
										{
											key = "able";
											value = "Charlie";
										}
									}
								};
							}
						}
					};
				}
			}));
}

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

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

プロジェクトには、依存関係としてcom.liferay.headless.commerce.admin.catalog.client.jarファイルが含まれていることに注意してください。 すべてのRESTアプリケーションのクライアントJAR依存関係情報は、/o/apiでインストール先のAPIエクスプローラーで確認できます。

注

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

ペイロードのレビュー

これは、2つの有効なSKUを持つ1つの製品を作成するために使用されるペイロードの例です。

{
   "active": true,
   "catalogId": 1234,
   "name": {
     "en_US": "Foo"
   },
   "productOptions":[
      {
         "fieldType": "select",
         "key": "able",
         "name": {
            "en_US": "Able"
         },
         "optionId": 5678,
         "required": true,
         "skuContributor": true
      }
   ],
   "productType": "simple",
   "skus": [
      {
         "published": true,
         "purchasable": true,
         "sku": "SKU-01",
         "skuOptions":[{
            "key": "able",
            "value": "Baker"
         }]
      },
      {
         "published": true,
         "purchasable": true,
         "sku": "SKU-02",
         "skuOptions":[{
            "key": "able",
            "value": "Charlie"
         }]
      }
   ]
}

JSONには合計6つのフィールドがあります。

項目説明
active商品の表示設定を変更するには、trueまたはfalseに設定してください。
catalogId製品カタログのID。
name製品名。
productOptions豊富な製品オプション。 ProductOption を参照してください。
productType製品の種類（単純型、グループ化型、仮想型、図表型）。
skus様々な製品SKU。 SKU を参照してください。

productOptions フィールドには、製品に関連付けられているオプションに関する情報が含まれています。

項目説明
fieldTypeオプションフィールドのタイプ。 "テキスト"、 "選択"、 "ラジオボタン"、 のいずれかになります。"複数選択チェックボックス"、 "日付"、 "数値"、または "チェックボックス"。
keyこのオプションの鍵となる点。
nameオプション名。
optionIdオプションのID。
required該当する場合は、チェックアウト前にオプションを選択する必要があります。
skuContributor該当する場合、各オプションはSKUにリンクされます。 これは、複数のSKUを持つ製品には必須です。

skus フィールドには、製品の SKU に関する情報が含まれています。

項目説明
published条件が満たされている場合、SKUはストアフロントに表示されます。
purchasable条件が満たされている場合、そのSKUは購入可能です。
skuSKUの名前。
skuOptions様々なSKUオプション。 SkuOption を参照してください。 キー はオプション テンプレートのキーであり、 値 はオプションの値の 1 つを指定します。
注

キー と 値 を skuOptions 内の optionId と optionValueId に置き換えることができます。

Capability:
Commerce
Resource Type:
Official Documentation
Feature:
Product Information
Products
Deployment Approach:
Liferay PaaS
Liferay SaaS
Liferay Self-Hosted