FulfmtRoutgCriteria

Stores individual fulfillment criteria with their metadata, actions, and activation status within a fulfillment criteria group version. This object is available in API version 66.0 and later.

Supported Calls

delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete()

The create() and update() operations are restricted to internal Salesforce processes only. Users can't directly create or modify records through the API. To create or modify records, use the Fulfillment Routing Setup UI.

Note

Special Access Rules

The Salesforce org must have:

  • Order Management enabled
  • Delivery Estimation enabled
  • Delivery Routing Engine enabled
  • User must have UseFulfillmentRoutingAPIs user permission. This permission is included in the Order Management Operations Manager permission set.

Fields

Field Details
ActionExpression
Type
string
Properties
Filter, Group, Nillable, Sort
Description
For internal use only.
ConditionExpression
Type
string
Properties
Filter, Group, Nillable, Sort
Description
A logical expression that combines rule conditions by using identifiers. Defines the logical relationship between conditions.
CanOverrideSplits
Type
boolean
Properties
Filter, Group, Nillable, Sort
Description
Indicates whether the routing criteria can override the max splits allowed restriction (true) or not (false). Default value is false.
This field is available from API version 67.0 and later.
Description
Type
string
Properties
Filter, Group, Nillable, Sort
Description
An optional description of the rule.
EndDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
An optional end date for the rule. NULL means no end date restriction.
FulfmtRoutgCriteriaGrpVerId
Type
reference
Properties
Filter, Group, Sort
Description
A foreign key reference to the rule group version that this rule belongs to. Links the rule to its parent group version.
This field is a relationship field.
Relationship Name
FulfmtRoutgCriteriaGrpVer
Relationship Type
Master-detail
Refers To
FulfmtRoutgCriteriaGrpVer (the master object)
FulfmtRoutgCriteriaType
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Determines the criteria type of the rule.
Possible values are:
  • Fulfillment
FulfmtRoutgCriteriaUsageType
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Determines the criteria usage type of the rule.
Possible values are:
  • Filter
  • Weight
IsActive
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the rule is active and included in DRL generation and execution (true) or not (false). Inactive rules are excluded from rule processing.
The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate), but not viewed it.
Name
Type
string
Properties
Filter, Group, idLookup, Sort
Description
The name of the criteria. Must be unique within the organization.
RefFulfmtRoutgCriteria
Type
reference
Properties
Filter, Group, Sort
Description
A foreign key that points to the parent rule version. NULL for the first version of a rule.
This field is a relationship field.
Relationship Name
FulfmtRoutgCriteria
Relationship Type
Master-detail
Refers To
FulfmtRoutgCriteria (the master object)
ScoringType
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Determines how scores are calculated for custom weighted rules. Null for template weighted rules.
This field is available in API version 67.0 and later.
Possible values are:
  • InverseLinearRangeBased
  • LinearRangeBased
  • Static
ScoringTypeMetadata
Type
string
Properties
Filter, Nillable, Sort
Description
The metadata for scoring configuration stored as JSON for custom weighted rules. Null for template weighted rules.
This field is available in API version 67.0 and later.
StartDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
An optional start date for the rule. NULL means no start date restriction.
TemplateName
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Determines the template name for the rule.
Possible values are:
  • InventoryMatchFilter—Inventory Availability
  • MarkdownAvoidanceRule—Markdown Inventory
  • OverstockScoreRule—Overstocked Inventory
  • ProximityScoreRule—Nearest Location
Type
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Determines how the rule operates and what actions it can perform.
Possible values are:
  • Filter
  • Weight
Weight
Type
double
Properties
Filter, Nillable, Sort
Description
The numeric value that determines the relative importance of this rule in scoring calculations. NULL for filter rules.