オーダーAPIの基本
アプリケーションメニューから、またはREST APIを使って注文を管理することができます。 headless-admin-commerce-order サービスを呼び出して、注文を作成・管理します。
注文を追加する
新しいLiferay DXPインスタンスを起動し、以下を実行します。
メールアドレス test@liferay.com とパスワード test を使用して、http://localhost:8080でLiferayにサインインしてください。 プロンプトが表示されたら、パスワードを learn に変更します。
Liferayの実行後、
-
注文APIの基本 をダウンロードし、解凍します。
-
注文の作成には、アカウントID、チャネルID、使用通貨の ISO 4217通貨コード (例:USD)の3つのパラメータが必要です。
アカウントIDを取得するには、 グローバルメニュー(
) を開き、 コントロールパネル → アカウント にアクセスします。 アカウントを探し、そのIDをコピーする。 または、アカウントを選択し、 アカウントID をコピーします。
チャンネル ID を取得するには、 Global Menu(
) を開き、 Commerce → Channels を選択します。 注文を追加するチャンネルを選択し、そのIDをコピーします。
1 cURL スクリプトを使用して、チャネルに新しい注文を追加します。 コマンドラインで、
curl
フォルダに移動します。Order_POST_ToChannel.sh
スクリプトを、アカウントID、チャンネルID、通貨コードに適切な値を指定して実行します。
JSONレスポンスは、そのアカウントとチャネルに新しい注文が追加されたことを示します。
1 Global Menu() → Commerce → Orders に移動します。 新しいオーダーが表示されます。
1 または、Javaクライアントを使用してRESTサービスを呼び出します。 java
フォルダに移動し、ソースファイルをコンパイルします。
1 Order_POST_ToChannel
クラスを実行し、 accountId
, channelId
, currenyCode
を適切な値に置き換えてください。
cURLコマンドの検証
Order_POST_ToChannel.sh
スクリプトは、cURL コマンドで REST サービスを呼び出します。
コマンドの引数は次のとおりです。
引数 | 説明 |
---|---|
-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" | 基本認証の認証情報を入力します。 |
ここでは、デモのために基本的な認証を使用しています。 本番環境では、 OAuth 2.0を使用する 経由でユーザーを認証する必要があります。 OAuth2を使ったReactアプリケーションのサンプルは、 OAuth2によるユーザーの認証 をご覧ください。
他のcURLコマンドも同様のJSON引数を使用します。
Javaクラスを調べる
Order_POST_ToChannel.java
クラスは、注文関連サービスを呼び出すことで注文を追加します。
このクラスは、次の3行のコードのみを使用してRESTサービスを呼び出します。
行(省略形) | 説明 |
---|---|
OrderResource.Builder builder = ... | OrderResource サービスインスタンスを生成するための Builder を取得する。 |
OrderResource orderResource = builder.authentication(...).build(); | 基本認証を使用し、 OrderResource サービスインスタンスを生成します。 |
orderResource.postOrder(...); | orderResource.postOrder メソッドを呼び出し、postにデータを渡します。 |
プロジェクトには、依存関係としてcom.liferay.headless.commerce.admin.order.client.jar
ファイルが含まれていることに注意してください。 すべての REST アプリケーションのクライアント JAR の依存情報は、インストール先の API Explorer で /o/api
(例: http://localhost:8080/o/api) に見つけることができます。
main
メソッドのコメントでは、クラスの実行を実演しています。
他の例のJavaクラスは、異なる OrderResource
メソッドを呼び出します。
サービスの詳細は OrderResource を参照ください。
以下は、cURL と Java を使用して、他の 注文
REST サービスを呼び出す例です。
インスタンスから注文を取得する
cURL または Java コマンドで、Liferay インスタンスからすべての注文をリストアップできます。
Orders_GET_FromInstance.sh
コマンド:
コード:
Orders_GET_FromInstance.java
コマンド:
コード:
インスタンスの 注文
オブジェクトがJSONでリストアップされます。
フィルタリング、ページ分割、検索、並び替えの順序を設定する。
このAPIから返される注文は、フィルタリング、ページ分割、検索、ソートすることができます。 詳しくは、 getOrdersPage
メソッドをご覧ください。 次の 順序
フィールドを使用して、結果をフィルタリング、検索、並べ替えします。
- アカウントID
- channelId
- 注文状況
- オーダーId
- createDate
- modifiedDate
- 注文日
フィルタークエリ | 説明 |
---|---|
orderId eq 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:desc | createDate で降順にソートしてください。 |
createDate:desc,modifiedDate:desc | 最初に createDate で降順にソートし、次に modifiedDate で降順にソートします。 |
詳しくは、 APIクエリパラメータ をご参照ください。
注文する
cURL と Java get
コマンドで特定のオーダーを取得します。 1234
を注文のIDに置き換えてください。
Orders_GET_FromInstance.[java|sh]
を使用して、すべてのオーダーのリストを取得し、特に必要なオーダーの id
をメモしてください。
Order_GET_ById.sh
コマンド:
コード:
Order_GET_ById.java
コマンド:
コード:
注文
フィールドはJSONでフォーマットされています。
注文のパッチ
cURL と Java パッチ
コマンドで既存の注文を更新します。 1234
をご注文のIDに置き換えてください。
Order_PATCH_ById.sh
コマンド:
コード:
Order_PATCH_ById.java
コマンド:
コード:
注文を削除する
cURL と Java delete
コマンドで既存の注文を削除します。 1234
をご注文のIDに置き換えてください。
Order_DELETE_ById.sh
コマンド:
コード:
Order_DELETE_ById.java
コマンド
コード:
RESTサービスの使用 は、 Order
のサービスとスキーマを表示し、各サービスをテストするためのインターフェイスを備えています。