Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
commonserviceexcellence Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
ActionLinks Class
Announcements Class
BotVersionActivation Class
CdpActivation Class
CdpActivationExternalPlatform Class
CdpActivationTarget Class
CdpAudienceDMO Class
CdpCalculatedInsight Class
CdpConnection Class
CdpDataSpace Class
CdpDataStreams Class
CdpIdentityResolution Class
CdpMachineLearning Class
CdpQuery Class
CdpSegment Class
Chatter Class
ChatterFavorites Class
ChatterFeeds Class
ChatterGroups Class
ChatterMessages Class
ChatterUsers Class
Clm Class
CommerceBuyerExperience Class
CommerceCart Class
CommerceCatalog Class
CommerceCatalogManagement Class
CommercePromotions Class
CommerceQuotes Class
CommerceSearch Class
CommerceSearchConnectFamily Class
CommerceSearchSettings Class
CommerceStorePricing Class
CommerceWishlist Class
Communities Class
CommunityModeration Class
ContentHub Class
ConversationApplicationDefinition Class
Datacloud Class
EinsteinLLM Class
EmailMergeFieldService Class
EmployeeProfiles Class
Exchanges Class
ExtendedCommerceDelivery Class
ExternalEmailServices Class
ExternalManagedAccount Class
FieldService Class
FlowApprovalProcesses Class
FulfillmentOrder Class
IBusinessObjectivesAndRecsFamily Class
Knowledge Class
LightningScheduler Class
ManagedContent Class
ManagedContentChannels Class
ManagedContentDelivery Class
ManagedContentSpaces Class
ManagedTopics Class
MarketingIntegration Class
Mentions Class
Missions Class
NamedCredentials Class
NavigationMenu Class
NextBestAction Class
OmnichannelInventoryService Class
OMSAnalytics Class
OptimizationFiles Class
Orchestration Class
OrderPaymentSummary Class
OrderSummary Class
OrderSummaryCreation Class
Organization Class
PardotBusinessUnitContext Class
Payments Class
Personalization Class
PickTicket Class
QuestionAndAnswers Class
Recommendations Class
RecordFilterCriteriaFamily Class
Records Class
RecordUi Class
RegisterGuestBuyer Class
Repricing Class
ReturnOrder Class
Routing Class
Routing Methods
SalesforceInbox Class
Search Class
Sites Class
SmartDataDiscovery Class
SocialEngagement Class
Surveys Class
TaxPlatform Class
Topics Class
UserProfiles Class
Zones Class
ConnectApi Input Classes
ConnectApi Output Classes
ConnectApi Enums
ConnectApi Exceptions
ConnectApi Utilities
ConnectApi Release Notes
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
disputemanagement Namespace
fsccashflow Namespace
fsccomplaintmanagement Namespace
fschousehold Namespace
fscserviceprocesses Namespace
fscwmgen Namespace
industriespersonalizedfinance Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
sfdw Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Routing Class

Route orders to inventory locations in Order Management.

Namespace

ConnectApi

Routing Methods

These methods are for Routing. All methods are static.

confirmHeldFOCapacity(confirmHeldFOCapacityInput)

Confirm held fulfillment order capacity at one or more locations. This call decreases a location’s held capacity and increases its assigned fulfillment order count. Confirm held capacity when you assign a fulfillment order to a location.

API Version

55.0

Requires Chatter

No

Signature

public static ConnectApi.ConfirmHeldFOCapacityOutputRepresentation confirmHeldFOCapacity(ConnectApi.ConfirmHeldFOCapacityInputRepresentation confirmHeldFOCapacityInput)

Parameters

confirmHeldFOCapacityInput
Type: ConnectApi.ConfirmHeldFOCapacityInputRepresentation
The input includes, for each fulfillment order, the location where capacity is held for it.

Return Value

Type: ConnectApi.ConfirmHeldFOCapacityOutputRepresentation

findRoutesWithFewestSplits(findRoutesWithFewestSplitsInputRepresentation)

Returns combinations of inventory locations that can fulfill an order within a specified limit of shipment splits. By default, checks up to 1,000,000 potential routes, returning a maximum of 10,000 results.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.FindRoutesWithFewestSplitsOutputRepresentation findRoutesWithFewestSplits(ConnectApi.FindRoutesWithFewestSplitsInputRepresentation findRoutesWithFewestSplitsInputRepresentation)

Parameters

