Routing Class
Route orders to inventory locations in Order Management.
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.
-
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.
-
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()andfindRoutesWithFewestSplits()methods. -
getFOCapacityValues(getFOCapacityValuesInput)
Get information about the current fulfillment order capacity of one or more locations.
-
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.
-
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.
-
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.
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.
55.0
No
public static ConnectApi.ConfirmHeldFOCapacityOutputRepresentation confirmHeldFOCapacity(ConnectApi.ConfirmHeldFOCapacityInputRepresentation confirmHeldFOCapacityInput)
- confirmHeldFOCapacityInput
Type:
ConnectApi.ConfirmHeldFOCapacityInputRepresentationThe input includes, for each fulfillment order, the location where capacity is held for it.
Type: ConnectApi.ConfirmHeldFOCapacityOutputRepresentation
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.
51.0
No
public static ConnectApi.FindRoutesWithFewestSplitsOutputRepresentation findRoutesWithFewestSplits(ConnectApi.FindRoutesWithFewestSplitsInputRepresentation findRoutesWithFewestSplitsInputRepresentation)
- findRoutesWithFewestSplitsInputRepresentation
Type:
ConnectApi.FindRoutesWithFewestSplitsInputRepresentationThe input includes the ordered item quantities, data about available inventory, and, optionally, a maximum allowable number of shipment splits.
Type: ConnectApi.FindRoutesWithFewestSplitsOutputRepresentation
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.
54.0
No
public static ConnectApi.FindRoutesWithFewestSplitsUsingOCIOutputRepresentation findRoutesWithFewestSplitsUsingOCI(ConnectApi.FindRoutesWithFewestSplitsUsingOCIInputRepresentation findRoutesWithFewestSplitsUsingOCIInput)
- findRoutesWithFewestSplitsUsingOCIInput
Type:
ConnectApi.FindRoutesWithFewestSplitsUsingOCIInputRepresentationThe 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.
Type: ConnectApi.FindRoutesWithFewestSplitsUsingOCIOutputRepresentation
See Also
- getInventoryAvailability(inventoryAvailabilityInputRepresentation)
- findRoutesWithFewestSplits(findRoutesWithFewestSplitsInputRepresentation)
Get information about the current fulfillment order capacity of one or more locations.
55.0
No
public static ConnectApi.GetFOCapacityValuesOutputRepresentation getFOCapacityValues(ConnectApi.GetFOCapacityValuesRequestInputRepresentation getFOCapacityValuesInput)
- getFOCapacityValuesInput
Type:
ConnectApi.GetFOCapacityValuesRequestInputRepresentationLocations to get fulfillment order capacity information about.
Type: ConnectApi.GetFOCapacityValuesOutputRepresentation
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.
55.0
No
public static ConnectApi.HoldFOCapacityOutputRepresentation holdFOCapacity(ConnectApi.HoldFOCapacityInputRepresentation holdFOCapacityInput)
- holdFOCapacityInput
Type:
ConnectApi.HoldFOCapacityInputRepresentationThe input includes, for each fulfillment order, the location to hold capacity for it.
Type: ConnectApi.HoldFOCapacityOutputRepresentation
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.
51.0
No
public static ConnectApi.RankAverageDistanceOutputRepresentation rankAverageDistance(ConnectApi.RankAverageDistanceInputRepresentation rankAverageDistanceInputRepresentation)
- rankAverageDistanceInputRepresentation
Type:
ConnectApi.RankAverageDistanceInputRepresentationAn order recipient’s geographic location and information about sets of inventory locations that can fulfill the order.
Type: ConnectApi.RankAverageDistanceOutputRepresentation
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.
55.0
No
public static ConnectApi.ReleaseHeldFOCapacityOutputRepresentation releaseHeldFOCapacity(ConnectApi.ReleaseHeldFOCapacityInputRepresentation releaseHeldFOCapacityInput)
- releaseHeldFOCapacityInput
Type:
ConnectApi.ReleaseHeldFOCapacityInputRepresentationThe input includes, for each fulfillment order, the location that holds the capacity to release.