SSJF7L - Documentation Index

Table of Contents

• Welcome
• What's new
  • Archived what's new
    • ...in 2025
    • ... in previous years
    • Archived what's changed on Cloud
• Overview
  • License types
    • Essentials
    • Standard
    • Premium
    • Premium Hybrid Container
  • Feature differences between SaaS and on-premises containers offerings
  • Promising service
    • Estimated Delivery Dates
    • Legacy: Capacity categories
    • Pickup times and schedules
    • Pickup cutoffs
    • Delivery method
    • Ship to store (STS)
    • Checkout
      • SLA-based checkout
      • Cost-based checkout
    • Lead time
    • Shipping notification time
    • Shipping cutoff times
    • Processing time
    • Promising rules
    • Sourcing priority rules
    • Transfer rules
    • Shipping groups
    • Shipping commitment days
    • Custom attributes
  • Inventory service
    • Inventory tags
    • Events
      • Event formats
        • New event formats
      • Event consumption
        • Event consumption using webhooks
          • New event delivery format
            • Failed events in array format
            • Sample array format payloads
        • Event consumption using cloud object storage (COS)
      • Retrieving failed events
      • Inventory snapshots
      • Calculating availability
      • Enabling event publishing in containers
    • Unplanned inventory
    • Transaction data
      • Supply and demand
        • Matching supply to demand
        • Supply and Demand API reference attribute
        • Inventory audit
          • Supply audits due to segmentation rules
            • Supply audit due to segment allocation
            • Supply audit due to unsegmented inventory consumption
        • Reenabling SKU fulfillment options
        • Supply sync transparency
        • Inventory search
        • Inventory synchronization
      • Inventory availability
        • Availability by date
        • Bundle availability
      • Reservations
        • Updating existing reservations
        • Reservations by date (V2)
        • Bundle reservation
    • Bundle
    • Event thresholds
    • Item attributes
    • Item fulfillment options
    • Item thresholds
    • Items with variations
    • Node fulfillment options
    • Safety stock
      • Item-based safety stock
      • Rules-based safety stock
    • Inventory segment
      • Segment allocation plan
        • Segmentation allocation rules
        • Segment rebalancing
      • Unsegmented inventory for segments
  • Optimization service
    • Optimization profile
    • Currency handling
    • Optimization objectives
      • Minimize shipping cost
      • Balance node capacity
        • Node-balancing values
        • Fulfillment network cutoff
      • Minimize processing cost
      • Avoiding stockouts
      • Avoiding markdowns
      • Node performance
        • Node risk model
      • Optimizing delivery speed
    • Optimization penalties
    • Optimization constraints
      • SLA-based optimization
      • Date-based optimization
        • Scenario: Date-based optimization
        • Scenario: Delay penalty
    • Node capacity
    • Capacity conversion
    • Node calendar
    • Node processing cost
    • Optimization explainer and orders
    • Benefits report
      • Aggregate KPIs
        • KPI calculation for rescheduled orders
          • Scenario: Rescheduled orders
      • Node breakdown KPIs
      • Carbon emissions report
    • Data ingestion
    • Markdown cost calculation overview
      • Tiered markdowns
  • Capacity service
    • Service category
    • Operation calendar
    • Resource pool
    • Capacity availability
    • Overriding availability
    • Booking
    • Backlogs
  • Insights
    • Inventory Integrity dashboard
      • Prerequisites and data integration
      • Inventory anomaly reporting and remediation procedures
  • Common configuration
    • Tenant settings
    • Node and node types
    • Distribution groups
    • Catalog service
      • Attribute
        • Creating an attribute and defining allowable values
        • Assigning attributes to an item
      • Item
        • Category and item attribute assignment hierarchy
          • Creating categories
          • Assigning items to a category
      • Item classification
      • Bundle components
    • Carriers and carrier services
      • Shipping zones
      • Transit duration and delay
      • Transit rate
      • Dimensional weight factor and volume threshold
      • Surcharges
      • Calendar constraints
  • IBM containers overview
  • What's deprecated
  • Technology preview
  • Training courses
  • Accessibility
