PickRequest GitHub

📊 Overview: 11 Functions

Extends: DataClass

🕐 Last updated: 2026-01-13T16:04:12.505Z


📑 Table of Contents


Functions

Regular Functions

create

[🖥️ local]

Function create -> $PickRequestEntity : cs.PickRequestEntity

Opens modify dialog for new pick request; returns created entity if saved, null if cancelled

Returns: cs.PickRequestEntity


newUsingEntry

[🖥️ local]

Function newUsingEntry -> $PickRequestEntity : cs.PickRequestEntity

Opens UI entry dialog to create new pick request with customer and despatch date; returns created entity if saved, null if cancelled

Returns: cs.PickRequestEntity


getOpenRequests

[🖥️ local]

Function getOpenRequests -> cs.PickRequestSelection

Returns all pick requests; used to filter ready-to-pick requests in REST API

Returns: cs.PickRequestSelection


restInitialPage

Function restInitialPage($RestPostDataObject : Object) -> Object

REST endpoint for mobile warehouse app; returns view with list of open pick requests ready to pick, styled as clickable buttons

Parameters:

Name Type Optional Description
$RestPostDataObject Object - -

Returns: Object


restPickPage

Function restPickPage($RestPostDataObject : Object) -> Object

REST endpoint showing specific pick request with orders to pick; displays UI for stock picking with box quantity input and order details

Parameters:

Name Type Optional Description
$RestPostDataObject Object - -

Returns: Object


restUnpickStock

Function restUnpickStock($RestPostDataObject : Object) -> Object

REST endpoint to reverse picked stock; returns confirmation view after unpicking boxes from pick request

Parameters:

Name Type Optional Description
$RestPostDataObject Object - -

Returns: Object


restViewStock

Function restViewStock($RestPostDataObject : Object) -> Object

REST endpoint showing current stock availability for orders in pick request; displays works order details with available/finished stock and bin locations

Parameters:

Name Type Optional Description
$RestPostDataObject Object - -

Returns: Object


restScanStock

Function restScanStock($RestPostDataObject : Object) -> Object

REST endpoint for mobile barcode scanning; accepts box/pallet scans and updates picked quantities in pick request; returns updated view with scan results

Parameters:

Name Type Optional Description
$RestPostDataObject Object - -

Returns: Object


restSelectOrderToPickAgainst

Function restSelectOrderToPickAgainst($RestPostDataObject : Object) -> Object

REST endpoint showing available customer orders that can be added to pick request; returns filtered list of non-completed orders for selection

Parameters:

Name Type Optional Description
$RestPostDataObject Object - -

Returns: Object


restPickAgainstOrder

Function restPickAgainstOrder($RestPostDataObject : Object) -> Object

REST endpoint to add selected customer order to pick request; links order’s stock to pick request and returns updated picking view

Parameters:

Name Type Optional Description
$RestPostDataObject Object - -

Returns: Object


checkForPickedPickRequests

Function checkForPickedPickRequests

Monitors for pick requests that have finished picking and automatically triggers despatch workflow and notifications


🗂️ Tables

  • PickRequest - ORDA DataClass class for PickRequest table

� Forms


Generated from PickRequest.4dm


This site uses Just the Docs, a documentation theme for Jekyll.