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

注文APIの基本

アプリケーションメニューから、またはREST APIを使って注文を管理できます。 headless-admin-commerce-order サービスを呼び出して、注文を作成・管理します。

注文を追加する

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

  1. ダウンロードして解凍します 注文APIの基本。

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

    unzip liferay-w6c8.zip

  2. 注文を作成するには、アカウント ID、チャネル ID、および使用する通貨の ISO 4217 通貨コード (例: USD) の 3 つのパラメータが必要です。

    アカウント ID を取得するには、 グローバル メニュー (Applications Menu icon) を開き、 コントロール パネル → アカウント に移動します。 アカウントを見つけて、そのIDをコピーしてください。 または、アカウントを選択して、 アカウント ID をコピーします。

    アカウントIDをコピーしてください。

    チャンネル ID を取得するには、 グローバル メニュー (Applications Menu icon) を開き、 コマース → チャンネル に移動します。 注文を追加するチャネルを選択し、そのIDをコピーしてください。

    チャンネルIDをコピーしてください。

  3. cURLスクリプトを使用して、チャネルに新しい注文を追加します。 コマンドラインで、 curl フォルダーに移動します。 アカウント ID、チャネル ID、通貨コードに適切な値を指定して Orders_POST_ToChannel.sh スクリプトを実行します。

    ./Orders_POST_ToChannel.sh 1234 5678 USD

    JSONレスポンスには、そのアカウントとチャネルに新しい注文が追加されたことが示されています。

    {
   "accountExternalReferenceCode" : "cc-west",
   "accountId" : 1234,
   "actions" : {
      "get" : {
         "method" : "GET",
         "href" : "http://localhost:8080/o/headless-commerce-admin-order/v1.0/orders/{id}"
      },
      "update" : {
         "メソッド" : "PATCH",
         "href" : "http://localhost:8080/o/headless-commerce-admin-order/v1.0/orders/{id}"
      },
      "delete" : {
         "method" : "DELETE",
         "href" : "http://localhost:8080/o/headless-commerce-admin-order/v1.0/orders/{id}"
      }
   },
   "advanceStatus" : "",
   "billingAddressId" : 0,
   "channelExternalReferenceCode" : "c8957c2f-4eb1-ce8f-4a38-5251bf740198",
   "channelId" : 5678,
   "couponCode" : "",
   "createDate" : "2023-01-03T12:25:15Z",
   "currencyCode" : "USD",
   "customFields" : { },
   "deliveryTermDescription" : "",
   "deliveryTermId" : 0,
   "deliveryTermName" : "",
   "externalReferenceCode" : "3ebcbc91-7240-2763-c2ce-f2a592851053",
   "id" : 45955,
   "modifiedDate" : "2023-01-03T12:25:15Z",
   "orderDate" : "2023-01-03T12:25:15Z",
   "orderStatus" : 1,
   "orderStatusInfo" : {
      "code" : 1,
      "label" : "pending",
      "label_i18n" : "保留中"
   },
   "orderTypeId" : 0,
   "paymentMethod" : "",
   "paymentStatus" : 1,
   "paymentStatusInfo" : {
      "code" : 1,
      "label" : "保留中",
      "label_i18n" : "保留中"
   },
   "paymentTermDescription" : "",
   "paymentTermId" : 0,
   "paymentTermName" : "",
   "printedNote" : "",
   "purchaseOrderNumber" : "",
   "shippingAddressId" : 0,
   "shippingAmountFormatted" : "$ 0.00",
   "shippingAmountValue" : 0.0,
   "shippingDiscountAmount" : 0,
   "shippingDiscountAmountFormatted" : "$ 0.00",
   "shippingDiscountPercentageLevel1" : 0,
   "shippingDiscountPercentageLevel1WithTaxAmount" : 0,
   "shippingDiscountPercentageLevel2" : 0,
   "shippingDiscountPercentageLevel2WithTaxAmount" : 0,
   "shippingDiscountPercentageLevel3" : 0,
   "shippingDiscountPercentageLevel3WithTaxAmount" : 0,
   "shippingDiscountPercentageLevel4" : 0,
   "shippingDiscountPercentageLevel4WithTaxAmount" : 0,
   "shippingDiscountWithTaxAmount" : 0,
   "shippingDiscountWithTaxAmountFormatted" : "$ 0.00",
   "shippingOption" : "",
   "shippingWithTaxAmountFormatted" : "$ 0.00",
   "shippingWithTaxAmountValue" : 0.0,
   "subtotalAmount" : 0.0,
   "subtotalDiscountAmount" : 0,
   "subtotalDiscountAmountFormatted" : "$ 0.00",
   "subtotalDiscountPercentageLevel1" : 0,
   "subtotalDiscountPercentageLevel1WithTaxAmount" : 0,
   "subtotalDiscountPercentageLevel2" : 0,
   "subtotalDiscountPercentageLevel2WithTaxAmount" : 0,
   "subtotalDiscountPercentageLevel3" : 0,
   "subtotalDiscountPercentageLevel3WithTaxAmount" : 0,
   "subtotalDiscountPercentageLevel4" : 0,
   "subtotalDiscountPercentageLevel4WithTaxAmount" : 0,
   "subtotalDiscountWithTaxAmount" : 0,
   "subtotalDiscountWithTaxAmountFormatted" : "$ 0.00",
   "subtotalFormatted" : "$ 0.00",
   "subtotalWithTaxAmountFormatted" : "$ 0.00",
   "subtotalWithTaxAmountValue" : 0.0,
   "taxAmount" : 0,
   "taxAmountFormatted" : "$ 0.00",
   "taxAmountValue" : 0.0,
   "totalAmount" : 0.0,
   "totalDiscountAmount" : 0,
   "totalDiscountAmountFormatted" : "$ 0.00",
   "totalDiscountPercentageLevel1" : 0,
   "totalDiscountPercentageLevel2" : 0,
   "totalDiscountPercentageLevel3" : 0,
   "totalDiscountPercentageLevel4" : 0,
   "totalDiscountWithTaxAmount" : 0,
   "totalDiscountWithTaxAmountFormatted" : "$ 0.00",
   "totalFormatted" : "$ 0.00",
   "totalWithTaxAmountFormatted" : "$ 0.00",
   "totalWithTaxAmountValue" : 0.0,
   "transactionId" : "",
   "workflowStatusInfo" : {
      "code" : 0,
      "label" : "approved",
      "label_i18n" : "承認済み"
   }
}

  4. グローバルメニュー (Applications Menu icon) → コマース → 注文 に移動します。 新たな秩序が現れる。

    新規注文が追加されたことを確認してください。

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

    javac -classpath .:* *.java

  6. Orders_POST_ToChannel クラスを実行し、 accountId、 channelId、および currentnyCode を適切な値に置き換えます。

    java -classpath .:* -DaccountId=1234 -DchannelId=5678 -DcurrencyCode=Foo Orders_POST_ToChannel

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

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