• Getting started
  • Getting started for fulfillment managers
  • Getting started for tenant administrators
  • Getting started for system integrators
• Installing
  • IBM Sterling Intelligent Promising Standard Operator overview
  • Deployment architecture
  • IBM OMS Gateway Operator overview
  • Preparing to install IBM Sterling Intelligent Promising by using containers
    • Meeting the system requirements
      • Installing middleware services in a production environment
        • Kafka topic list for the services
    • Setting up a multicluster environment
      • List of Kafka topics to be mirrored
      • Moving from single to multiple clusters
      • Creating Elasticsearch snapshot to backup and restore data
    • Installing the IBM Sterling Intelligent Promising Operator and IBM OMS Gateway Operator
      • Preparing to install Order Management Software Operator
        • Installing a client binary command-line tool
        • Installing the Operator SDK command-line tool
      • Preparing and configuring catalog source for IBM OMS Gateway Operator and IBM Sterling Intelligent Promising Operator
        • Preparing the catalog source manifest
        • Configuring the catalog source
          • Configuring the catalog source by using the command-line interface (CLI)
          • Configuring the catalog source by using Red Hat OpenShift Container Platform web console
      • Installing the Operators
        • Installing the Operators with Operator Lifecycle Manager
          • Installing the Operators by using command-line interface (CLI)
          • Installing the Operators by using the Red Hat OpenShift Container Platform web console
        • Installing the Operators without Operator Lifecycle Manager
          • Operator Utility overview
            • Migrating from OLM to non-OLM installation
              • Troubleshooting migration from OLM to non-OLM installation
    • Creating a secret
    • Creating an ingress certificate secret
    • Creating a JWT issuer secret by using a public key
    • Creating an image pull secret
      • Obtaining container images from IBM Entitled Registry
      • Registry image names for IBM Sterling Intelligent Promising Standard package
    • Creating a Kubernetes Persistent Volume manually
    • Enabling security context constraint
  • Installing IBM Sterling Intelligent Promising by using containers
    • Configuring custom resources
      • Versioning of Custom Resource Definitions
      • IBM Sterling Intelligent Promising custom resources and service groups
      • Configuring SIPEnvironment custom resource
        • SIPEnvironment custom resource parameters
          • General parameters
            • Pulling images from private repositories
          • omsGateway parameter
            • Custom TLS certificate configuration in OMS Gateway
          • ivService group parameter
          • promisingService group parameter
          • utilityService group parameter
          • optimizerService group parameter
          • common parameter
            • Configuring customDomains in SIPEnvironment
          • security parameter
          • additionalMounts parameter
            • Use cases to define additionalMounts
          • networkPolicy parameter
          • storage parameter
          • image parameter
          • serverProperties parameter
            • Common server properties for Inventory and Promising service groups
          • externalServices parameter
          • affinityAndTolerations parameter
          • apiDocsService parameter
          • horizontalPodAutoscalers parameter
          • log parameter
          • topologySpreadConstraints parameter
        • SIPEnvironment custom resource manifest
          • v1
          • v1beta1
      • Configuring IVServiceGroup custom resource (independent mode)
        • IVServiceGroup custom resource parameters
        • IVServiceGroup custom resource manifest
          • v1
          • v1beta1
      • Configuring PromisingServiceGroup custom resource (independent mode)
        • PromisingServiceGroup custom resource parameters
        • PromisingServiceGroup custom resource manifest
          • v1
          • v1beta1
      • Configuring UtilityServiceGroup custom resource (independent mode)
        • UtilityServiceGroup custom resource parameters
          • Centralized Logstash server
        • UtilityServiceGroup custom resource manifest
          • v1
          • v1beta1
      • Configuring OptimizerServiceGroup custom resource (independent mode)
        • OptimizerServiceGroup custom resource parameters
        • OptimizerServiceGroup custom resource manifest
          • v1
          • v1beta1
    • Monitoring of custom resources
      • Status types for IBM Sterling Intelligent Promising Operator custom resources
      • Change tracking for custom resource updates
  • Using Apache Kafka for external integrations
  • Enabling the Premium feature in containers
  • Versioning scheme for major releases and fix packs
  • Annotations used in Sterling Intelligent Promising Operator
  • CertificateManager custom resource
    • Key features and benefits of CertificateManager
    • CertificateManager custom resource parameters
  • Uninstalling IBM Sterling Intelligent Promising Operator
  • Uninstalling IBM Sterling Intelligent Promising
  • Installing a specific Operator version
    • List of Operator versions and application image tags
  • Extracting Operator root certificate and adding it to ingress
