Integrating capacity data from Sterling Order Management System by using APIs

Set up the integration and propagation of capacity data from your Sterling Order Management System to Sterling Intelligent Promising. Follow the steps for propagating from Sterling Order Management System to Sterling Intelligent Promising to help ensure that accurate and timely capacity updates are made across your system.

Before you begin

Before you start, check whether a time zone conversion of the availability timestamps is needed for propagating accurate capacity availability data in Sterling Intelligent Promising.

About this task

The integration of capacity data involves three steps.
  1. Capturing capacity changes in the Sterling Order Management System by using events.
  2. Updating capacity in Sterling Intelligent Promising with Sterling Intelligent Promising APIs.
  3. Reserving capacity in the Sterling Order Management System while taking reservations in Sterling Intelligent Promising.

Procedure

  1. Establish Sterling Order Management System as the primary source of capacity data that manages changes and updates external systems. This is the source that is used to maintain consistent capacity information in the system.
  2. Employ Sterling Order Management System events and agents for handling capacity changes. Examples of some of the APIs used to handle capacity changes are, manageCapacityReservation, reserveAvailableInventory, and scheduleOrder. For more information about transactional events, see Transactions.

    Some key events that are used to propagate changes to Sterling Intelligent Promising in real-time, are as follows:

    • The CAPACITY_CHANGE.ON_STD_CAPACITY_FILLED event that is triggered when capacity consumption exceeds the daily standard capacity limit.
    • The CAPACITY_CHANGE.ON_STD_CAPACITY_FREED event that is triggered when capacity becomes available after previous consumption.
    • The CAPACITY_CHANGE.EXTERNAL_CAPACITY_CHANGE event that is triggered when external adjustments are made to capacity consumption.
  3. To map events from Sterling Order Management System to Sterling Intelligent Promising APIs, complete the following steps:
    1. Synchronize capacity data by using the Sterling Order Management System events for capacity filling, freeing, changing, and to trigger the Sterling Intelligent Promising updates.
    2. To integrate the data, trigger the updates in Sterling Intelligent Promising by mapping the Sterling Order Management System events to Sterling Intelligent Promising APIs.
      • Endpoint: 
        GET/PUT/promising/{tenantId}/v2/nodes/{nodeId}/capacity/{capacityUom}/{categoryId}
      • Method: Implement PUT requests to update Sterling Intelligent Promising capacity that is based on Sterling Order Management System events.
      • Configuration: Collect the necessary node-specific parameters, such as tenantId, nodeId, capacityUom, categoryId, to propagate data to Sterling Intelligent Promising.
  4. Call the Sterling Order Management System manageCapacityReservation API at the same time and at every occurrence of an inventory reservation call through the e-commerce channel. This action helps to ensure that changes that are triggered through any e-commerce activity are propagated to Sterling Intelligent Promising.
  5. To test and validate the data integration to ensure that it is accurate for your system, complete the following steps:
    • Run staging tests in a staging environment to confirm end-to-end data flows from Sterling Order Management System to Sterling Intelligent Promising.
    • Run peak load testing to verify that the data in Sterling Intelligent Promising reflects the Sterling Order Management System capacity updates accurately. This testing helps to prepare for scalability at peak times and during high-usage scenarios.