Pallet 
📊 Overview: 15 Functions
Extends: DataClass
🕐 Last updated: 2026-01-13T16:04:12.342Z
📑 Table of Contents
- ⚙️ Functions
- Regular Functions
- getMigrationSettings →
Object🖥️ - getAvailableToPick (1 param) →
cs.PalletSelection🖥️ - getUsingScanner (2 params) →
cs.PalletEntity - Create (2 params) →
$ResultObject : Object - Verify (3 params) →
$ResultObject : Object - Print (2 params) →
$ResultObject : Object - Delete (1 param) →
$ResultObject : Object - restLoadPalletList (1 param) →
Object - restAddToPallet (1 param) →
Object - restCompletePallet (1 param) →
Object - restVerifyPallet (1 param) →
Object - restLocatePallet (1 param) →
Object - restDeletePallet (1 param) →
Object - restReassignLocation (1 param) →
Object - restLoadPallet (1 param) →
Object
- getMigrationSettings →
- Regular Functions
- 🔗 Related Items
Functions
Regular Functions
getMigrationSettings
[🖥️ local]
Function getMigrationSettings -> Object
Returns migration settings for Pallet dataclass: disables linking and preserves ID during entity sync
Returns: Object
getAvailableToPick
[🖥️ local]
Function getAvailableToPick($ProductEntity : cs.ProductEntity) -> cs.PalletSelection
Returns pallets of specified product available for picking: verified, in despatch location, not yet assigned to pick request
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$ProductEntity | cs.ProductEntity | - | - |
Returns: cs.PalletSelection
getUsingScanner
Function getUsingScanner($ScannerObject : Object; $ScannerText : Text) -> cs.PalletEntity
Retrieves pallet entity from scanner input: either ScannerObject with PalletID or parsed barcode text (extracts ID from characters 10+)
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$ScannerObject | Object | - | - |
$ScannerText | Text | - | - |
Returns: cs.PalletEntity
Create
Function Create($BoxLabelIDCollection : Collection; $StaffID : Integer) -> $ResultObject : Object
REST endpoint to create new pallet from collection of box label IDs; validates box compatibility, locks entities, and returns result object with success/error info
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$BoxLabelIDCollection | Collection | - | - |
$StaffID | Integer | - | - |
Returns: Object
Verify
Function Verify($PalletID : Integer; $BoxLabelID : Integer; $StaffID : Integer) -> $ResultObject : Object
REST endpoint to verify (QA check) pallet contents; locks pallet and boxes, validates integrity, and marks as verified
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$PalletID | Integer | - | - |
$BoxLabelID | Integer | - | - |
$StaffID | Integer | - | - |
Returns: Object
Function Print($PalletID : Integer; $Printer : Text) -> $ResultObject : Object
REST endpoint to print pallet label; creates print job for warehouse label printer
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$PalletID | Integer | - | - |
$Printer | Text | - | - |
Returns: Object
Delete
Function Delete($PalletID : Integer) -> $ResultObject : Object
REST endpoint to delete pallet; removes pallet and unlinks associated boxes
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$PalletID | Integer | - | - |
Returns: Object
restLoadPalletList
Function restLoadPalletList($RestPostDataObject : Object) -> Object
REST endpoint for mobile warehouse app; returns scrollable view of all pallets with details, status, and action buttons
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
restAddToPallet
Function restAddToPallet($RestPostDataObject : Object) -> Object
REST endpoint for mobile pallet creation; displays UI to select and add boxes to new pallet with product matching validation
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
restCompletePallet
Function restCompletePallet($RestPostDataObject : Object) -> Object
REST endpoint to finalize pallet; marks pallet as complete and ready for verification/despatch
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
restVerifyPallet
Function restVerifyPallet($RestPostDataObject : Object) -> Object
REST endpoint for QA verification; displays pallet contents and allows staff to verify/confirm boxes match pallet manifest
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
restLocatePallet
Function restLocatePallet($RestPostDataObject : Object) -> Object
REST endpoint for locating pallet in warehouse; scans pallet barcode and displays location/contents information
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
restDeletePallet
Function restDeletePallet($RestPostDataObject : Object) -> Object
REST endpoint to delete pallet from warehouse system; removes pallet record and unlinks all boxes
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
restReassignLocation
Function restReassignLocation($RestPostDataObject : Object) -> Object
REST endpoint to change pallet location; allows reassigning pallets to different warehouse locations
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
restLoadPallet
Function restLoadPallet($RestPostDataObject : Object) -> Object
REST endpoint for mobile pallet details view; displays pallet contents, boxes, status, and available actions (verify, print, delete, relocate)
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
Related Items
🗂️ Tables
- Pallet - ORDA DataClass class for Pallet table
� Related Classes
- PalletEntity - ORDA Entity class for Pallet table
- PalletSelection - ORDA EntitySelection class for Pallet table
� Forms
- %2AMigration - Data source for %2AMigration form
- %2Atest - Data source for %2Atest form
- CancelAdviceNote - Data source for CancelAdviceNote form
- LocationManager - Data source for LocationManager form
- NSKPalletIDs - Data source for NSKPalletIDs form
- OrderDelivery - Data source for OrderDelivery form
- PalletDespatchList - Data source for PalletDespatchList form
- PalletTransfer - Data source for PalletTransfer form
- Warehouse - Data source for Warehouse form
Generated from Pallet.4dm