Idle API

You can use the Idle API to determine how you would benefit from using the Optimization service before integrating it with your Sterling Order Management System.

The Idle API enables asynchronous order optimization. The request to this must include the Optimization service Suggested Option to indicate the sourcing choice made by your order management system. The API uses the request and sends it to an internal queue for asynchronous processing. The baseline KPIs are computed after a certain latency period. During the asynchronous optimization process, the Optimization service takes the last message that is received within a pre-defined period. The Idle API performs the following validations:
  • Determining whether the input is a valid JSON document
  • Determining whether orderNo is included in the input

The Idle API performs Shadow optimization in addition to regular optimization. KPIs are always computed for the standard optimization and alternate optimization settings. If the sourcing choice of your Sterling Order Management System is passed in the request to the Idle API or Optimizer API, the KPIs are computed for the sourcing choice of your Sterling Order Management System.

If in case, the carrier services are predefined and preferred delivery method is ship, a Fulfillment Manager can input Carrier Service IDs in the preferredCarrierServices field. You can input Carrier Service IDs at either order level or order line level. This enables the Optimization service to consider the preferred carrier services over other carrier services within the specified shipping groups.

Note: For the Optimization service to consider the preferred carrier services, it is important that a Fulfillment Manager adds those carrier services as members of the specified shipping groups.

Limitations of the Idle API

  • The OrderDate that is provided to the Idle API as input is used for logging purposes. The order is processed with respect to the current time when the order is received by the Optimization service. A resourced order is considered as a new order by the Optimization service.
  • The Optimization service can process only one ship to address. It uses the address that is provided at order level. If an address is not available at order level, then it uses the address from the first order line.
  • The Optimization service cannot process the same SKU if it is part of multiple order lines in the same order.
  • The Optimization service can process only one SLA. It uses the value of the attribute CarrierServiceCode provided at the first order line.
  • The Optimization service does not provided the Cost to Serve information back to the application that is calling the Idle API.