Inventory Classes
The inventory API includes the following classes:
InventoryManager
InventoryException
ATG Commerce Programming Guide
.
Documentation Home
Feedback
Highlighting
Prev
Up
Next
Contents
Search
Introduction
Commerce Overview
Product Catalog
Purchasing and Fulfillment Services
Inventory Management
Pricing Services
Targeted Promotions
Commerce Services
Reporting
Multisite Integration
Finding What You Need
Configuring and Populating a Production Database
Configuring Oracle ATG Web Commerce with CIM
Creating Database Tables
Creating Tables for a Switching Schema
Creating Motorprise Reference Application Tables
Using Oracle ATG Web Commerce with an Oracle Database
Configuring Storage Parameters
Configuring a Catalog for Oracle Full Text Searching
Using Oracle ATG Web Commerce with an MSSQL Database
Transferring Product Catalog and Price List Data Using Copy and Switch
Configuring a Database Copy
Performing a Database Copy
Configuring a Database Switch
Performing a Database Switch
Destroying Database Tables for Oracle ATG Web Commerce
Using and Extending the Product Catalog
Production and Development Modes
Product Catalog Repository
Catalog Properties
Categories and Products
Defining Root Categories
Category Properties
categoryInfo Properties
Product Properties
productInfo Properties
Defining Relationships between Categories and Products
Specifying Template Pages for Categories and Products
Associating Products with SKUs
Extending the Category and Product Item Types
SKU Items and SKU Links
SKU Properties
SKUInfo Properties
SKU Link Properties
Using SKU Media Properties
Using SKU Price Properties
Using the SKU Fulfiller Property
Creating SKU Bundles
Extending the SKU Item Type
Configurable SKUs
Catalog Folders
Folders and Media Items
Folder Properties
Media Item Properties
Using Media-External Properties
Using Media-Internal Properties
Internationalizing the Product Catalog
Catalog Security
Importing Product Catalog Content
Assigning a Catalog to a User
ContextValueRetriever Class
Using the Catalog Maintenance System
Batch Services
CatalogMaintenanceService
AncestorGeneratorService
CatalogVerificationService
CatalogUpdateService
Dynamic Services
CatalogChangesListener
PropertiesChangedHandler Components
CatalogCompletionService
Running Catalog Maintenance Services
Running Batch Services from the Commerce Admin Page
Running a Batch Service from the ACC
Batch Maintenance Form Handler
Running Dynamic Services
Oracle ATG Web Commerce Profile Extensions
Profile Repository Extensions
User Properties
Organization Properties
Profile Form Handler Extensions
Profile Tools and Property Manager Extension
Configuring Commerce for Multisite
Site Repository Extensions for Commerce
Configuring Commerce Options in Site Administration
Assigning Price Lists and Catalogs in a Multisite Configuration
Configuring Commerce Services
Setting Up Gift Lists and Wish Lists
Gift List Business Layer Classes
Gift List Repository
Gift List Form Handlers
Gift List Servlet Beans
Purchase Process Extensions to Support Gift Lists
Gift and Wish Lists in a Multisite Environment
Extending Gift List Functionality
Disabling the Gift List Repository
Setting Up Product Comparison Lists
Understanding the Product Comparison System
Using Product Comparison Lists in a Multisite Environment
Extending the Product Comparison System
Using TableInfo to Display a Product Comparison List
Setting Up Gift Certificates and Coupons
The Claimable Repository
The ClaimableTools Component
The ClaimableManager Component
Using Serialized Coupons
Tracking and Limiting Coupon Uses
Tracking Coupon-Adjusted Promotions
Removing Unused Coupon-Based Promotions
Setting Up Gift Certificates
Commerce Pricing Services Overview
Common Terms in Pricing Services
Using Dynamic vs Static Product Pricing
How Static Pricing Works
How Dynamic Pricing Works
How Pricing Services Generate Prices
PricingTools Class
PricingModelHolder
PricingAdjustment
PricingCommerceItem
PricingModelProperties
Commerce Pricing Engines
Pricing Engine Interfaces
The Base Pricing Engine
ItemPricingEngine Interface
OrderPricingEngine Interface
ShippingPricingEngine Interface
TaxPricingEngine Interface
PricingConstants Interface
Default Pricing Engines
PricingEngineService
Default Item Pricing Engine
Default Order Pricing Engine
Default Tax Pricing Engine
Default Shipping Pricing Engine
Price Holding Classes
AmountInfo
ItemPriceInfo
DetailedItemPriceInfo
OrderPriceInfo
ShippingPriceInfo
TaxPriceInfo
Extending Pricing Engines
Extending a Pricing Engine
Creating a New Pricing Engine
Commerce Pricing Calculators
Pricing Calculator Interfaces
ItemPricingCalculator Interface
OrderPricingCalculator Interface
ShippingPricingCalculator Interface
TaxPricingCalculator Interface
CalculatorInfoProvider Interface
Pricing Calculator Classes
DiscountCalculatorService
ItemPriceCalculator
ItemDiscountCalculator
BulkItemDiscountCalculator
ItemListPriceCalculator
ItemSalePriceCalculator
ConfigurableItemPriceCalculator
OrderDiscountCalculator
BulkOrderDiscountCalculator
OrderSubtotalCalculator
ShippingCalculatorImpl
ShippingDiscountCalculator
BulkShippingDiscountCalculator
PriceRangeShippingCalculator
DoubleRangeShippingCalculator
FixedPriceShippingCalculator
PropertyRangeShippingCalculator
WeightRangeShippingCalculator
NoTaxCalculator
TaxDiscountCalculator
BulkTaxDiscountCalculator
TaxProcessorTaxCalculator
Price List ConfigurableItemPriceListCalculator
Price List ItemListPriceCalculator
Price List ItemPriceCalculator
Price List ItemSalesPriceCalculator
Price List ItemSalesTieredPriceCalculator
Price List ItemTieredPriceCalculator
BandedDiscountCalculatorHelper
GWPPriceCalculator
GWPDiscountCalculator
CalculatorInfo
Extending Pricing Calculators
Adding a New Pricing Calculator
Extending Calculators
Qualifier Class
Qualifier Class Overview
Qualifier Properties
Overriding Qualifier Filters
Default Qualifier Service
Evaluating Qualifiers Example
QualifiedItem Class
FilteredCommerceItem
Extending the Qualifier Class
Adding New Criteria to the Filter Methods
Replacing the Way a PMDL Rule Is Evaluated
Replacing the Way the Qualifier Determines the Result Set
Accessing FilteredCommerceItems
Understanding Promotions
Promotion Repository Item Properties
PromotionFolder Repository Items
PromotionStatus Repository Items
Understanding PMDL Discount Rules
PMDL XML Structure
PMDL Example: Bulk Discount
Gift with Purchase Promotions
Gift with Purchase Repository Items
Gift with Purchase Classes
Gift with Purchase Events
Extending Promotions Functionality
Extending the PMDL
Adding New Promotion Discount Types
Adding New Promotions Templates
Promotion Template Basics
Creating the PMDT File
Translating User Input Values in Templates
Working with Repository Item Properties in Templates
Using Promotion Upsell in Templates
Validating Promotions
Localizing Promotions Templates
Editing Existing Promotion Templates
Importing and Exporting Promotions
Architecture Overview
Performing a Promotions Import or Export
Mapping Promotion Properties
Using the PromotionImportExportIntegrator Interface
Configuring Import/Export Batching
Configuring the PromotionImportWorkflowAutomator Component
Performance Issues Related to Promotion Delivery
Using Price Lists
Overview of Setting Up Price Lists
Caching Price Lists
Using Price Lists in Combination with SKU-Based Pricing
Description of Volume Pricing
Setting up Price List Functionality
PriceListManager
Assigning a Price List to a User
Price List Calculators
Using ItemPriceInfo with Price Lists
Implementing Sale Prices using Price Lists
Calculating Prices with a Specific Price List
Using the CurrencyConversionFormatter to Convert Currency
Price List Security Policy
The PriceListSecurityPolicy Class
Configuring the Price List Security Policy
Converting a Product Catalog to Use Price Lists
Working With Purchase Process Objects
The Purchase Process Subsystems
Base Commerce Classes and Interfaces
Address Classes
Business Layer Classes
OrderTools
Pipelines
Order Repository
Creating Commerce Objects
Creating an Order
Using Orders in a Multisite Environment
Creating Multiple Orders
Creating Commerce Items, Shipping Groups, and Payment Groups
Adding an Item to an Order via a URL
Preventing Commerce Items from Being Added to Types of Shipping Groups
Removing Commerce Objects from an Order
Using the SimpleOrderManager
Using Relationship Objects
Relationship Types
Commerce Item Relationships
Relationship Priority
Assigning Items to Shipping Groups
Assigning Costs to Payment Groups
Assigning an Order’s Total Cost to Payment Groups
Assigning an Order’s Component Costs to Payment Groups
Setting Handling Instructions
HandlingInstruction Objects
Adding Handling Instructions to a Shipping Group
Oracle ATG Web Commerce States
Configuring Purchase Process Services
Loading Orders
Refreshing Orders
Modifying Orders
Understanding the CartModifierFormHandler
Modifying the Current Order
Repricing Orders
Saving Orders
Updating an Order with the OrderManager
Canceling Orders
Checking Out Orders
Preparing a Simple Order for Checkout
Preparing a Complex Order for Checkout
Checking Out an Order
Processing Payment of Orders
Overview of the Payment Process
Extending the Payment Operations of a Payment Method
Extending the Payment Process to Support a New Payment Method
Extending Order Validation to Support New Payment Methods
Scheduling Recurring Orders
Understanding the scheduledOrder Repository Item
Submitting Scheduled Orders
Creating, Modifying, and Deleting Scheduled Orders
Using Scheduled Orders with Registered Sites
Setting Restrictions on Orders
Understanding the Order Restriction Classes
Implementing Order Restrictions
Tracking the Shopping Process
Shopping Process Stages
Working with Shopping Process Stages
Shopping Process Recorder
Turning Off Recording of Shopping Process Tracking
Troubleshooting Order Problems
Handling Returned Items
Managing Transactions in Oracle ATG Web Commerce
Extending the Oracle ATG Web Commerce Form Handlers
Customizing the Purchase Process Externals
Application Messaging
Application Messaging Using Slots
Application Messaging Using JMS Messages
Application Messaging for Gift with Purchase Promotions
Application Messaging for Stacking Rules
Purchase Process Event Messages
Integrating with Purchase Process Services
Purchase Process Integration Points
Adding Credit Card Types to Oracle ATG Web Commerce
Extending the Purchase Process
Adding a Subclass with Simple Data Type Properties
Adding a Subclass with Complex Data Type Properties
Manipulating Extended Objects
Merging Orders
Processor Chains and the Pipeline Manager
Pipeline Manager Overview
Using the Pipeline Editor
Accessing the Pipeline Editor
Opening an Existing Pipeline Definition
Creating a New Pipeline Definition
Editing Existing Pipeline Definitions
Printing a Pipeline Definition
Activating Verbose Mode
Pipeline Debugging
Changing the Display Font of the Pipeline Editor
Reinitializing the Pipeline Manager
Running a Processor Chain
Creating a Processor Pipeline
Configuring a Pipeline Manager
Creating Processors
Pipeline Definition Files
Creating and Editing Processor Chains Programmatically
Extending the PipelineChain and PipelineResult Classes
Pipelines and Transactions
Processor Transaction Management
Spanning Transactions over a Chain Subset
Extending the Processor Pipeline Classes
Using Site-Based Forking in a Processor Chain
Adding a Commerce Processor Using XML Combination
Executing Processor Chains from Processors within Other Chains
Inventory Framework
Overview of the Inventory System
Using the Inventory System
Inventory System Methods
Inventory Classes
InventoryManager
InventoryException
MissingInventoryItemException
InventoryManager Implementations
AbstractInventoryManagerImpl
NoInventoryManager
RepositoryInventoryManager
CachingInventoryManager
LocalizingInventoryManager
Examples of Using the Inventory Manager
Allocating Items for an Order
Canceling or Removing an Item from an Order
Displaying an Item’s Availability to a Customer
Filling Partial Orders
Preventing Inventory Deadlocks
Handling Bundled SKUs in the Inventory
Inventory Repository
Inventory JMS Messages
Configuring the SQL Repository
Caching the Inventory
Inventory Repository Administration
Using the InventoryLookup Servlet Bean
Building a New InventoryManager
Configuring a New Inventory Manager
Configuring the Order Fulfillment Framework
Overview of Fulfillment Process
Running the Fulfillment Server
Order Fulfillment Classes
Using Locking in Fulfillment
Using the OrderFulfiller Interface
Using the Fulfiller
Notifying the HardgoodFulfiller of a Shipment
HardGoodFulfiller Examples
Creating a New Fulfiller
Configuring a New Fulfiller
Order Fulfillment Events
Fulfillment Server Fault Tolerance
Fulfillment Message Redelivery
Replacing the Default Fulfillment System
Integrating the Order Fulfillment Framework with an External Shipping System
Changing Payment Behavior in Fulfillment Server
Using Scenarios in the Fulfillment Process
Questions & Answers
Managing the Order Approval Process
Understanding the Order Approval Process
Modifying the Order Approval Process
Servlet Beans and Form Handlers for Approving Orders
ApprovalRequiredDroplet Servlet Bean
ApprovedDroplet Servlet Bean
ApprovalFormHandler
JMS Messages in the Order Approval Process
Using Abandoned Order Services
An Overview of Abandoned Orders
Abandonment States
Order Repository Extensions
Profile Repository Extensions
The AbandonedOrderLogRepository
Defining and Detecting Abandoned Orders
Defining Abandoned and Lost Orders
Detecting Abandoned and Lost Orders
Configuring AbandonedOrderService
Configuring AbandonedOrderTools
Scenario Events and Actions
Scenario Events
Scenario Actions
Tracking Abandoned Orders of Transient Users
AbandonedOrderEventListener
TransientOrderRecorder
Turning Off Transient Order Tracking
Customizations and Extensions
Defining Additional Types of Abandoned and Lost Orders
Modifying the Criteria Used to Identify Abandoned and Lost Orders
Generating Invoices
Invoice Overview
Invoices in Checkout
Invoice Payment
Using the Invoice Manager
Invoice Pipelines
The Invoice Repository
Invoice Repository Item
DeliveryInfo Repository Item
PaymentTerms Repository Item
Sending Invoice JMS Messages
Using Requisitions and Contracts
Requisitions
Contract Repository Items
Using Contracts
Preparing to Use Commerce Reporting
Setting Up Commerce Reporting Environments
Setting up the Asset Management Environment
Setting Up the Production Environment
Setting Up the Data Loading Environment
Configuring a Parent Catalog
Logging Data for Commerce Reporting
Site Visit Data Logging
Order Submit Data Logging
Commerce Search Data Logging
Product Catalog Data Logging
User Data Logging
Segment Data Logging
Data Logging Configuration
Initial Data Logging for Catalogs, Users, and Segments
JMS Message Information for Data Logging
Loading Data for Commerce Reporting
Data Loader Components
Data Warehouse Loader Repository
Handling Errors
Pipeline Drivers and Processors
Customizing Reporting Data
Adding an Attribute to a Dimension
Adding a New Dimension
Dimension Converters
Conversion Context
Setting Conversion Property Parameters
Example Dimension Converter
Web Services
Order Management Web Services
addCreditCardToOrder Web Service
addItemToOrder Web Service
addItemToShippingGroup Web Service
addShippingAddressToOrder Web Service
cancelOrder Web Service
createOrder Web Service
createOrderForUser Web Service
createOrderFromXML Web Service
getCurrentOrderId Web Service
getDefaultPaymentGroupId Web Service
getDefaultShippingGroupId Web Service
getOrderAsXML Web Service
getOrdersAsXML Web Service
getOrderStatus Web Service
moveItemBetweenShippingGroups Web Service
removeCreditCardFromOrder Web Service
removeItemFromOrder Web Service
removeItemQuantityFromShippingGroup Web Service
removePaymentGroupFromOrder Web Service
removeShippingGroupFromOrder Web Service
setItemQuantity Web Service
setOrderAmountToPaymentGroup Web Service
submitOrderWithReprice Web Service
Order Management Web Services Example
Pricing Web Services
calculateOrderPrice Web Service
calculateOrderPriceSummary Web Service
calculateItemPriceSummary Web Service
Pricing Web Services Example
Promotion Web Services
claimCoupon Web Service
getPromotionsAsXML Web Service
grantPromotion Web Service
revokePromotion Web Service
Promotion Web Services Example
Inventory Web Services
getInventory Web Service
getInventoryStatus Web Service
setStockLevels Web Service
setStockLevel Web Service
Inventory Web Services Example
Catalog Web Services
catalogItemViewed Web Service
getProductSkusXML Web Service
getProductXMLByDescription Web Service
getProductXMLById Web Service
getProductXMLByRQL Web Service
Catalog Web Services Example
Profile Web Services
getDefaultShippingAddress Web Service
getDefaultBillingAddress Web Service
getDefaultCreditCard Web Service
setDefaultBillingAddress Web Service
setDefaultCreditCard Web Service
setDefaultShippingAddress Web Service
Profile Web Services Example
Commerce Web Services Security
Using the Order Owner Security Policy
Oracle ATG Web Commerce Databases
Core Oracle ATG Web Commerce Functionality Tables
Product Catalog Tables
Commerce Users Tables
Claimable Tables
Shopping Cart Events Table
Inventory Tables
Order Tables
Promotion Tables
User Promotion Tables
Gift List Tables
Price List Tables
Abandoned Order Services Tables
Order Markers Tables
Organizational Tables
User Profile Extensions
Invoice Tables
Contract Tables
Messages
Base Oracle ATG Web Commerce Messages
Fulfillment System Messages
Order and Pricing Messages
Promotion Messages
Abandoned Order Messages
Approval Messages
Invoice Messages
Scenario Recorders
dcs
dcs-analytics
shoppingprocess
Session Backup
Pipeline Chains
Core Commerce Pipelines
updateOrder Pipeline Chain
loadOrder Pipeline Chain
refreshOrder Pipeline Chain
repriceOrderForInvalidation Pipeline Chain
processOrderWithReprice Pipeline Chain
processOrder Pipeline Chain
validateForCheckout Pipeline Chain
validatePostApproval Pipeline Chain
validatePaymentGroupsPostApproval Pipeline Chain
validateNoApproval Pipeline Chain
validatePaymentGroupNoApproval Pipeline Chain
validatePaymentGroup Pipeline Chain
recalcPaymentGroupAmounts Pipeline Chain
repriceOrder Pipeline Chain
repriceAndUpdateOrder Pipeline Chain
moveToConfirmation Pipeline Chain
validatePaymentGroupPreConfirmation Pipeline Chain
moveToPurchaseInfo Pipeline Chain
validateShippingInfo Pipeline Chain
validateShippingGroup Pipeline Chain
sendScenarioEvent Pipeline Chain
processScheduledOrder Pipeline Chain
Fulfillment Pipelines
handleSubmitOrder Pipeline Chain
splitShippingGroupsFulfillment Pipeline Chain
executeFulfillOrderFragment Pipeline Chain
handleModifyOrder Pipeline Chain
performIdTargetModification Pipeline Chain
performOrderModification Pipeline Chain
removeOrder Pipeline Chain
handleModifyOrderNotification Pipeline Chain
handleIdTargetModification Pipeline Chain
handleShipGroupUpdateModification Pipeline Chain
handlePaymentGroupUpdateModification Pipeline Chain
handleShippingGroupModification Pipeline Chain
updateShippingGroup Pipeline Chain
completeRemoveOrder Pipeline Chain
completeOrder Pipeline Chain
handleRelationshipModification Pipeline Chain
updateRelationship Pipeline Chain
handleHardgoodFulfillOrderFragment Pipeline Chain
processHardgoodShippingGroup Pipeline Chain
allocateShippingGroup Pipeline Chain
allocateItemRelationship Pipeline Chain
allocateItemRelQuantity Pipeline Chain
allocateItemRelQuantityForConfigurableItem Pipeline Chain
splitShippingGroupForAvailability Pipeline Chain
handleHardgoodUpdateInventory
handleOrderWaitingShipMap Pipeline Chain
handleHardgoodModifyOrder Pipeline Chain
performHardgoodIdTargetModification Pipeline Chain
performHardgoodShippingGroupModification Pipeline Chain
removeHardgoodShippingGroup Pipeline Chain
removeShipItemRelsFromShipGroup Pipeline Chain
updateHardgoodShippingGroup Pipeline Chain
shippingGroupHasShipped Pipeline Chain
performHardgoodItemModification Pipeline Chain
performHardgoodRelationshipModification Pipeline Chain
handleHardgoodModifyOrderNotification Pipeline Chain
handleHardgoodShipGroupUpdateModification Pipeline Chain
shipPendingShippingGroups Pipeline Chain
shipShippingGroup Pipeline Chain
handleElectronicFulfillOrderFragment Pipeline Chain
processElectronicShippingGroup Pipeline Chain
allocateElectronicGood Pipeline Chain
handleElectronicModifyOrder Pipeline Chain
handleElectronicModifyOrderNotification Pipeline Chain
handleElectronicShipGroupUpdateModification Pipeline Chain
sendOrderToFulfiller Pipeline Chain
processHardgoodShippingGroups Pipeline Chain
retrieveWaitingShipMap Pipeline Chain
processElectronicShippingGroups Pipeline Chain
Order Approval Pipelines
approveOrder Pipeline Chain
checkRequiresApproval Pipeline Chain
orderApproved Pipeline Chain
orderRejected Pipeline Chain
checkApprovalComplete Pipeline Chain
checkApprovalCompleteError Pipeline Chain
Reporting Pipelines
Index
Search Terms