• Configuring
  • Service configurations
  • Configuring the common and catalog services
    • Configuring common services
      • Configuring nodes
        • Managing node types
        • Editing and deleting nodes
        • Activating and deactivating shipping groups at a node
        • Activating and deactivating a carrier service at a node
        • Deactivating a node for a specified period
      • Creating distribution groups
    • Configuring the Catalog service
      • Configuring the catalog
        • Configuring item classification
        • Configuring Item instructions
        • Create individual component items
        • Create a bundle parent with a bundle kit code and associate the component items
  • Configuring inventory
    • Configuring the Inventory service
    • Configuring inventory to receive data
    • Configuring the endpoints for publishing events
    • Configuring segments
    • Configuring child-parent item relationships and availability updates in containers
  • Configuring capacity
    • Configuring capacity
      • Configuring capacity categories
  • Configuring promising
    • Configuring the Promising service
    • Configuring lead times
    • Configuring capacity availability for promising
    • Configuring shipping groups
    • Configuring processing time
    • Configuring cost-based optimization for promising
    • Configuring shipping notification time
    • Configuring shipping cutoff times
    • Configuring shipping cutoff times by using APIs
    • Configuring pickup times and schedules
    • Configuring pickup times and schedules by using APIs
    • Configuring pickup cutoffs
    • Configuring pickup cutoffs by using APIs
    • Configuring custom attributes
    • Configuring caching for Estimated Delivery Dates
    • Configuring caching for Estimated Delivery Dates by using APIs
  • Configuring optimization
    • Configuring the Optimization service
      • Configuring stockout and markdown avoidance
      • Configuring endpoints for file ingestion rules
      • Configuring capacity for the Optimization service
  • Configuring the carrier services and transit details
    • Configuring carriers
    • Configuring carrier services
    • Configuring carrier services by using APIs
    • Configuring zone components for a carrier service
    • Configuring shipping zones by using APIs
    • Configuring transit duration by using APIs
    • Configuring the transit rate by using APIs
    • Configuring carrier service surcharges by using APIs
    • Configuring zone component surcharges by using APIs
    • Configuring carrier calendars and constraints
      • Configuring carrier calendar constraints by using APIs
• Administering
  • Configuring the UI to receive inventory data
  • Defining user permissions and roles
  • Adding users
  • Enabling inventory segmentation allocation and rebalancing frequency
  • Enabling unsegmented consumption rules
  • Enabling the node location aggregate for network safety stock
  • Self Service
    • Web browser support
    • Accessing Self Service
    • Changing your preferences
    • Viewing the privacy notice
    • User role management
      • Organization operations roles within Self Service
      • Creating users and assigning roles
      • Removing roles and deleting users
    • Environments in Self Service
    • Accessing applications
    • Viewing system notifications, messages, and Inbox notifications
    • Monitoring dashboards
      • Dashboards and charts
      • Viewing dashboards