findRoutesWithFewestSplitsInputRepresentation
Type: ConnectApi.FindRoutesWithFewestSplitsInputRepresentation
The input includes the ordered item quantities, data about available inventory, and, optionally, a maximum allowable number of shipment splits.

Return Value

Type: ConnectApi.FindRoutesWithFewestSplitsOutputRepresentation

findRoutesWithFewestSplitsUsingOCI(findRoutesWithFewestSplitsUsingOCIInput)

For one or more order summaries, find inventory availability using Omnichannel Inventory and identify the fulfillment routes with fewest splits. By default, checks up to 1,000,000 potential routes, returning a maximum of 10,000 results. This method combines the functionality of the getInventoryAvailability() and findRoutesWithFewestSplits() methods.

API Version

54.0

Requires Chatter

No

Signature

public static ConnectApi.FindRoutesWithFewestSplitsUsingOCIOutputRepresentation findRoutesWithFewestSplitsUsingOCI(ConnectApi.FindRoutesWithFewestSplitsUsingOCIInputRepresentation findRoutesWithFewestSplitsUsingOCIInput)

Parameters

findRoutesWithFewestSplitsUsingOCIInput
Type: ConnectApi.FindRoutesWithFewestSplitsUsingOCIInputRepresentation
The input includes, for each order, the ordered item quantities, the assigned location group or locations, and, optionally, a maximum allowable number of shipment splits and a list of locations to exclude from the calculation.

Return Value

Type: ConnectApi.FindRoutesWithFewestSplitsUsingOCIOutputRepresentation

getFOCapacityValues(getFOCapacityValuesInput)

Get information about the current fulfillment order capacity of one or more locations.

API Version

55.0

Requires Chatter

No

Signature

public static ConnectApi.GetFOCapacityValuesOutputRepresentation getFOCapacityValues(ConnectApi.GetFOCapacityValuesRequestInputRepresentation getFOCapacityValuesInput)

Parameters

getFOCapacityValuesInput
Type: ConnectApi.GetFOCapacityValuesRequestInputRepresentation
Locations to get fulfillment order capacity information about.

Return Value

Type: ConnectApi.GetFOCapacityValuesOutputRepresentation

holdFOCapacity(holdFOCapacityInput)

Hold fulfillment order capacity at a location. Holding capacity at a location reserves a space for a fulfillment order that you’ll assign to it.

API Version

55.0

Requires Chatter

No

Signature

public static ConnectApi.HoldFOCapacityOutputRepresentation holdFOCapacity(ConnectApi.HoldFOCapacityInputRepresentation holdFOCapacityInput)

Parameters

holdFOCapacityInput
Type: ConnectApi.HoldFOCapacityInputRepresentation
The input includes, for each fulfillment order, the location to hold capacity for it.

Return Value

Type: ConnectApi.HoldFOCapacityOutputRepresentation

rankAverageDistance(rankAverageDistanceInputRepresentation)

Calculates the average distance from sets of inventory locations to an order recipient, and ranks them. Use this method to compare the average shipping distances for different sets of locations that can fulfill an order. While this method is executing, you can’t invoke another Apex callout.

API Version

51.0

Requires Chatter

No

Signature

public static ConnectApi.RankAverageDistanceOutputRepresentation rankAverageDistance(ConnectApi.RankAverageDistanceInputRepresentation rankAverageDistanceInputRepresentation)

Parameters

rankAverageDistanceInputRepresentation
Type: ConnectApi.RankAverageDistanceInputRepresentation
An order recipient’s geographic location and information about sets of inventory locations that can fulfill the order.

Return Value

Type: ConnectApi.RankAverageDistanceOutputRepresentation

releaseHeldFOCapacity(releaseHeldFOCapacityInput)

Release held fulfillment order capacity at one or more locations. This call decreases a location’s held capacity without changing its assigned fulfillment order count. Release held capacity when you cancel the assignment of a fulfillment order to a location.

API Version

55.0

Requires Chatter

No

Signature

public static ConnectApi.ReleaseHeldFOCapacityOutputRepresentation releaseHeldFOCapacity(ConnectApi.ReleaseHeldFOCapacityInputRepresentation releaseHeldFOCapacityInput)

Parameters

releaseHeldFOCapacityInput
Type: ConnectApi.ReleaseHeldFOCapacityInputRepresentation
The input includes, for each fulfillment order, the location that holds the capacity to release.

Return Value

Type: ConnectApi.ReleaseHeldFOCapacityOutputRepresentation