OrderPickRequestEntity GitHub

πŸ“Š Overview: 1 Functions 6 Getters 3 Setters

Extends: Entity

πŸ• Last updated: 2026-01-13T16:04:12.209Z


πŸ“‘ Table of Contents


Functions

Regular Functions

getPickedStockListboxCollection

[πŸ–₯️ local]

Function getPickedStockListboxCollection -> Collection

Returns collection of picked stock items for listbox display; includes pallets and individual boxes with works order and quantities

Returns: Collection


Computed Attributes (Getters/Setters/Query/OrderBy)

Boxes

[πŸ” get, ✏️ set, πŸ–₯️ local]

Function get Boxes -> Real
Function set Boxes($Boxes : Real)

Returns number of boxes calculated by dividing parts by items per box from product; returns 0 if no items per box

Setter Parameter:

Name Type Description
$Boxes Real -

Returns: Real


BoxesPerPallet

[πŸ” get only, πŸ–₯️ local]

Function get BoxesPerPallet -> Integer

Returns boxes per pallet from customer or product’s pallet method; fallback to 0 if not defined

Returns: Integer


Pallets

[πŸ” get, ✏️ set, πŸ–₯️ local]

Function get Pallets -> Real
Function set Pallets($Pallets : Real)

Returns number of pallets calculated by dividing boxes by boxes per pallet; returns 0 if boxes per pallet is 0

Setter Parameter:

Name Type Description
$Pallets Real -

Returns: Real


Parts

[πŸ” get, ✏️ set, πŸ”Ž query, πŸ–₯️ local]

Function get Parts -> Integer
Function set Parts($Parts : Integer)
Function query Parts($QueryEventObject : Object)

Returns the quantity property (alias for inventory quantity in pick request)

Query Function: Enables querying this property in ORDA query strings (e.g., .query(":1"; $Value) where :1 is the property name).

Setter Parameter:

Name Type Description
$Parts Integer -

Query Parameter:

Name Type Description
$QueryEventObject Object -

Returns: Integer


QuantityPicked

[πŸ” get only, πŸ–₯️ local]

Function get QuantityPicked -> Integer

Returns total quantity already picked (boxes + pallets of boxes) from all BoxLabels and Pallet selections

Returns: Integer


QuantityToPick

[πŸ” get only, πŸ–₯️ local]

Function get QuantityToPick -> Integer

Returns remaining quantity to pick (total quantity minus quantity already picked)

Returns: Integer


πŸ—‚οΈ Tables

οΏ½ Forms


Generated from OrderPickRequestEntity.4dm


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