getProductXMLByRQL Web Service

getProductXMLByRQL Web Service

The getProductXMLByRQL Web service parses the pRQLQuery and executes the RqlStatement to retrieve the product items. Product repository items are checked against specified catalog to include only items present in catalog.

Servlet name	`getProductXMLByRQL`
Input Parameters	`RQLQuery` - RQL query string to execute against product `RepositoryView`. `catalogId` - (Optional) The catalog item to verify the product. This is only relevant if using custom catalogs. If using custom catalogs, and this parameter is null, then the current users catalog will be used.
Output	An array of strings containing product repository items in XML format.
Web Service Class	`atg.commerce.catalog.CatalogServices`
Nucleus Component	`/atg/commerce/catalog/CatalogServices`
Method	`getProductXMLByRQL(String pRQLQuery, String pCatalogId)`
Executes within a session	Yes
WSDL URL	`http://``hostname:port``/commerce/catalog/getProductXMLByRQL?WSDL`
Endpoint URL	`http://``hostname:port``/commerce/catalog/getProductXMLByRQL/getProductXMLByRQL`
Security `FunctionalName`	`Catalog`
Repository Component	`/atg/commerce/catalog/ProductCatalog`
Item Descriptor	`product`

Contents
Search

loading table of contents...

Introduction
- Commerce Overview
- Finding What You Need
- In This Guide
Configuring and Populating a Production Database
- Configuring ATG Commerce with CIM
- Creating Database Tables
- Using ATG Commerce with an Oracle Database
  - Configuring Storage Parameters
  - Configuring a Catalog for Oracle Full Text Searching
- Using ATG Commerce with an MSSQL Database
- Transferring Product Catalog and Price List Data Using Copy and Switch
- Transferring Demo Data
  - Exporting the Demo Data from SOLID
  - Importing the Demo Data to Your Database
- Destroying Database Tables for ATG Commerce
Using and Extending the Standard Catalog
- Catalog Repository
- Categories and Products
- SKU Items and SKU Links
- Folders and Media Items
- Designing a Multi-Locale Product Catalog
Using Custom Catalogs
- Using ATG Commerce with Custom Catalogs
- Converting from Standard to Custom Catalogs
- The Custom Catalog Repository
- Custom Catalog Security
- Custom Catalog Navigation
  - Looking Up Items in the Catalog
  - Using the parentCategory Property
- Custom Catalog Searching
- Assigning a Custom Catalog to a User
Using the Catalog Maintenance System
- Batch Services
- Dynamic Services
ATG Commerce Profile Extensions
- Profile Repository Extensions
- Profile Form Handler Extensions
- Profile Tools and Property Manager Extension
Configuring Merchandising Services
- Setting Up Gift Lists and Wish Lists
- Setting Up Product Comparison Lists
- Setting Up Gift Certificates and Coupons
Using and Extending Pricing Services
- Overview of Pricing Services
- Public Pricing Interfaces and Classes
- Default Pricing Engines
- Default Pricing Calculators
- Extending and Creating Pricing Engines
- Extending and Creating Pricing Calculators
  - Adding a New Pricing Calculator
  - Extending Calculators
- Extending the Qualifier Class
- Creating Promotions
- Using Price Lists
Working With Purchase Process Objects
- The Purchase Process Subsystems
- Creating Commerce Objects
- Using Relationship Objects
- 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
- ATG Commerce States
- Purchase Process Class Diagrams
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
- Processing Payment of Orders
- Scheduling Recurring Orders
- Setting Restrictions on Orders
  - Understanding the Order Restriction Classes
  - Implementing Order Restrictions
- Tracking the Shopping Process
- Troubleshooting Order Problems
- Handling Returned Items
- Working with ATG Commerce Form Handlers
  - Managing Transactions in the ATG Commerce Form Handlers
  - Extending the ATG Commerce Form Handlers
Customizing the Purchase Process Externals
- Purchase Process Event Messages
- Integrating with Purchase Process Services
  - Purchase Process Integration Points
  - Adding Credit Card Types to ATG Commerce
- Extending the Purchase Process
- Merging Orders
Processor Chains and the Pipeline Manager
- Pipeline Manager Overview
- Using the Pipeline Editor
- Running a Processor Chain
- Creating a Processor Pipeline
- Pipelines and Transactions
  - Processor Transaction Management
  - Spanning Transactions over a Chain Subset
- Extending the Processor Pipeline Classes
- Adding a Commerce Processor Using XML Combination
  - Executing Processor Chains from Processors within Other Chains
- Commerce Processor Chains
Inventory Framework
- Overview of the Inventory System
  - Using the Inventory System
- Inventory System Methods
- Inventory Classes
- InventoryManager Implementations
- Examples of Using the Inventory Manager
- 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
- Fulfillment Pipelines
  - Descriptions and Diagrams of Fulfillment Pipelines
- 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
- Pipeline Chains in the Order Approval Process
- JMS Messages in the Order Approval Process
Using Abandoned Order Services
- An Overview of Abandoned Orders
- 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
- Customizations and Extensions
  - Defining Additional Types of Abandoned and Lost Orders
  - Modifying the Criteria Used to Identify Abandoned and Lost Orders
Generating Invoices
- Overview
- Invoices in Checkout
- Invoice Payment
- The Invoice Repository
Using Requisitions and Contracts
- Requisitions
- Contract Repository Items
- Using Contracts
Preparing to Use Commerce Reporting
- Setting Up Commerce Reporting Environments
- Configuring a Parent Catalog
- Logging Data for Commerce Reporting
- Loading Data for Commerce Reporting
Customizing Reporting Data
- Adding an Attribute to a Dimension
- Adding a New Dimension
ATG Commerce Web Services
- Order Management Web Services
- Pricing Web Services
- Promotion Web Services
- Inventory Web Services
- Catalog Web Services
- Profile Web Services
- Commerce Web Services Security
  - Using the Order Owner Security Policy
ATG Commerce and Session Backup
ATG Commerce Databases
- Core ATG Commerce Functionality Tables
- ATG Business Commerce Tables
ATG Commerce Messages
- Base ATG Commerce Messages
  - Fulfillment System Messages
- Abandoned Order Messages
- ATG Business Commerce Messages
ATG Commerce Scenario Recorders
- dcs
- dcs-analytics
- shoppingprocess
Index