Location 
📊 Overview: 4 Functions
Extends: DataClass
🕐 Last updated: 2025-12-10T11:45:23.180Z
📑 Table of Contents
- ⚙️ Functions
- Regular Functions
- getUsingScanner (1 param) →
cs.LocationEntity - newLocation (1 param) →
$LocationEntity : cs.LocationEntity🖥️ - restClearStockLocation (1 param) →
Object - restSetStockLocation (1 param) →
Object
- getUsingScanner (1 param) →
- Regular Functions
- 🔗 Related Items
Functions
Regular Functions
getUsingScanner
Function getUsingScanner($ScannerObject : Object) -> cs.LocationEntity
Returns LocationEntity from scanner object if it contains a valid location barcode, otherwise Null
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$ScannerObject | Object | - | - |
Returns: cs.LocationEntity
newLocation
[🖥️ local]
Function newLocation($ParentLocationEntity : cs.LocationEntity) -> $LocationEntity : cs.LocationEntity
Creates a new location with user-entered name, optionally under a parent location
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$ParentLocationEntity | cs.LocationEntity | - | - |
Returns: cs.LocationEntity
restClearStockLocation
Function restClearStockLocation($RestPostDataObject : Object) -> Object
REST endpoint to clear location assignment from a pallet or material stock record
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
restSetStockLocation
Function restSetStockLocation($RestPostDataObject : Object) -> Object
REST endpoint to assign a location to a pallet or material stock record using scanner or manual selection
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
$RestPostDataObject | Object | - | - |
Returns: Object
Related Items
🗂️ Tables
- Location - ORDA DataClass class for Location table
� Related Classes
- LocationEntity - ORDA Entity class for Location table
� Forms
- LocationManager - Data source for LocationManager form
Generated from Location.4dm