curl \
	"http://localhost:8080/o/headless-commerce-admin-order/v1.0/orders" \
	--data-raw '
		{
			"accountId": "'"${1}"'"、
			"channelId": "'"${2}"'"、
			"currencyCode": "'"${3}"'"
		}' \
	--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/orders"RESTサービスのエンドポイントを指定します。
-d "{\"accountId\": ${1}, \"channelId\": ${2}, \"currencyCode\": \"${3}\"}"投稿するデータを入力します。
-u "test@liferay.com:learn"基本認証の認証情報を入力します。
注記

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

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

Javaクラスを調べます

Orders_POST_ToChannel.java クラスは、 OrderResource サービスを呼び出すことで注文を追加します。

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

	OrderResource orderResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		orderResource.postOrder(
			new Order() {
				{
					accountId = Long.valueOf(
						System.getProperty("accountId"));
					channelId = Long.valueOf(
						System.getProperty("channelId"));
					currencyCode = String.valueOf(
						System.getProperty("currencyCode"));
				}
			}));
}

このクラスは、わずか3行のコードでRESTサービスを呼び出します。

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

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

注記

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

他の例のJavaクラスは、異なる OrderResource メソッドを呼び出します。

重要

サービスの詳細については、 OrderResource を参照してください。

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

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

