Request and response for Optimizer API and Idle API

The Optimizer API and Idle API accept requests for a promise order from IBM® Sterling Order Management System Software.

Optimizer API request and response

The Optimizer API request is accepted in the JSON format. For more information about the Optimizer API request input, see Optimizer API.

For more information, see Managing optimization profiles.

Idle API request and response

The Idle API accepts JSON format in the request body and returns JSON format in the response. For more information on the Idle API request input, see Idle API.

Optimizing orders with vendor (direct ship-to vendor) nodes

If you have vendor nodes in your fulfillment network, help ensure that they are specified with Use For Fulfillment as Y in your node configuration. For more information on node configuration, see Configuring nodes.

Use isExternalNode to identify assignments that are fulfilled from vendor (direct ship-to vendor) nodes.
  • Valid values are Y or N.
    • By default, the value is set to N.
    • If a vendor node is specified as not active (Use For Fulfillment = N in the Fulfillment Network Data feed, the Optimization service returns a rejection reason of Ship node is not active for fulfillment in the response.
    • When Use For Fulfillment and IsExternalNode are set to Y, the vendor node's assignment is given preference over other assignments for an order line.
      • When the vendor node can fulfill the order line completely, it is marked as selected and other assignments are rejected.
      • When the vendor node can fulfill order line partially, the vendor node is marked as selected and other assignments are optimized for remaining quantity.

Orders with preselected nodes

Use IsPredefinedNode in the request to specify order lines where the shipping node is already selected for sourcing and optimization is not required.
  • Valid values are Y or N. It is assumed that lines with delivery method PICK or CARRY and lines that are marked for Same Day Delivery have isPredefinedNode Y when sent from the Sterling Order Management System.
  • By default, the value is considered as N if it is not specified.
  • Lines marked Y are not optimized.

Carrier information

The response contains the carrier information only if isExternalNode is set to N in the request and if RejectChoice is N.

Supply information

Supply information for a specific point in time is required as part of the Optimizer API call when the Inventory Model is turned on. There can be multiple pieces of supply information for a single ship node assignment. Supply information is added for all the supplies of a ship node assignment. Each supply contains AvailableQuantity and SafetyQuantity, which are added to get the total available supply at the time of optimization.

For example, when the input of the Optimizer API has the following information, the total available supply that is considered is 12.

<Supplies> <Supply AvailableQuantity="10" FirstShipDate="2020-06-08" LastShipDate="2020-06-12"
SafetyQuantity="2" SupplyID="ONHAND" Track="Y"/> </Supplies>

Shipping Benefit calculation for OMS sourcing choice

For you to view the KPIs for the OMS sourcing choice, you must configure your order management system to send the Optimization service Suggested Option in the request to the Idle API and Optimization API. The KPIs for the OMS sourcing choice are used to derive the Shipping benefit that is displayed in the Benefits Report.

External Delivery Dates calculation

For information about the external delivery dates calculation, see Estimated ship date calculation.

Enquiry mode

If the request to the API contains the isEnquireMode attribute, the order line will not be considered for any KPI calculations or alternate optimization. Use this attribute to make Optimization calls from Sterling Order Management System APIs like the findInventory API.

For more information about enquiry mode, see Idle API.