Knowledge Base

Send Pick Event 

Sends a pick event to the server.

Identifier: send_pick_event

Elements

• pick_event: Contains the pick event type (e.g., CANCEL_PICK_GROUP).
  • Type: String
  • Default value: CONFIRM_PICK_ORDER
• connection_timeout: If no response is received from the server after a specified time (in seconds), the request is aborted.
  • Type: Long
  • Default value: 10
• server_communication: Sets the server communication to SYNCHRONOUS, ASYNCHRONOUS, or NONE.
  • Type: String
  • Default value: SYNCHRONOUS
• properties: Contains a list of properties that can be passed to the server with pick_event.
  • Type: Named list
  • Default value: Empty

Output

The event tag for this event is pick_event.

• OK: The pick event has been successfully sent to the server.
• NEW_ORDER: The server provides a new pick order with the response. It also sends the "OK" event.
• ERROR: There was an error while sending the pick event. If the server sends an error message, it will be found in the payload. The payload is structured as follows:
  • error
  • error.message
  • error.class
  • error.category
  • error.code
• TIMEOUT: The server did not respond within the specified time (connection_timeout).

Examples

Minimal

<pick_order_request id="send_pick_event" pick_event="CANCEL_PICK_GROUP" />

All options

<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

Sets the selected pick group in the pick order to the next one.

Identifier: next_pick_group

Elements

• mark_as_finished: Sets the status of the current pick group to finish, before going to the next one.
  • Type: Bool
  • Default value: False
• ignore_status: Sets the current pick group to the next one by ignoring the given status.
  • Type: String
  • Default Value: Empty

Output

The event tag for this event is next_pick_group.

• OK: The pick group has been successfully sent to the server.
• PICK_ORDER_FINISHED: The pick group was the last one of the pick order. Therefore, it is not possible to move on to the next one.
• ERROR: There was an error while going to the next pick group (e.g., there is no pick order).

Examples

Minimal

<next_pick_group id="go_to_next_step"/>

All options

<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

Sets the selected pick group in the pick order to the previous one.

Identifier: previous_pick_group

Output

The event tag for this event is previous_pick_group.

• OK: The pick event has been successfully sent to the server.
• START_OF_ORDER_REACHED: The pick group is the first one in the pick order. Therefore, it is not possible to move on to the previous group.
• ERROR: There was an error while going to the previous pick group (e.g., there is no pick order).

Example

<previous_pick_group id="go_to_previous_group"/>

Move Pick Group

Moves the selected pick group to a different position in the pick order. By default, it is moved to the end.

Identifier: move_pick_group

If you move a Pick Group to a position prior to the current one, it will remain active. Otherwise, the following Pick Group becomes active.

Elements

• position: Contains the position in the pick order to which the current pick group should be moved.
  • Type: Long
  • Default value: Empty

Output

The event tag of this event is move_pick_group.

• OK: The Pick Group has been successfully moved.
• Error: There was an error while moving the pick group (e.g., the designated new position/list item number is greater than the number of pick groups in the pick order).

Examples

Minimal

<move_pick_group id="move_step"/>

All options

<move_pick_group id="move_step">
    <param name="position" type="long">10</param> //moves PickGroup to position 10
</move_pick_group>

Cancel Pick Group

Cancels the current pick group and moves the next group in the list to the active one. If there is none, the pick order is finished.

Identifier: cancel_pick_group

Output

The event tag of this event is cancel_pick_group.

• OK: The current Pick Group has been successfully canceled and the new active group is the next one in the list.
• ORDER_FINISHED: The current pick group has been successfully completed and was the last one in the pick order.
• ERROR: There was an error while cancelling the pick group (e.g., there is no pick order that was requested before).

Example

<cancel_pick_group id="cancel" />

Cancel Pick Order

Cancels the current pick order and removes it from the client's device.

Identifier: cancel_pick_order

Output

The event tag of this event is cancel_pick_order.

• OK: The current pick order has been successfully cancelled.
• CAN_NOT_BE_CANCELED: The current pick order cannot be removed, because it has already been completed.
• ERROR: There was no pick order to be cancelled.

Example

<cancel_pick_order id="cancel" />