cURLまたはJavaコマンドを使用すると、Liferayインスタンス内のすべての注文を一覧表示できます。

Orders_GET_FromInstance.sh

コマンド：

./Orders_GET_FromInstance.sh

コード：

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

Orders_GET_FromInstance.java

コマンド：

java -classpath .:* Orders_GET_FromInstance

コード：

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

	OrderResource orderResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		orderResource.getOrdersPage(null, null, Pagination.of(1, 2), null));
}

インスタンスの Order オブジェクトは JSON でリストされます。

フィルタリング、ページネーション、検索、および並べ替えの手順

このAPIによって返される注文は、フィルタリング、ページ分割、検索、およびソートが可能です。 詳細については、 getOrdersPage メソッドを参照してください。 結果をフィルタリング、検索、および並べ替えるには、次の 順序 フィールドを使用します。

  • アカウントID
  • チャネルID
  • 注文状況
  • 注文ID
  • 作成日
  • 変更日
  • 注文日
フィルタークエリ説明
orderIdが45958と等しい注文IDは45958と同じでなければなりません。
createDate gt 2022-12-31T12:00:00Z注文作成日は2022年12月31日12:00:00より後である必要があります。
orderStatus/any(x:(x eq 10) or (x eq 1))注文ステータスは、処理中（10）または保留中（1）のいずれかでなければなりません。 anyは、後続の式の少なくとも1つがtrueを返さなければならないことを指定します。
accountId/any(x:(x eq 44170) or (x eq 44178))アカウントIDは、44170または44178と同じである必要があります。 anyは、後続の式の少なくとも1つがtrueを返さなければならないことを指定します。

orderStatusでフィルタリングするには、関連付けられた整数値を使用する必要があります。 以下の表は、各注文ステータスを対応する整数値にマッピングしたものです。

注文ステータス整数値
公開2
処理中6
返答待ち1
処理中10
出荷済み15
完了0
キャンセル8
一部発送済み14
申請済み20
ソートクエリ説明
作成日:説明createDateで降順にソートしてください。
作成日:説明、更新日:説明最初にcreateDateで降順にソートし、次にmodifiedDateで降順にソートします。

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

注文する

cURLとJavaの get コマンドを使用して特定の順序を取得します。 1234 を注文の ID に置き換えてください。

ヒント

Orders_GET_FromInstance.[java|sh] を使用してすべての注文のリストを取得し、特定の注文の id をメモしてください。

Orders_GET_ById.sh

コマンド：

./Orders_GET_ById.sh 1234

コード：

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

Orders_GET_ById.java

コマンド：

java -classpath .:* -DorderId=1234 Orders_GET_ById

コード：

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

	OrderResource orderResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		orderResource.getOrder(
			Long.valueOf(System.getProperty("orderId"))));
}

注文 フィールドは JSON 形式でフォーマットされています。

注文を修正する

cURL と Java patch コマンドを使用して、既存の注文を更新します。 1234 を注文IDに置き換えてください。

Orders_PATCH_ById.sh

コマンド：

./Orders_PATCH_ById.sh 1234

コード：

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

Orders_PATCH_ById.java

コマンド：

java -classpath .:* -DorderId=1234 Orders_PATCH_ById

コード：

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

	OrderResource orderResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	orderResource.patchOrder(
		Long.valueOf(System.getProperty("orderId")),
		new Order() {
			{
				externalReferenceCode = "Able";
			}
		});
}

注文を削除する

cURLとJava delete コマンドを使用して既存の注文を削除します。 1234 を注文IDに置き換えてください。

Orders_DELETE_ById.sh

コマンド:

./Orders_DELETE_ById.sh 1234

コード：

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

Orders_DELETE_ById.java

コマンド

java -classpath .:* -DorderId=1234 Orders_DELETE_ById

コード:

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

	OrderResource orderResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	orderResource.deleteOrder(Long.valueOf(System.getProperty("orderId")));
}

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

注記

Liferay DXP 2024.Q4+/Portal GA129+ では、外部参照コードを使用して GET/PUT/PATCH/DELETE オーダーを実行できます。

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