ピックイベントの送信
サーバーにピック・イベントを送信する。
識別子:send_pick_event
エレメント
- pick_event:ピック・イベントの種類(CANCEL_PICK_GROUPなど)。
- タイプ文字列
- デフォルト値confirm_pick_order。
- connection_timeout:指定した時間(秒)経過してもサーバーから応答がない場合、リクエストは中止される。
- プロパティ:
pick_eventで
サーバーに渡すことができるプロパティのリスト。 - server_communication:サーバ通信をSYNCHRONOUS、ASYNCHRONOUS、またはNONEに設定します。
出力
このイベントのイベントタグはpick_event
である。
- OK:ピックイベントが正常にサーバーに送信されました。
- NEW_ORDER:サーバーはレスポンスとともに新しいピックオーダーを提供する。また、"OK "イベントも送信する。
- ERROR:pickイベントの送信中にエラーが発生しました。サーバーがエラーメッセージを送信した場合、そのエラーメッセージはペイロードに記載されます。ペイロードは以下のような構造になっている:
- エラー
- エラーメッセージ
- エラークラス
- エラーカテゴリ
- エラーコード
- TIMEOUT:サーバーが指定された時間
(connection_timeout
)内に応答しなかった。
例
最小限
<pick_order_request id="send_pick_event" pick_event="CANCEL_PICK_GROUP" />
すべてのオプション
<send_pick_event id="send_pick_event" pick_event="CANCEL_PICK_GROUP" connection_timeout="20" server_communication="SYNCHRONOUS">
<list name="properties" listType="NAMED">
<param name="reason" type="string">DAMAGE</param>
</list>
</send_pick_event>
ネクスト・ピック・グループ
ピックオーダーで選択されているピックグループを次のピックグループに設定します。
識別子:next_pick_group
エレメント
- mark_as_finished:現在のピックグループのステータスを終了に設定し、次のピックグループに移動する。
- ignore_status:与えられたステータスを無視して、現在のピックグループを次のピックグループに設定する。
出力
このイベントのイベントタグはnext_pick_group
である。
- OK:ピックグループは正常にサーバーに送信されました。
- PICK_ORDER_FINISHED:ピックグループがピックオーダーの最後のものである。そのため、次のピックに進むことができない。
- ERROR:次のピック・グループに移動する際にエラーが発生しました(ピック・オーダーがないなど)。
例
最小限
<next_pick_group id="go_to_next_step"/>
すべてのオプション
<next_pick_group id="go_to_next_step" type="next_pick_group">
<param name="mark_as_finished" type="bool">true</param>
<param name="ignore_status" type="string">CANCELED</param>
</next_pick_group>
前回のピック・グループ
ピックオーダーで選択されているピックグループを前のグループに設定します。
識別子:previous_pick_group
出力
このイベントのイベント・タグはprevious_pick_group
である。
- OK:ピックイベントが正常にサーバーに送信されました。
- START_OF_ORDER_REACHED:ピックグループはピックオーダーの最初のグループです。そのため、前のグループに移動することはできない。
- ERROR:前のピックグループに移動する際にエラーが発生しました(ピックオーダーがないなど)。
例
<previous_pick_group id="go_to_previous_group"/>
ピックグループの移動
選択したピックグループをピックオーダー内の別の位置に移動します。デフォルトでは最後に移動します。
識別子:move_pick_group
注意:このアクションは、クライアントデバイス上でローカルにピックグループを移動させるだけです。サーバーには何も伝えられません。そのため、Send Pick Event アクションと組み合わせて使用してください。
ピックグループを現在の位置より前に移動した場合、そのピックグループはアクティブのままです。そうでない場合は、次のピックグループがアクティブになります。
エレメント
- 位置:現在のピックグループを移動させるピックオーダーの位置を指定します。
出力
このイベントのイベントタグはmove_pick_group
である。
- OKピックグループは正常に移動しました。
- エラー:ピックグループの移動中にエラーが発生しました(例:指定された新しい位置/リストアイテム番号が、ピックオーダーのピックグループ数より大きい)。
例
最小限
<move_pick_group id="move_step"/>
すべてのオプション
<move_pick_group id="move_step">
<param name="position" type="long">10</param> //moves PickGroup to position 10
</move_pick_group>
ピックグループのキャンセル
現在のピックグループをキャンセルし、リストの次のグループをアクティブにする。何もなければピックオーダーは終了。
識別子:cancel_pick_group
注意:このアクションは、クライアントデバイス上でローカルにキャンセルするピックグループを設定するだけです。サーバーには何も通知されません。サーバー側でキャンセルするには、Send Pick Eventアクションと組み合わせて使用してください。
出力
このイベントのイベントタグはcancel_pick_group
である。
- OK:現在のピックグループは正常にキャンセルされ、新しいアクティブグループがリストの次のグループになります。
- ORDER_FINISHED:現在のピック・グループが正常に完了し、ピック・オーダーの最後のグループとなった。
- ERROR:ピックグループのキャンセル中にエラーが発生しました。
例
<cancel_pick_group id="cancel" />
ピックオーダーのキャンセル
現在のピックオーダーをキャンセルし、クライアントのデバイスから削除します。
識別子:cancel_pick_order
注意:このアクションは、クライアントデバイスのローカルでピックグループをキャンセルします。サーバーには何も通知されません。サーバー上でピックオーダーをキャンセルするには、Send Pick Eventアクションと組み合わせて使用してください。
出力
このイベントのイベントタグはcancel_pick_order
である。
- OK:現在のピックオーダーは正常にキャンセルされました。
- CAN_NOT_BE_CANCELED:現在のピックオーダーは既に完了しているため、削除できない。
- ERROR: キャンセルするピックオーダーがありませんでした。
例
<cancel_pick_order id="cancel" />