Shipment consolidation policies in Main(WHSShipConsolidationPolicy)

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	WHSShipConsolidationPolicy/(resolvedAttributes)/RecId	attribute

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.1"	string	semantic version number of the entity

is.application.releaseVersion

Parameter	Value	Data type	Explanation
releaseVersion	"10.0.13.0"	string	semantic version number of the application introducing this entity

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Shipment consolidation policies	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Main/WHSShipConsolidationPolicy
ShipConsolidationPolicyName		Main/WHSShipConsolidationPolicy
ShipConsolidationPolicyType		Main/WHSShipConsolidationPolicy
ShipConsolidationPolicySeqNum		Main/WHSShipConsolidationPolicy
ShipConsolidationPolicyQuery		Main/WHSShipConsolidationPolicy
ShipConsolidationPolicyDesc		Main/WHSShipConsolidationPolicy
Valid		Main/WHSShipConsolidationPolicy
ConsolidateWithExistingShipments		Main/WHSShipConsolidationPolicy
DataAreaId		Main/WHSShipConsolidationPolicy
Relationship_CompanyRelationshipId		Main/WHSShipConsolidationPolicy

RecId

First included in: Main/WHSShipConsolidationPolicy (this entity)

Properties

Name	Value
isPrimaryKey	true
dataFormat	int64
isReadOnly	true

Traits

List of traits for the RecId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	WHSShipConsolidationPolicy/(resolvedAttributes)/RecId	attribute

is.readOnly
is.dataFormat.integer
is.dataFormat.big

ShipConsolidationPolicyName

First included in: Main/WHSShipConsolidationPolicy (this entity)

Properties

Name	Value
displayName	Policy name
dataFormat	string

Traits

List of traits for the ShipConsolidationPolicyName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Policy name	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

ShipConsolidationPolicyType

First included in: Main/WHSShipConsolidationPolicy (this entity)

Properties

Name	Value
dataFormat	int32

Traits

List of traits for the ShipConsolidationPolicyType attribute are listed below.

is.dataFormat.integer
is.dataFormat.integer

ShipConsolidationPolicySeqNum

First included in: Main/WHSShipConsolidationPolicy (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the ShipConsolidationPolicySeqNum attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

ShipConsolidationPolicyQuery

First included in: Main/WHSShipConsolidationPolicy (this entity)

Properties

Name	Value
dataFormat	binary
isNullable	true

Traits

List of traits for the ShipConsolidationPolicyQuery attribute are listed below.

is.dataFormat.byte
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.byte
is.dataFormat.array

ShipConsolidationPolicyDesc

First included in: Main/WHSShipConsolidationPolicy (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the ShipConsolidationPolicyDesc attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

Valid

First included in: Main/WHSShipConsolidationPolicy (this entity)

Properties

Name	Value
dataFormat	int32
isReadOnly	true
isNullable	true

Traits

List of traits for the Valid attribute are listed below.

is.dataFormat.integer
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

ConsolidateWithExistingShipments

First included in: Main/WHSShipConsolidationPolicy (this entity)

Properties

Name	Value
displayName	Consolidate with open shipments
dataFormat	int32
isNullable	true

Traits

List of traits for the ConsolidateWithExistingShipments attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Consolidate with open shipments	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

DataAreaId

First included in: Main/WHSShipConsolidationPolicy (this entity)

Properties

Name	Value
dataFormat	string
isReadOnly	true

Traits

List of traits for the DataAreaId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.readOnly
is.dataFormat.character
is.dataFormat.array

Relationship_CompanyRelationshipId

First included in: Main/WHSShipConsolidationPolicy (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_CompanyRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/Finance/Ledger/Main/CompanyInfo.cdm.json/CompanyInfo RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array