Om API
Om API
April 2007
Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide, Release 12
Contributing Author: Alok Singh, Pravin Nair, Rakesh Moharana, Sasi Erla, Anjana Ramachandran
The Programs (which include both the software and documentation) contain proprietary information; they
are provided under a license agreement containing restrictions on use and disclosure and are also protected
by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or
decompilation of the Programs, except to the extent required to obtain interoperability with other
independently created software or as specified by law, is prohibited.
The information contained in this document is subject to change without notice. If you find any problems in
the documentation, please report them to us in writing. This document is not warranted to be error-free.
Except as may be expressly permitted in your license agreement for these Programs, no part of these
Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any
purpose.
If the Programs are delivered to the United States Government or anyone licensing or using the Programs on
behalf of the United States Government, the following notice is applicable:
The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently
dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup,
redundancy and other measures to ensure the safe use of such applications if the Programs are used for such
purposes, and we disclaim liability for any damages caused by such use of the Programs.
The Programs may provide links to Web sites and access to content, products, and services from third parties.
Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all
risks associated with the use of such content. If you choose to purchase any products or services from a third
party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality
of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party,
including delivery of products or services and warranty obligations related to purchased products or services.
Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third
party.
Oracle, JD Edwards, PeopleSoft, and Siebel are registered trademarks of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective owners.
Contents
Preface
iii
Business Object for Pricing Formulas Application Program Interface..................................2-87
Functional Overview......................................................................................................... 2-87
Setting Up and Parameter Descriptions............................................................................. 2-88
Validation of Business Object for Pricing Formulas API....................................................2-99
Example of Pricing Formulas API...................................................................................... 2-99
Business Object for Pricing Limits Application Program Interface.................................... 2-100
Functional Overview....................................................................................................... 2-100
Setting Up and Parameter Descriptions........................................................................... 2-101
Validation of Limits Public API....................................................................................... 2-118
Example of Limits Public API.......................................................................................... 2-119
Create Publish Price Book Application Program Interface.................................................. 2-119
Functional Overview....................................................................................................... 2-119
Setting Up and Parameter Descriptions........................................................................... 2-120
Validation of Create Publish Price Book API................................................................... 2-123
Examples of Create_Publish_Price_Book API.................................................................. 2-126
Get Currency Application Program Interface....................................................................... 2-126
Functional Overview....................................................................................................... 2-126
Setting Up and Parameter Descriptions........................................................................... 2-126
Validation of Get_Currency API...................................................................................... 2-127
Get Custom Price Application Program Interface................................................................ 2-128
Functional Overview....................................................................................................... 2-128
Setting Up and Parameter Descriptions........................................................................... 2-128
Validation of Get Custom Price API................................................................................ 2-130
Get Price Book Application Program Interface ................................................................... 2-133
Functional Overview....................................................................................................... 2-133
Setting Up and Parameter Descriptions .......................................................................... 2-134
Validation of Get Price Book API..................................................................................... 2-144
Examples of Get_Price_Book API.................................................................................... 2-145
Get Price List Application Program Interface.......................................................................2-145
Functional Overview....................................................................................................... 2-145
Setting Up and Parameter Descriptions........................................................................... 2-146
Validation of Get_Price_List API..................................................................................... 2-147
Multi-Currency Conversion Setup Application Program Interface.....................................2-147
Functional Overview....................................................................................................... 2-147
Setting Up and Parameter Descriptions........................................................................... 2-148
Validation of Multi-Currency Conversion API................................................................ 2-156
Example of Multi-Currency Conversion API................................................................... 2-157
Price List Setup Application Program Interface................................................................... 2-157
Functional Overview....................................................................................................... 2-157
Setting Up and Parameter Descriptions........................................................................... 2-159
Validation of Price List Setup API....................................................................................2-178
iv
Example of Price List Setup API...................................................................................... 2-178
Price List Setup Group Application Program Interface....................................................... 2-179
Functional Overview....................................................................................................... 2-179
Setting Up and Parameter Descriptions........................................................................... 2-180
Validation of Price List Group API.................................................................................. 2-199
Price Request Application Program Interface...................................................................... 2-200
Functional Overview....................................................................................................... 2-201
Setting Up and Parameter Descriptions........................................................................... 2-202
Validation of Price Request API....................................................................................... 2-260
Example of Price Request Application Program Interface............................................... 2-260
Pricing Data Bulk Loader API............................................................................................... 2-263
Functional Overview .......................................................................................................2-263
Setting Up and Parameter Descriptions........................................................................... 2-264
Validation of Pricing Data Bulk Loader .......................................................................... 2-265
Examples of Pricing Data Bulk Loader API..................................................................... 2-267
Pricing Object Security - Check Function API..................................................................... 2-275
Functional Overview....................................................................................................... 2-276
Setting Up and Parameter Descriptions........................................................................... 2-276
Validation of Pricing Object Security API........................................................................ 2-278
Pricing Attributes Application Program Interface............................................................... 2-278
Functional Overview....................................................................................................... 2-278
Attribute Mapping Application Program Interface............................................................. 2-291
Functional Overview....................................................................................................... 2-291
Setting Up and Parameter Descriptions........................................................................... 2-291
Validation of Attribute Mapping API.............................................................................. 2-297
Qualifiers Application Program Interface............................................................................ 2-297
Functional Overview....................................................................................................... 2-297
Setting Up and Parameter Descriptions .......................................................................... 2-298
Validation of Qualifiers API.............................................................................................2-315
Example of Qualifiers API............................................................................................... 2-315
Reverse Limits Application Program Interface.................................................................... 2-315
Functional Overview....................................................................................................... 2-316
Setting Up and Parameter Descriptions........................................................................... 2-316
Validation of Reverse Limits API..................................................................................... 2-321
Example of Reverse Limits API........................................................................................2-322
Round Price Application Program Interface........................................................................ 2-323
Functional Overview....................................................................................................... 2-323
Setting Up and Parameter Descriptions........................................................................... 2-324
Validation of Round Price API......................................................................................... 2-325
Validate Price List with Currency Code Application Program Interface............................ 2-325
Functional Overview....................................................................................................... 2-326
v
Setting Up and Parameter Descriptions........................................................................... 2-326
Validation of Validate Price List with Currency Code API.............................................. 2-326
vi
User Procedures............................................................................................................... 4-100
vii
9 Oracle Release Management XML Transactions
Overview of Oracle Release Management XML...................................................................... 9-1
Planning Schedule Transaction................................................................................................ 9-3
Sample Document Type Definition (DTD) and XML for Planning Schedule.......................9-4
Planning Schedule XML to Database Mapping................................................................... 9-9
Shipping Schedule Transaction.............................................................................................. 9-18
Sample Document Type Definition (DTD) and XML for Shipment Schedule....................9-20
Shipping Schedule XML to Database Mapping................................................................. 9-23
viii
Deliveries Public Application Program Interface................................................................ 12-59
Create_Update_Delivery API Features............................................................................ 12-59
Functional Overview................................................................................................. 12-59
Delivery_Action API Features......................................................................................... 12-70
Functional Overview................................................................................................. 12-70
Generate_Documents API Features................................................................................. 12-76
Functional Overview................................................................................................. 12-76
Setting Up the Generate_Documents API........................................................................ 12-77
Exceptions Application Program Interface........................................................................... 12-78
Exception_Action API Features....................................................................................... 12-78
Functional Overview................................................................................................. 12-78
Setting Up the Exception_Actions API............................................................................ 12-79
Get_Exceptions API Features........................................................................................... 12-87
Functional Overview................................................................................................. 12-87
Setting Up the Get_Exceptions API..................................................................................12-87
Delivery Details Public Application Program Interface...................................................... 12-89
Detail_To_Delivery API Features.................................................................................... 12-90
Functional Overview................................................................................................. 12-90
Split_Line API Features................................................................................................... 12-92
Functional Overview................................................................................................. 12-92
Update_Shipping_Attributes API Features..................................................................... 12-95
Functional Overview................................................................................................. 12-95
Autocreate_Deliveries API Features.............................................................................. 12-107
Autocreate_Del_Trip API Features................................................................................ 12-109
Get_Detail_Status API Features..................................................................................... 12-111
Functional Overview............................................................................................... 12-111
Update_Shipping_Attributes (overloaded version) API................................................ 12-113
Functional Overview............................................................................................... 12-113
Init_Changed_Attribute_Rec API Features.................................................................... 12-125
Functional Overview............................................................................................... 12-125
AUTOCREATE_DEL_TRIP (overloaded version) API Features.................................... 12-136
Functional Overview............................................................................................... 12-136
Container Public Application Program Interface............................................................... 12-138
Create_Containers API Features.................................................................................... 12-139
Functional Overview............................................................................................... 12-139
Update Container API Features..................................................................................... 12-142
Functional Overview............................................................................................... 12-142
Auto_Pack API Features................................................................................................ 12-149
Functional Overview............................................................................................... 12-149
Container_Actions API Features.................................................................................... 12-152
Functional Overview............................................................................................... 12-152
ix
Freight Costs Public Application Program Interface..........................................................12-155
Create_Update_Freight_Costs API Features.................................................................. 12-155
Functional Overview............................................................................................... 12-155
Validate_Freight_Cost_Type API Features.................................................................... 12-161
Delete_Freight_Costs API Features................................................................................ 12-162
Functional Overview............................................................................................... 12-162
Pick Release Application Program Interface...................................................................... 12-167
Create_Batch API Features.............................................................................................12-168
Functional Overview............................................................................................... 12-168
Release_Batch API Features........................................................................................... 12-179
Functional Overview............................................................................................... 12-179
Get_Batch_Record API Features.................................................................................... 12-181
Functional Overview............................................................................................... 12-181
Document Public Application Program Interface.............................................................. 12-193
Functional Overview..................................................................................................... 12-193
Custom Public Application Program Interface.................................................................. 12-199
UI_Location_Code API Features.................................................................................... 12-199
Functional Overview............................................................................................... 12-199
Calculate_TP_Dates API Features.................................................................................. 12-203
Functional Overview............................................................................................... 12-203
Example of API Packages and Procedures.......................................................................... 12-204
x
Sample XML Transactions for Third Party Warehousing................................................ 13-98
Using XML Messaging with International Trade Management........................................ 13-176
ItemSynchronization Request Transaction for ITM....................................................... 13-176
PartySynchronization Request Transaction for ITM...................................................... 13-177
OrderCompliance Request for ITM................................................................................13-177
DeliveryCompliance Request Transaction for ITM........................................................ 13-177
ExportCompliance Response Transaction for ITM........................................................ 13-178
Overview of XML and DTD for ITM............................................................................. 13-179
ITM DTDs...................................................................................................................... 13-179
Sample ITM XML Transactions......................................................................................13-187
xi
Send Us Your Comments
Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide, Release 12
Part No. B31585-01
Oracle welcomes customers' comments and suggestions on the quality and usefulness of this document.
Your feedback is important, and helps us to best meet your needs as a user of our products. For example:
• Are the implementation steps correct and complete?
• Did you understand the context of the procedures?
• Did you find any errors in the information?
• Does the structure of the information help you with your tasks?
• Do you need different information or graphics? If so, where, and in what format?
• Are the examples correct? Do you need more examples?
If you find any errors or have any other suggestions for improvement, then please tell us your name, the
name of the company who has licensed our products, the title and part number of the documentation and
the chapter, section, and page number (if available).
Note: Before sending us your comments, you might like to check that you have the latest version of the
document and if any concerns are already addressed. To do this, access the new Applications Release
Online Documentation CD available on Oracle MetaLink and www.oracle.com. It contains the most
current Documentation Library plus all documents revised or released recently.
Send your comments to us using the electronic mail address: [email protected]
Please give your name, address, electronic mail address, and telephone number (optional).
If you need assistance with Oracle software, then please contact your support representative or Oracle
Support Services.
If you require training or instruction in using Oracle software, then please contact your Oracle local office
and inquire about our Oracle University offerings. A list of Oracle offices is available on our Web site at
www.oracle.com.
xiii
Preface
Intended Audience
Welcome to Release 12 of the Oracle Order Management Open Interfaces, API, & Electronic
Messaging Guide.
This guide assumes you have a working knowledge of the following:
• The principles and customary practices of your business area.
• The Oracle Applications graphical user interface. To learn more about the Oracle
Applications graphical user interface, read the Oracle Applications User's Guide.
See Other Information Sources for more information about Oracle Applications product
information.
See Related Information Sources on page xvi for more Oracle Applications product
information.
Documentation Accessibility
Our goal is to make Oracle products, services, and supporting documentation
accessible, with good usability, to the disabled community. To that end, our
documentation includes features that make information available to users of assistive
technology. This documentation is available in HTML format, and contains markup to
facilitate access by the disabled community. Accessibility standards will continue to
evolve over time, and Oracle is actively engaged with other market-leading technology
xv
vendors to address technical obstacles so that our documentation can be accessible to all
of our customers. For more information, visit the Oracle Accessibility Program Web site
at http://www.oracle.com/accessibility/ .
Structure
1 Integrating Your Systems
2 Oracle Advanced Pricing Open Interfaces and APIs
3 Oracle Advanced Pricing XML Transactions
4 Oracle Order Management XML Transactions: Implementation Considerations
5 Oracle Order Management XML Transactions
6 Oracle Order Management EDI Transactions
7 Oracle Order Management Open Interfaces and APIs
8 Oracle Order Management: Integration with Other Products
9 Oracle Release Management XML Transactions
10 Oracle Release Management EDI Transactions
11 Oracle Release Management Open Interfaces and APIs
12 Oracle Shipping Execution Open Interfaces and APIs
13 Oracle Shipping Execution XML Transactions
14 Oracle Shipping Execution EDI Transactions
A Oracle Order Management Error and Information Messages
xvi
Oracle Configure to Order Process Guide
Oracle Shipping Execution User's Guide
Oracle Advanced Pricing Implementation Manual
Oracle Advanced Pricing User's Guide
Oracle Release Management Implementation Manual
Oracle Release Management User's Guide
Oracle Applications Multiple Organizations Implementation Guide
Integration Repository
The Oracle Integration Repository is a compilation of information about the service
endpoints exposed by the Oracle E-Business Suite of applications. It provides a
complete catalog of Oracle E-Business Suite's business service interfaces. The tool lets
users easily discover and deploy the appropriate business service interface for
integration with any system, application, or business partner.
The Oracle Integration Repository is shipped as part of the E-Business Suite. As your
instance is patched, the repository is automatically updated with content appropriate
for the precise revisions of interfaces in your environment.
xvii
1
Integrating Your Systems
• Connect to external systems such as the customer's purchasing system and the
supplier's order entry system to better integrate the supply chain via electronic
commerce.
Interface Tables
Interface tables in Oracle Order Management applications provide a temporary storage
area for loading information from an external source. After the information is loaded,
concurrent programs are executed to validate the information and then apply the
information to the base product tables.
The benefit of an interface table is that it provides a repository where records can be
processed and if errors are found, you can edit the records and resubmit them.
In the Oracle Order Management family of applications you should never write directly
to the product tables. An Oracle Applications validation step is always required. You
may achieve this either by loading information into the interface tables and submitting
a provided concurrent program to validate and process the information or by using a
function call to a programmatic interface.
1-2 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide
Interface Views (Business Views)
Views simplify the data relationships for easier processing, whether for reporting or
data export. Oracle Order Management products have defined business views that
identify areas of key business interest. You can access this data using a tool of your
choice. The OE_ORDER_HEADERS_BV is an example of a key business view.
Table Key
Key Description
Interface/API Data Flow Table, View, Iface Man TRM Table, View,
Name Direction Process, or Module
Procedure Name, or
Procedure
Name
OE_LINES_IF
ACE_ALL
OE_RESERV
TNS_IFACE_
ALL
OE_CREDITS
_IFACE_ALL
OE_PRICE_A
DJS_IFACE_
ALL
OE_LOTSERI
ALS_IFACE_
ALL
OE_ACTION
S_IFACE_AL
L
QP QP QP QP QP QP
1-4 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide
Interface/API Data Flow Table, View, Iface Man TRM Table, View,
Name Direction Process, or Module
Procedure Name, or
Procedure
Name
OE_PRICING
_CONT_PUB.
LOCK_AGRE
EMENT
QP_MODIFI
ERS_PUB.LO
CK_MODIFI
ERS
QP_PRICE_F
ORMULA_P
UB.GET_PRI
CE_FORMUL
A
QP_LIMITS_
PUB.LOCK_L
IMITS
1-6 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide
Interface/API Data Flow Table, View, Iface Man TRM Table, View,
Name Direction Process, or Module
Procedure Name, or
Procedure
Name
QP_PRICE_L
IST_PUB.GET
_PRICE_LIST
QP_PRICE_L
IST_PUB.LO
CK_PRICE_L
IST
1-8 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide
Interface/API Data Flow Table, View, Iface Man TRM Table, View,
Name Direction Process, or Module
Procedure Name, or
Procedure
Name
QP_QUALIFI
ER_RULES_P
UB.LOCK_Q
UALIFIER_R
ULES
QP_QUALIFI
ER_RULES_P
UB.GET_QU
ALIFIER_RU
LES
QP_QUALIFI
ER_RULES_P
UB.COPY_Q
UALIFIER_R
ULES
1-10 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide
Interface/API Data Flow Table, View, Iface Man TRM Table, View,
Name Direction Process, or Module
Procedure Name, or
Procedure
Name
1-12 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide
Components of an Open Interface
The components described below are common to most open interfaces. Please note that
the component may be implemented slightly differently than described below.
Source Application
A source application may be an external system or another module in the e-Business
Suite. Data may be processed and stored in a source application.
Destination Application
A destination application may be an external system or another module in the
e-Business Suite. You send data to a destination application so that the application can
perform further processing and storage.
Interface Table
For inbound interfaces, the interface table is the intermediary table where the data from
Control Columns
Control columns track the status of each row in the interface table as it is inserted,
validated, processed with or without errors, and ultimately deleted. Additional control
columns identify who last updated the row and the last update date.
Data Columns
Data columns store the specific attributes that the source application is sending to the
Oracle Order Management products.
Required Columns
Required columns store the minimum information needed by the Oracle Order
Management products to successfully process the interface row.
Some columns are conditionally required based on the specifics of the interface.
Derived Columns
Derived columns are created by the destination application from information in the
required columns. Derived columns are usually required columns that need to contain a
value so that processing may continue.
Optional Columns
The data in optional columns is not mandatory for transaction processing to take place,
however the optional columns may be useful for storing additional information.
Errors Table
For inbound interfaces, the errors table stores all errors generated by the validation and
processing functions. You can either handle multiple error rows or single rows to
resolve the errors.
Database View
Database views are database objects that enable users of destination applications to look
1-14 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide
at source application data.
Oracle Order Management products provide predefined views of key data that is likely
to be used by destination applications.
For example, Oracle Cost Management provides work in process valuation and
transaction distribution database views for use by other cost reporting destination
products.
Load Function
For inbound interfaces, the load function is the set of programs that selects and
accumulates data from the source application and inserts it into Oracle Order
Management interface tables. The programming languages and tools used in the load
function are highly dependent on the hardware and system software of the source
application.
For example, if you are passing data between an Oracle based source application and an
Oracle destination application, you would likely use a tool such as Pro*C or PL/SQL
since these tools work in both environments. If you are bringing data from a non-Oracle
based application into a product interface table, you would likely use a procedural
language available on the source application to select the data and convert it into an
ASCII file. Then you could use SQL*Loader to insert that file into the destination
product's interface table.
For outbound interfaces, the load function is the SQL that creates the database view.
Validate Function
The validate function is the set of programs that Oracle Applications destination
products use to ensure the integrity of inbound data. In the source application, you can
typically validate data upon entry using techniques such as forms triggers, not null
columns, data types, and so on. However, since Oracle Applications products may not
be the source of this data, validation programs ensure data integrity.
In addition, the validate function can derive additional columns based on the required
columns and foreign key relationships with data elsewhere in the Oracle destination
application.
The validation programs check the interface table for rows requiring validation, and the
programs validate and update each row indicating whether validation is complete or if
errors were found. If errors were found, validation programs need to write errors to the
error table of the destination application.
When the source application is a product in the e-Business Suite, the destination
application should provide the validate function.
Process Function
The process function is a set of programs that processes the data from the interface table
Maintain Function
The maintain function is generally accomplished from a window within an Oracle
application. Most of these windows allow you to query, update, and resubmit interface
records that have failed validation. In general you can use these windows to query
unprocessed or unvalidated rows to check their current status.
When the maintain function is not called explicitly, you can use SQL*Plus to query and
update the interface table rows that are in error.
When the source application is a product in the e-Business Suite, the destination
application should provide the maintain function.
1-16 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide
2
Oracle Advanced Pricing Open Interfaces
and APIs
Drv Derived
Req Required
Functional Overview
Process_Agreement processes inserts, updates, and deletes records related to
agreements.
2-2 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide
PROCESS_AGREEMENT
The following table shows the parameters for this structure.
PROCESS_AGREEMENT Parameters
p_api_version_n IN Number No No
umber
p_init_msg_list IN Varchar2 No No
p_return_values IN Varchar2 No No
p_commit IN Varchar2 No No
p_Agreement_re IN Agreement_Rec_ No No
c Type
p_Agreement_va IN Agreement_Val_ No No
lue_rec Rec_Type
p_Price_LHeade IN QP_Price_List_P No No
r_rec UB.Price_List_Re
c_Type
p_Price_LHeade IN QP_Price_List_P No No
r_val_rec UB.Price_List_V
al_Rec_Type
p_Price_LLine_t IN QP_Price_List_P No No
bl UB.Price_List_Li
ne_Tbl_Type
p_Price_LLine_v IN QP_Price_List_P No No
al_tbl UB.Price_List_V
al_Tbl_Type
p_Pricing_Attr_t IN QP_Price_List_P No No
bl UB.Pricing_Attr_
Tbl_Type
p_Pricing_Attr_v IN QP_Price_List_P No No
al_tbl UB.Pricing_Attr_
Val_Tbl_Type
AGREEMENT_REC_TYPE
The following table shows the parameters for this structure.
2-4 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide
REC_TYPE
2-6 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide
Parameter Usage Type Req Drv