Optimization explainer APIs
When an order is sent to the Optimization service, the order goes through many rules, configurations, constraints, and cost optimization to determine the best option to fulfill the order. The Optimization explainer APIs provide information about the orders that are processed.
- Weighted preferences of business objectives for optimization at the time of order.
- The total optimization cost for the order where the business settings at the time of optimization are applied (multiplied) to each cost. The cost includes the sum of the shipping cost, processing cost, load balancing cost, distance penalty cost, stockout cost, and markdown cost.
- Shipments or winning nodes for an order.
- Ship node sent for optimization for order lines for an order. The information for each ship node includes:
- Costs include processing cost, load-balancing cost, distance penalty cost, stockout cost, and markdown cost. This does not include the shipping cost, which is only calculated for shipments and not for ship nodes.
- On-hand inventory at the time of optimization
- Backlog at ship node
- Carriers that can fulfill the order.
- Shipment details include:
- Whether it is a regular, delayed, or upgraded shipment.
- Weight of shipment
- Items included in the shipment.
- Carrier and carrier service name
- Zone and distance between ship node and ship to address
- Cost includes shipping cost, processing cost, load balancing cost, distance penalty cost, stockout cost, and markdown cost.
KPI APIs provide metrics over time by using the Optimization service. These APIs are broadly classified as Fulfillment network KPIs, Node KPIs, and Inventory optimization KPIs. KPIs are aggregated by the run date (the date on which the optimization occurred). Benefits report APIs provide comparative metrics of benefits over a time by using the Optimization service. These benefits are calculated based on pre-defined parameters and user-defined optimization parameters. If the sourcing choice of your Order Management System is passed in the request to the Idle Optimizer API or Optimizer API, the KPIs are computed for the sourcing choice of your Order Management System. The Configurational Data APIs provide information about Configurational data, which is uploaded to the Optimization service and used during optimization.