• Upgrading
  • Upgrading to Inventory service V2 APIs and events
    • V1 and V2 API URLs and event identifiers for Inventory service
  • Key differences between V1 and V2 APIs and events of the Inventory service
  • Line limit examples for the inventory reservation and availability APIs
  • Upgrading in containers
    • Pre-upgrade tasks
      • Pre-upgrade to 10.2409.2
      • Pre-upgrade to 10.2601.0
      • Pre-upgrade to 10.0.2601.1
      • Pre-upgrade to 10.2604.0
      • Pre-upgrade to 10.2604.1
      • Pre-upgrade to 10.2604.2
    • Upgrading the Operators
      • Prerequisites for upgrading to 10.0.2406.0-amd64
    • Updating the application service image
    • Post-upgrade tasks
      • Post-upgrade to 10.2409.0
      • Post-upgrade to 10.2409.1
      • Post-upgrade to 10.2409.2
      • Post-upgrade to 10.2503.2
      • Post-upgrade to 10.2506.0
      • Post-upgrade to 10.2506.2
      • Post-upgrade to 10.2509.0
      • Post-upgrade to 10.2509.1
      • Post-upgrade to 10.2604.2
  • Resolved issues in containers
    • Archived resolved issues
  • Release schedule
• Managing
  • Supported browsers
  • Logging in to Order Hub
    • Managing display settings
  • Managing tenant settings
  • Scenario: Implementing an e-commerce store
  • Scenario: Implementing post-purchase fulfillment
  • Managing promising
    • Creating transfer rules in Order Hub
      • Scenario: Transfer rules
    • Creating and deleting transfer rules by using APIs
    • Managing Promising rules
      • Scenario: Fulfillment sourcing rules
      • Scenario: Calculate item delivery or pickup date based on finite capacity windows
      • Scenario: Calculate pre-purchase pick-up and shipment assignments using finite capacity windows
      • Scenario: Optimizing Promising
      • Creating custom attributes for sourcing by using an API
    • Testing promising configurations
    • Cost-based promising
    • Promising calculations and Diagnostic APIs
    • Managing cost-based optimization for promising
      • Scenario: Ship from store (SFS)
    • Creating and editing sourcing priority rules
    • Managing shipping commitment days
      • Scenario: Shipping commitment day promises
      • Scenario: Shipping notification time for e-Commerce delivery via carrier service
    • Scenario: Defining shipping cutoff times
    • Scenario: Applying pickup schedules
    • Scenario: Applying pickup cutoffs
    • Managing capacity conversion
    • Scenario: Using the Estimated Delivery Dates cache
    • Scenario: Availability and fulfillment with unplanned inventory and unsegmented consumption
    • Scenario: Tag-aware checkout assignment for specific inventory requirements
  • Managing inventory
    • Managing Inventory integrity report
    • Transferring inventory
      • Viewing item details
      • Viewing SKU details
      • Viewing inventory audit details
      • Adjusting inventory
      • Adjusting safety stock
      • Setting fulfillment options
      • Transferring inventory
    • Managing safety stock rules
      • Creating safety stock rules
        • Creating safety stock setting at network level
      • Safety stock rule details
      • Scenario: Node location aggregate in network availability safety stock
      • Scenario: Node type location aggregate in network availability safety stock
      • Safety stock rule: Priority list
    • Searching audit inventory
    • Managing inventory segmentation allocation rules
      • Creating and updating segmentation allocation rules
        • Scenario: Supply segmentation allocation rules
    • Managing unplanned inventory rule
      • Scenario: Unplanned inventory consideration
    • Managing unsegmented inventory for segments
      • Scenario: Utilizing unsegmented inventory for segments
    • Searching inventory (without OMS)
    • Searching inventory availability
      • Managing fulfillment options
      • Managing supply demand types
        • Searching Supply and demand
      • Adding a fulfillment constraint
    • Managing reservations
      • Creating a new reservation
        • Searching the inventory reservations by Item
        • Searching the inventory reservations by Reference or Reservation ID
    • Managing inventory tags
      • Scenario: Tagged and untagged inventory management
    • Scenario: Buy online and pick up in a store (BOPIS)
    • Scenario: Ship from store or distribution center (DC)
    • Scenario: Purchase order receipt
  • Managing optimization
    • Managing optimization profiles
    • Set fulfillment options at the node
    • Managing node-balancing values
      • Scenario: Node balancing cost optimization
    • Viewing the optimization dashboard
      • Scenario: Shipping cost optimization
      • Scenario: Dimensional weight factor and volume threshold for carrier services
      • Scenario: Cumulative Capacity Utilization (CCU) for a node
      • Scenario: Stockout avoidance optimization
      • Scenario: Markdown avoidance optimization
      • Scenario: Monitoring node performance
      • Scenario: Accelerating deliveries with cost optimization
    • Optimization explainer
      • Using the optimization explainer
      • Order summary
        • Viewing the order summary
      • Nodes considered
        • Viewing the nodes considered for an item
    • Viewing the benefits report
    • Viewing the shipping benefit KPIs
    • Scenario: Markdown cost calculation
  • Managing carrier services
    • Creating and deleting carriers by using APIs
    • Deleting transit rates
    • Disabling a carrier service for a shipping group
    • Scenario: Carrier service and zone component surcharges
      • Scenario: Carrier service surcharges
      • Scenario: Zone component surcharges
      • Scenario: Carrier zones
    • Assigning a charge tier to a surcharge
      • Scenario: Charge tier calculations
    • Scenario: Calendar constraints
