Logistics.Common.LogisticUnits Entity

Namespace: Logistics.Common

Composition of products established for transport and/or storage which needs to be managed through the supply chain. Entity: Log_Logistic_Units (Introduced in version 21.1.0.77)

Renames

Old name: Logistics.LogisticUnits
New name: Logistics.Common.LogisticUnits
Version: 25.1.0.64
Case: 37169

Default Visualization

Default Display Text Format:
{SerialCode}
Default Search Members:
SerialCode
Code Data Member:
SerialCode
Category: Definitions
Show in UI: ShownByDefault
Layout category attribute: LogisticUnitTypeId

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

Logistics.Common.LogisticUnits
- Logistics.Common.LogisticUnitContents
- Logistics.Common.LogisticUnitSpecifications

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
ExpectedWeight	decimal (12, 3) nullable	Expected weight in KG. Used for planning purposes. null means unknown. `Filter(eq;ge;le)`
Id	guid
IsActive	boolean	Indicates whether the logistic unit is currently active. `Required` `Default(true)` `Filter(eq)` `Introduced in version 23.1.2.11`
MeasuredWeight	decimal (12, 3) nullable	Actual measured weight of the unit in KG. null means unknown. `Filter(eq;ge;le)`
Notes	string (max) nullable	Notes for this LogisticUnit. `Filter(like)`
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
SerialCode	string (32)	Unique serial code of the logistic unit. If GS1 coding is used, this is the SSCC. `Required` `Filter(multi eq;like)` `ORD`

References

Name	Type	Description
CargoType	CargoTypes (nullable)	General type of the cargo of the logistic unit. null means unknown or N/A. `Filter(multi eq)`
LogisticUnitType	LogisticUnitTypes (nullable)	The type of the logistic unit. null means the type is currently unknown. `Filter(multi eq)`
RepresentedAsProduct	Products (nullable)	When the logistic unit is also a tradeable item, specifies the product used to trade the unit. The product should uniquely identify only one logistic unit. Note that this is different from a logistic unit containing a single item. null means that the unit is not a tradeable item. `Filter(multi eq)`

Child Collections

Name	Type	Description
Contents	LogisticUnitContents	List of `LogisticUnitContent`(Logistics.Common.LogisticUnitContents.md) child objects, based on the `Logistics.Common.LogisticUnitContent.LogisticUnit`(Logistics.Common.LogisticUnitContents.md#logisticunit) back reference
Specifications	LogisticUnitSpecifications	List of `LogisticUnitSpecification<br />`(Logistics.Common.LogisticUnitSpecifications.md) child objects, based on the `Logistics.Common.LogisticUnitSpecification.LogisticUnit`(Logistics.Common.LogisticUnitSpecifications.md#logisticunit) back reference

Attribute Details

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

ExpectedWeight

Expected weight in KG. Used for planning purposes. null means unknown. Filter(eq;ge;le)

Type: decimal (12, 3) nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

IsActive

Indicates whether the logistic unit is currently active. Required Default(true) Filter(eq) Introduced in version 23.1.2.11

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

MeasuredWeight

Actual measured weight of the unit in KG. null means unknown. Filter(eq;ge;le)

Type: decimal (12, 3) nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Notes

Notes for this LogisticUnit. Filter(like)

Type: string (max) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

SerialCode

Unique serial code of the logistic unit. If GS1 coding is used, this is the SSCC. Required Filter(multi eq;like) ORD

Type: string (32)
Indexed: True
Category: System
Supported Filters: Equals, Like, EqualsIn
Supports Order By: True
Maximum Length: 32
Show in UI: ShownByDefault

Reference Details

CargoType

General type of the cargo of the logistic unit. null means unknown or N/A. Filter(multi eq)

Type: CargoTypes (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

LogisticUnitType

The type of the logistic unit. null means the type is currently unknown. Filter(multi eq)

Type: LogisticUnitTypes (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

RepresentedAsProduct

When the logistic unit is also a tradeable item, specifies the product used to trade the unit. The product should uniquely identify only one logistic unit. Note that this is different from a logistic unit containing a single item. null means that the unit is not a tradeable item. Filter(multi eq)

Type: Products (nullable)
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

UpdateGS1ApplicationCodes

Based on the internal data in the logistic unit and its contents, creates or updates the GS1 application codes. The data is than stored in the logistic unit specifications. The method does not commit the object transaction.
Return Type: void
Declaring Type: LogisticUnits
Domain API Request: POST

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST