BoxLabels

📊 Overview: 7 Functions

Extends: DataClass

🕐 Last updated: 2025-12-10T11:45:22.321Z

---

📑 Table of Contents

• ⚙️ Functions
  • Regular Functions
    • getMigrationSettings → Object 🖥️
    • getAvailableToPick (1 param) → cs.BoxLabelsSelection 🖥️
    • checkPalletQuantity (2 params)
    • getUsingScanner (1 param) → $BoxLabelsEntity : cs.BoxLabelsEntity
    • getByUUID (1 param) → cs.BoxLabelsEntity
    • GetBoxQuantity (1 param) → $BoxQuantity : Integer
    • restScannedBoxLabel (1 param) → Object
• 🔗 Related Items

---

Functions

Regular Functions

getMigrationSettings

[🖥️ local]

Function getMigrationSettings -> Object

Returns configuration settings for entity migration including custom property formulas for ID and UUID

Returns: Object

---

getAvailableToPick

[🖥️ local]

Function getAvailableToPick($ProductEntity : cs.ProductEntity) -> cs.BoxLabelsSelection

Returns boxes available for picking: in stock (v2+), not on pallet, not already pick-requested, matching product

Parameters:

Name	Type	Optional	Description
$ProductEntity	cs.ProductEntity	-	-

Returns: cs.BoxLabelsSelection

---

checkPalletQuantity

Function checkPalletQuantity($WorksOrderEntity : cs.WorksOrderEntity; $RouteCardNumber : Integer)

Validates that parts packed on a route card do not exceed the configured pallet quantity, sends email alert if exceeded

Parameters:

Name	Type	Optional	Description
$WorksOrderEntity	cs.WorksOrderEntity	-	-
$RouteCardNumber	Integer	-	-

---

getUsingScanner

Function getUsingScanner($ScannerObject : Object) -> $BoxLabelsEntity : cs.BoxLabelsEntity

Retrieves a box label entity using scanner data (UUID or BoxLabelID), validates works order matches

Parameters:

Name	Type	Optional	Description
$ScannerObject	Object	-	-

Returns: cs.BoxLabelsEntity

---

getByUUID

Function getByUUID($UUID : Text) -> cs.BoxLabelsEntity

Finds and returns a box label entity by its UUID, returns Null if UUID is empty or not found

Parameters:

Name	Type	Optional	Description
$UUID	Text	-	-

Returns: cs.BoxLabelsEntity

---

GetBoxQuantity

Function GetBoxQuantity($BoxLabelID : Integer) -> $BoxQuantity : Integer

REST API endpoint: Returns the total quantity of parts in the specified box label

Parameters:

Name	Type	Optional	Description
$BoxLabelID	Integer	-	-

Returns: Integer

---

restScannedBoxLabel

Function restScannedBoxLabel($RestPostDataObject : Object) -> Object

REST API endpoint: Processes scanned box label data and returns warehouse view data for mobile app

Parameters:

Name	Type	Optional	Description
$RestPostDataObject	Object	-	-

Returns: Object

---

Related Items

🗂️ Tables

• BoxLabels - ORDA DataClass class for BoxLabels table

� Related Classes

• BoxLabelsEntity - ORDA Entity class for BoxLabels table

� Forms

• %2Atest - Data source for %2Atest form
• %2Atest1 - Data source for %2Atest1 form
• CancelAdviceNote - Data source for CancelAdviceNote form
• LabelPrinting - Data source for LabelPrinting form
• NSKPalletIDs - Data source for NSKPalletIDs form
• PalletDespatchList - Data source for PalletDespatchList form
• Warehouse - Data source for Warehouse form

---

Generated from BoxLabels.4dm