• Monitoring
• Developing
  • Extending item attributes for availability and events
• Integrating
  • Service integration
    • Integrating with the Inventory service
      • Integrating inventory data from external systems to Inventory service
      • Integrating inventory service with Sterling Order Management
    • Integrating with the Promising service
      • Integrating with the Promising service packages
    • Integrating with the Optimization service
      • Integrating with the Optimization service packages
      • Integrating the Optimization service with Sterling Order Management System by using the adapter
      • Integrating the Optimization service with Sterling Order Management System by using APIs
        • Optimization APIs
          • Idle API
          • Rank API
          • Optimizer API
            • Scenario: Inventory allocation for the same item across multiple order lines or same-node assignments
            • Request and response for Optimizer API and Idle API
            • Estimated ship date calculation
            • Comparing the Rank API and the Optimizer API
            • Comparing the Idle API and the Optimizer API
            • Inventory availability lookup
            • Error codes and error messages
              • OTMZGNE - General application errors
              • OTMZOPTE - Optimization service errors
              • OTMZRNE - Rank API errors
              • WOORE - Optimization Explainer API errors
        • Optimization explainer APIs
    • Integrating with the Capacity service
      • Integrating capacity data from Sterling Order Management System by using APIs
      • Integrating capacity data from external systems by using APIs
  • Integrating data
    • Data feed types overview
      • Transferring T-log data
      • Transferring markdown data
      • Transferring order line status data
      • Transferring catalog item data
      • Transferring availability data
      • Transferring supply plan data
    • Downloading, Installing, and configuring the IBM Sterling Intelligent Promising file transfer adapter
    • Using the IBM Sterling Intelligent Promising file transfer adapter for data ingestion
    • Starting the file ingestion process
    • Monitoring data for file ingestion
      • File ingestion prefix structure
      • Troubleshooting data ingestion errors
  • Integrating events
    • Publishing events from the Inventory service to webhooks
    • Publishing events from the Inventory service to cloud storage solutions
      • Publishing events from the Inventory service to IBM Cloud Object Storage
      • Publishing events from the Inventory service to Google Cloud Storage
      • Publishing events from the Inventory service to Azure Blob Storage
      • Publishing events from the Inventory service to Amazon Web Services
  • Container integration
    • Integrating with IBM Sterling Order Management System Software
      • Integrating with IBM Sterling Order Management System Software developer toolkit
        • … phase 1
        • … phase 2
      • Integrating with IBM Sterling Order Management System Software containers
        • … phase 1
        • … phase 2
      • Integrating with IBM Sterling Order Management System Software on-premises
        • … phase 1
        • … phase 2
    • Integration with external systems
• Troubleshooting
  • Disaster Recovery (DR)
  • Root cause analysis procedures
  • Frequently asked questions (FAQs)
    • ... about Sterling Intelligent Promising
    • ... about containers
  • Log management
    • Application logs
    • Audit logs
    • Platform logs
    • Gathering logs
    • Viewing logs for uploading customization
    • Viewing logs for deploying customization
  • Troubleshooting issues in containers
• Security
• API reference
  • Accessing and Authenticating APIs
  • API best practices
  • API access for containers deployment
• Glossary