P. 1
Om API

Om API

|Views: 35|Likes:
Published by Avinandan Saha

More info:

Published by: Avinandan Saha on Jul 11, 2011
Copyright:Attribution Non-commercial

Availability:

Read on Scribd mobile: iPhone, iPad and Android.
download as PDF, TXT or read online from Scribd
See more
See less

07/11/2011

pdf

text

original

Oracle Order Management Suite APIs and Open Interfaces Manual

Volume 1

Release 11i

March 2001 Part No. A88868-01

Oracle© Order Management Suite APIs and Open Interfaces Manual, Release 11i Part No. A88868-01 Copyright © 1999, 2001 Oracle Corporation. All rights reserved. Contributing Authors: Contributors: Elizabeth Looney, Tom Myers, John Salvini, James Siri,

David Reitan

The programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be licensee's responsibility to take all appropriate fail-safe, back up, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and Oracle disclaims liability for any damages caused by such use of the Programs. This Program contains proprietary information of Oracle Corporation; it is provided under a license agreement containing restrictions on use and disclosure and is also protected by copyright, patent and other intellectual property law. Reverse engineering of the software is prohibited. Program Documentation is licensed for use solely to support the deployment of the Programs and not for any other purpose. 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. Oracle Corporation does not warrant that this document is error free. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Oracle Corporation If this Program is delivered to a U.S. Government Agency of the Department of Defense, then it is delivered with Restricted Rights and the following legend is applicable: Restricted Rights Legend Programs delivered subject to the DOD FAR Supplement are “commercial computer software” and use, duplication and disclosure of the Programs shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement. Otherwise, Programs delivered subject to the Federal Acquisition Regulations are “restricted computer software” and use, duplication and disclosure of the Programs shall be subject to the restrictions in FAR 52.227-14, Rights in Data -- General, including Alternate III (June 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA 94065. Oracle is a registered trademark, and Oracle Applications, Oracle Inventory, Oracle EDI Gateway, Oracle Payables, Oracle Purchasing, Oracle Self-Service Purchasing, Oracle Self-Service Web Applications, Context, Financial Analyzer, Oracle7, Oracle8, Oracle Alert, Oracle Applications, Oracle Discoverer, Oracle Financials, Object Library, Oracle Work in Process, Oracle Workflow, SmartClient, PL/SQL, SQL*Calc, SQL*Forms, SQL*Loader, SQL*Menu, SQL*Net, SQL*Plus, SQL*Report, SQL*ReportWriter, Oracle Web Employees, and SQL*QMX are trademarks or registered trademarks of Oracle Corporation. Windows NT is a registered trademark of Microsoft Corporation. All other company or product names mentioned are used for identification purposes only and may be trademarks of their respective owners.

Contents
Send Us Your Comments ................................................................................................................... ix Preface............................................................................................................................................................ xi
About This Manual.......................................................................................................................... Audience for This Manual............................................................................................................. Do Not Use Database Tools to Modify Oracle Applications Data .......................................... Other Information Sources............................................................................................................ xi xii xii xii

1

Integrating Your Systems
Overview of Oracle Order Management APIs and Open Interfaces........................................ Basic Business Needs ................................................................................................................... Oracle Manufacturing Interfaces................................................................................................ Inbound Open Interface Model ................................................................................................ Components of an Open Interface ........................................................................................... 1-2 1-2 1-2 1-10 1-12

2 Oracle Order Management Open Interface
HEADERS INTERFACE .................................................................................................................... LINES INTERFACE.......................................................................................................................... PRICE ADJUSTMENT INTERFACE ............................................................................................ SALES CREDITS INTERFACE...................................................................................................... RESERVATION INTERFACE ......................................................................................................... ACTIONS INTERFACE................................................................................................................... 2-2 2-21 2-46 2-53 2-57 2-59

iii

LOTSERIAL INTERFACE............................................................................................................... Calling The Sales Order Form From Other Modules ................................................................ Overview...................................................................................................................................... Integrating Oracle Order Management Using Order Import................................................... Integrating Oracle Order Management with Oracle Receivables for Invoicing ................ Basic Needs ................................................................................................................................ Major Features........................................................................................................................... Invoicing of ATO Configurations........................................................................................... Understanding the Interface Tables ....................................................................................... RA_INTERFACE_SALESCREDITS ....................................................................................... Oracle Order Management Process Order API ......................................................................... Process Order API Features ................................................................................................... Functional Overview................................................................................................................ Processing the Sales Order business object........................................................................... ............................................................................. Setting Up the Process_Order Procedure Setting Up the Get_Order Procedure..................................................................................... Setting Up the Lock_Order Procedure .................................................................................. PL/SQL Record Structures...................................................................................................... Usage ..........................................................................................................................................

2-63 2-66 2-66 2-68 2-124 2-124 2-124 2-131 2-132 2-148 2-151 2-151 2-162 2-162 2-166 2-175 2-179 2-185 2-224

3 Oracle Pricing Open Interfaces
Formula Calculation Application Program Interface .................................................................. Formula Calculation API Features ............................................................................................. Functional Overview.................................................................................................................... Setting Up the Formula Calculation API................................................................................... Validation of Formula Calculation API..................................................................................... Update Formula Prices Application Program Interface .............................................................. Update Formula Prices API Features......................................................................................... Functional Overview.................................................................................................................... Setting Up the Update Formula Prices API .............................................................................. Validation of Update Formula Prices API ................................................................................ Copy Price List Application Program Interface ............................................................................ Copy Price List API Features ...................................................................................................... Functional Overview.................................................................................................................... 3-2 3-2 3-2 3-2 3-4 3-6 3-6 3-6 3-6 3-7 3-8 3-8 3-8

iv

Setting Up the Copy Price List API............................................................................................ 3-9 Validation of Copy Price List API ............................................................................................ 3-11 Adjust Price List Application Program Interface ....................................................................... 3-13 Adjust Price List API Features.................................................................................................. 3-13 Functional Overview.................................................................................................................. 3-13 Setting Up the Adjust Price List API ....................................................................................... 3-13 Validation of Adjust Price List API.......................................................................................... 3-14 Business Object for Pricing Formulas Application Program Interface.................................. 3-16 Business Object for Pricing Formulas API Features .............................................................. 3-16 Functional Overview.................................................................................................................. 3-16 Setting Up the Business Object for Pricing Formulas API.................................................... 3-17 Validation of Business Object for Pricing Formulas API...................................................... 3-27 Price Request Application Program Interface............................................................................. 3-29 Price Request API Features ....................................................................................................... 3-29 Functional Overview.................................................................................................................. 3-29 Setting Up the Price Request API............................................................................................. 3-30 Validation of Price Request API ............................................................................................... 3-47 Business Object for Modifier Setup Application Program Interface..................................... 3-49 Business Object for Modifier Setup API Features.................................................................. 3-49 Functional Overview.................................................................................................................. 3-49 Setting Up the Business Object for Modifier Setup API ....................................................... 3-50 Validation of Business Object for Modifier Setup API.......................................................... 3-82 Qualifiers Application Program Interface ................................................................................... 3-83 Qualifiers API Features.............................................................................................................. 3-83 Functional Overview.................................................................................................................. 3-83 Setting Up the Qualifiers API ................................................................................................... 3-84 Validation of Qualifiers API ..................................................................................................... 3-97 Attribute Mapping Application Program Interface ................................................................... 3-98 Attribute Mapping API Features.............................................................................................. 3-98 Functional Overview.................................................................................................................. 3-98 Setting Up the Attribute Mapping API ................................................................................... 3-98 Validation of Attribute Mapping API ................................................................................... 3-107 Price List Setup Application Program Interface ....................................................................... 3-109 Price List Setup API Features.................................................................................................. 3-109 Functional Overview................................................................................................................ 3-109

v

Setting Up the Price List Setup API ....................................................................................... 3-110 Validation of Formula Calculation API................................................................................. 3-121

4 Release Management Open Interface
Understanding the Interface Tables ................................................................................................ RLM_INTERFACE_HEADERS_ALL ........................................................................................ Column Descriptions ......................................................................................................................... RLM_INTERFACE_LINES_ALL.................................................................................................... Column Descriptions.................................................................................................................. 4-2 4-2 4-5 4-13 4-24

5 Oracle Shipping Execution 11i Public APIs
Trip Public Application Program Interface.................................................................................... Create_Update_Trip API Features ............................................................................................. Functional Overview.................................................................................................................... Trip_Action API Features............................................................................................................ Functional Overview.................................................................................................................... Stop Public Application Program Interface................................................................................. Create_Update_Stop API Features........................................................................................... Functional Overview.................................................................................................................. Stop_Action API Features ......................................................................................................... Functional Overview.................................................................................................................. Deliveries Public Application Program Interface ...................................................................... Create_Update_Delivery API Features ................................................................................... Functional Overview.................................................................................................................. Delivery_Action API Features .................................................................................................. Functional Overview.................................................................................................................. Delivery Details Public Application Program Interface ........................................................... Detail_To_Delivery API Features............................................................................................. Functional Overview.................................................................................................................. Split_Line API Features ............................................................................................................. Functional Overview.................................................................................................................. Update_Shipping_Attributes API Features ............................................................................ Functional Overview.................................................................................................................. Autocreate_Deliveries API Features ........................................................................................ 5-2 5-2 5-2 5-8 5-8 5-11 5-11 5-11 5-18 5-18 5-21 5-21 5-21 5-32 5-32 5-39 5-39 5-39 5-43 5-43 5-46 5-46 5-54

vi

Autocreate_Del_Trip API Features.......................................................................................... Container Public Application Program Interface....................................................................... Create_Container API Features ................................................................................................ Functional Overview.................................................................................................................. Update Container API Features ............................................................................................... Functional Overview.................................................................................................................. Auto_Pack API Features............................................................................................................ Functional Overview.................................................................................................................. Container_Actions API Features .............................................................................................. Functional Overview.................................................................................................................. Freight Costs Public Application Program Interface................................................................. Create_Update_Freight_Costs API Features .......................................................................... Functional Overview.................................................................................................................. Validate_Freight_Cost_Type API Features............................................................................. Delete_Freight_Costs API Features ......................................................................................... Functional Overview.................................................................................................................. Examples of APIs used in Simple Shipment Flows................................................................... Package Specification ................................................................................................................. Package Body .............................................................................................................................. Example of a Script...................................................................................................................

5-57 5-60 5-60 5-60 5-64 5-64 5-72 5-72 5-75 5-75 5-78 5-78 5-78 5-85 5-86 5-86 5-92 5-92 5-93 5-103

Index

vii

viii

Send Us Your Comments
Oracle Order Management Suite APIs and Open Interfaces Manual, Release 11i Part No. A88868-01 Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of this publication. Your input is an important part of the information used for revision.
s s s s s

Did you find any errors? Is the information clearly presented? Do you need more information? If so, where? Are the examples correct? Do you need more examples? What features did you like most about this manual?

If you find any errors or have any other suggestions for improvement, please indicate the chapter, section, and page number (if available). You can send comments to us in the following ways:
s s s

E-mail - your_product@us.oracle.com FAX - telephone number. Attn: Oracle Order Management Suite APIs and Open Interfaces Postal service: 3op Oracle Corporation Oracle Order Management Suite APIs and Open Interfaces Documentation 500 Oracle Parkway, 3op Redwood Shores, CA 94065 United States

If you would like a reply, please give your name, address, and telephone number below.

If you have problems with the software, please contact your local Oracle Support Services.

ix

x

Chapter 3 contains information about Oracle Pricing. This manual includes the following chapters: s Chapter 1 gives you an overview of Order Management integration tools and explains how to use these tools to integrate Oracle Manufacturing products with one another and with non-Oracle systems. About This Manual This manual contains information about importing/exporting information using Oracle Applications open interfaces. Chapter 4 contains information about Oracle Release Management. This preface explains how you should use this manual. If you are using an earlier version of the software. Chapter 2 contains information about Oracle Order Management. and defines the notational conventions you need to understand. s s s s xi . Note: This documentation includes open interfaces found in Oracle Order Management Suite Release 11i.Preface This Oracle® Order Management Suite APIs and Open Interfaces Manual. Chapter 5 contains information about Oracle Shipping. please consult your support representative or the Product Update Notes for more specific information about your release. Release 11i contains up-to-date information about integrating with other Oracle Manufacturing applications and with your other systems.

Oracle Applications also keeps track of who changes information. you may store invalid information. you may change a row in one table without making corresponding changes in related tables. Other Information Sources Here are some other ways you can increase your knowledge and understanding of Oracle Manufacturing and Distribution applications. xii . this team should include all levels of individuals including but not limited to: s Project Leaders Systems Analysts Department managers Application Programmers System Programmers System Managers Database Administrators s s s s s s Do Not Use Database Tools to Modify Oracle Applications Data Oracle Applications tables are interrelated and any change you make using Oracle Applications can update several tables at once. we STRONGLY RECOMMEND that you never use SQL*Plus or any other tool to modify Oracle Applications data unless otherwise instructed. In order to effectively implement. But when you modify Oracle Applications data using anything other than Oracle Applications.Audience for This Manual This manual provides you information needed to integrate with other Oracle Manufacturing and Distribution applications and your other systems. If you enter information into database tables using database tools. you risk retrieving erroneous information and you risk unpredictable results throughout Oracle Applications. or when working within an open interface table as described in this manual. Consequently. This manual is intended for the use of the team implementing Oracle Order Management applications. When you use Oracle Applications to modify your data. Oracle Applications automatically checks that your changes are valid. If your tables get out of synchronization with each other. You also lose the ability to track who has changed your information because SQL*Plus and other database tools do not keep a record of changes.

For example.Online Documentation All Oracle Applications documentation is available online on CD-ROM. This guide also includes information on setting user profiles. and paper. a fictional manufacturer of personal computers products and services. as well as running and reviewing reports and concurrent processes. which enables you to search for words and phrases throughout the documentation set. Once any section of the HTML documentation is open. The HTML documentation also ships with Oracle Information Navigator (if your national language supports this tool). There may be slight differences due to publication standards. you can read them online using the Applications Library icon or Help menu command. HyperText Markup Language (HTML) and Adobe Acrobat (PDF). Related User’s Guides Oracle Order Management applications share business and setup information with other Oracle Applications products. As well as including product overviews. Therefore. Technical reference manuals are available in paper only. Oracle Applications Demonstration User’s Guide This guide documents the functional storyline and product flows for Global Computers. context-sensitive section. Oracle Applications User’s Guide This guide explains how to enter data. the book contains detailed discussions and examples across each of the major xiii . There are two online formats. The content of the documentation does not differ from format to format. The HTML documentation is available from all Oracle Applications windows. Each window is programmed to start your web browser and open a specific. you can navigate freely throughout all Oracle Applications documentation. except for technical reference manuals. If you do not have the hardcopy versions of these manuals. you may want to refer to other user’s guides when you are integrating your systems. and navigate using the graphical user interface (GUI) available with this release of Oracle Applications products. but such differences do not affect content. You can access this user’s guide online by choosing ”Getting Started with Oracle Applications” from any Oracle Applications help file. Other documentation is available in Acrobat and paper. Acrobat. page numbers and screen shots are not included in HTML. All user’s guides are available in HTML. query. run reports.

This manual is available in HTML format on the documentation CD-ROM for Release 11i. xiv . illustrations. you can use the Oracle Applications Implementation Wizard to coordinate your setup activities. use this manual before implementing the Oracle Applications product. Oracle Self-Service Web Applications Implementation Manual This manual describes the setup steps for Oracle Self-Service Web Applications and the Web Applications dictionary.product flows. this guide describes all you need to know about setting up and using the product with this feature. Oracle Applications Implementation Wizard User’s Guide If you are implementing more than one Oracle product. Oracle Project Manufacturing Implementation Manual This manual describes the setup steps and implementation for Oracle Project Manufacturing. This manual details additional steps and setup considerations for implementation. Multiple Organizations in Oracle Applications If you use the Oracle Applications Multiple Organization Support feature to use multiple sets of books for one product installation. Reference Manuals Oracle Automotive Implementation Manual This manual describes the setup and implementation of the Oracle Applications used for the Oracle Automotive solution. Multiple Reporting Currencies in Oracle Applications If you use the Multiple Reporting Currencies feature to record transactions in more than one currency. Oracle Applications Message Reference Manual This manual describes all Oracle Applications messages. Installation and System Administration Oracle Alert User’s Guide This guide explains how to define periodic and event alerts to monitor the status of your Oracle Applications data. and charts summarize key flows and data elements. This guide describes how to use the wizard. Tables.

Oracle Manufacturing.Oracle Applications Developer’s Guide This guide contains the coding standards followed by the Oracle Applications development staff. or you can arrange for our trainers to teach at your facility. Oracle Applications Product Update Notes If you are upgrading your Oracle Applications. refer to the product update notes appropriate to your update and product(s) to see summaries of new features as well as changes to database objects. Oracle training professionals can tailor standard courses or develop custom courses to meet your needs. For example. so you take only those courses appropriate to your job or area of responsibility. This manual also provides information on creating custom reports on flexfields data. Oracle Applications System Administrator’s Guide This manual provides planning and reference information for the System Administrator. Oracle Applications Installation Manual for Windows Clients This guide provides information you need to successfully install Oracle Financials. as well as for users responsible for the ongoing maintenance of Oracle Applications product data. You can attend courses offered by Oracle University at any one of our many Education Centers. Refer to this manual and the Oracle Applications Installation Manual when you plan to upgrade your products. In addition. Oracle Applications Flexfields Guide This guide provides flexfields planning. xv . We organize these courses into functional learning paths. Oracle Public Sector Financials. Other Sources Training We offer a complete set of formal training courses to help you and your staff master Oracle Manufacturing applications and reach full productivity quickly. or Oracle Human Resources in your specific hardware and operating system software environment. You have a choice of educational environments. It describes the Oracle Application Object Library components needed to implement the Oracle Applications user interface described in the Oracle Applications User Interface Standards. It also contains information on completing the upgrade procedure for each product. Oracle Applications Upgrade Preparation Manual This guide explains how to prepare your Oracle Applications products for an upgrade. setup and reference information for the implementation team. profile options and seed data added for each new release. It also provides information to help you build your custom Developer/2000 forms so that they integrate with Oracle Applications.

applications development. education. project systems. and support services. Oracle Applications Documentation Manager Oracle Corporation 500 Oracle Parkway xvi . allowing organizations to integrate different computers. and Oracle’s large staff of consultants and support specialists with expertise in your business area. Oracle is the world’s leading supplier of software for information management. At the end of this manual is a Reader’s Comment Form you can use to explain what you like or dislike about Oracle Manufacturing applications or this implementation manual. supply chain management. along with related consulting. decision support. network computers and personal digital assistants. managing an Oracle8 server. minicomputers. terminology. an integrated suite of more than 70 software modules for financial management. different operating systems. different networks. and office automation. and the world’s second largest software company. Account Manager. and applications products. personal computers. our team of experienced professionals provides the help and information you need to keep the product working for you. Thank You Thank you for using Oracle Manufacturing applications and this implementation manual. tools. and even different database management systems. in over 140 countries around the world. About Oracle Oracle Corporation develops and markets an integrated line of software products for database management. unified computing and information resource. This team includes your Technical Representative. We value your comments and feedback. into a single. Mail your comments to the following address or call us directly at (650) 506-7000.you may want to use your organization structure. human resources and sales and service management. manufacturing. Support From on-site support to central support. and your hardware and software environment. and data as examples in a customized training session delivered at your own facility. as well as Oracle Applications. Oracle products are available for mainframes. Oracle offers its database.

A. Or.Redwood Shores. xvii .oracle. send electronic mail to appsdoc@us.S. CA 94065 U.com.

xviii .

Topics covered in this chapter are: s Overview of Oracle Order Management APIs and Open Interfaces on page 1-2 Integrating Your Systems 1-1 . Oracle Manufacturing integration tools are powerful. flexible tools that allow you to capture data from other Oracle applications or your own applications. define necessary format conversions. and direct data to your Oracle Manufacturing products.1 Integrating Your Systems This chapter gives you an overview of Manufacturing integration tools and explains how to use these tools to integrate Oracle Manufacturing products with one another and with your existing non–Oracle systems.

custom and legacy manufacturing systems — to create integrated enterprise wide 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. Review. quality data. update. applications on other computers. Additional technical information on these interfaces is available in each product’s Technical Reference Manual. and resubmit imported data that failed validation. The purpose of this essay is to help you understand the general model Oracle Manufacturing products use for open application interfaces. Validate imported data to ensure integrity of Oracle Manufacturing products. Export data from Oracle Manufacturing products s s s s s s Oracle Manufacturing Interfaces Open Interface Architectures Oracle Manufacturing products have three different methods to import and export data: s Interface Tables 1-2 Oracle Order Management Suite APIs and Open Interfaces Manual . This lets you collect material movement transactions such as receipts. computer-aided design systems. Connect to other systems — such as finite scheduling packages. Other essays in this chapter provide specific information on how to use each of the open interfaces. and even the applications of your suppliers and customers. This speeds data entry and improves transaction accuracy. Control processing of inbound data imported from outside Oracle applications. issues. applications you build. and shipments. movements. Additional functional information on these interfaces is available in each product’s User’s Guide. Basic Business Needs Oracle Manufacturing product APIs and open interfaces provide you with the features you need to support the following basic business needs: s Connect to data collection devices. completions.Overview of Oracle Order Management APIs and Open Interfaces Overview of Oracle Order Management APIs and Open Interfaces Oracle Manufacturing products provide a number of open interfaces so you can link them with non-Oracle applications.

The MTL_ITEM_QUANTITIES_VIEW is an example of a key business view. The view definitions also briefly describe how they are used. normally require some validation through a concurrent program. the addition of views automatically imports data into an existing function. Dynamic Views are views that are dynamically created and re-created as you create and modify collection plans in Oracle Quality.Overview of Oracle Order Management APIs and Open Interfaces s Interface Views (Business Views) Function Calls or Programmatic Interfaces (Processes) s Interface Tables Interface tables. Product views are defined in the Technical Reference Manuals. you can add business specific logic to match configurations (check for duplicate configurations) by modifying the stored procedures provided for this purpose. interfaces do not require an intermediate validation step — you can write directly to the product’s tables after you consult the product’s Technical Reference Manual. Many views. You can access this data using your tool of choice. Dynamic Views have also been added in Oracle Quality. They are not interfaces as much as open integration. Function Calls or Programmatic Interfaces (Processes) Some open interfaces are more fundamental to the architecture of Oracle Manufacturing products. This provides tight integration without adding a batch process to move data. In several instances. have been added specifically for easier reporting. These tables are fully documented in the essays that follow this chapter. In this class of inbound interfaces. Another example is modifying open stored procedures. both inbound and outbound. note flexfield validation by table/view. Integrating Your Systems 1-3 . In the Oracle Bills of Material concurrent program AutoCreate Configuration. For example. Interface Views (Business Views) Views simplify the data relationships for easier processing. Oracle Manufacturing and Distribution products have defined business views that identify certain areas of key business interest. whether for reporting or data export. such as shortage reporting views in Oracle Work in Process.

or Procedure Iface Man Table. Process. View. Current Documentation For Open Interfaces Below are the actual names of the tables. other supplier systems. Outbound means out from Oracle Manufacturing The interface is documented in detail in the Oracle Manufacturing and Distribution Open Interfaces Manual The tables. Contact your Oracle consultant for more information about system integration. Module Name. or TRM Procedure Name Interface/API Name Oracle Inventory Transactions Inbound Table Yes Yes MTL_TRANSACTIONS_INTERFACE MTL_SERIAL_NUMBERS_INTERFACE MTL_TRANSACTION_LOTS_INTERFACE MTL_DEMAND_INTERFACE MTL_ITEM_QUANTITIES_VIEW MTL_USER_SUPPLY MTL_USER_DEMAND MTL_REPLENISH_HEADERS_INT MTL_REPLENISH_LINES_INT MTL_SYSTEM_ITEMS_INTERFACE MTL_ITEMS_REVISIONS_INTERFACE MTL_CI_INTERFACE MTL_CI_XREFS_INTERFACE Demand Interface On-Hand Balances User-Defined Supply User-Defined Demand Replenishment Item Customer Item Customer Item Cross-References Inbound Outbound Inbound Inbound Inbound Inbound Inbound Inbound Table View Table Table Table Table Table Table Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes 1-4 Oracle Order Management Suite APIs and Open Interfaces Manual . views. views. or modules are described in the product’s Technical Reference Manual Table 1–1 Oracle Manufacturing Interfaces/APIs Data Flow Direction Table.Overview of Oracle Order Management APIs and Open Interfaces Summary: Beyond Published Interfaces The Oracle Cooperative Applications Initiative references many third party products which provide import and export capabilities and allow loose to tight integration with legacy systems. View. and so on. and modules: Key Data Flow Direction Iface Man TRM Inbound means into Oracle Manufacturing.

View. Process.Overview of Oracle Order Management APIs and Open Interfaces Table 1–1 Oracle Manufacturing Interfaces/APIs Data Flow Direction Inbound Table. Module Name. View. or Procedure Table Iface Man Yes Table. or TRM Procedure Name Yes MTL_TRANSACTIONS_INTERFACE MTL_SERIAL_NUMBERS_INTERFACE MTL_TRANSACTION_LOTS_ INTERFACE Interface/API Name Material Oracle Engineering / Oracle Bills of Material MFG Calendar Bill of Material Outbound Inbound View Table Yes Yes Yes BOM_CALENDAR_MONTHS_VIEW BOM_BILL_OF_MTLS_INTERFACE BOM_INVENTORY_COMPS_INTERFACE BOM_REF_DESGS_INTERFACE BOM_SUB_COMPS_INTERFACE MTL_ITEMS_REVISIONS_INTERFACE BOM_OP_ROUTINGS_INTERFACE BOM_OP_SEQUENCES_INTERFACE BOM_OP_RESOURCES_INTERFACE MTL_RTG_ITEM_REVS_INTERFACE ENG_ENG_CHANGES_INTERFACE ENG_ECO_REVISIONS_INTERFACE ENG_REVISED_ITEMS_INTERFACE BOM_INVENTORY_COMPS_INTERFACE BOM_REF_DESGS_INTERFACE BOM_SUB_COMPS_INTERFACE Routings Inbound Table Yes Yes ECO Inbound Table Yes Yes Oracle Cost Management (see Oracle Bills of Material Technical Reference Manual) Item Cost Inquiry MFG Cost Reporting Outbound Outbound View View Yes Yes CST_INQUIRY_TYPES CSTFQVIC (View Item Cost Information) CST_REPORT_TYPES CSTRFICR (Inventory Valuation Report) Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Forecast Interface Forecast Entries API Inbound Inbound Table Process PL/SQL Table Table Table Yes Yes Yes Yes MRP_FORECAST_INTERFACE T_FORECAST_INTERFACE T_FORECAST_DESIGNATOR MRP_SCHEDULE_INTERFACE MRP_RELIEF_INTERFACE Master Schedule Interface Master Schedule Relief Interface Inbound Inbound Yes Yes Yes Integrating Your Systems 1-5 .

PROCESS_ SOURCING_RULE MRP_SRC_ASSIGNMENT_PUB. or WIP_JOB_SCHEDULE_INTERFACE PO_REQUISITIONS_INTERFACE PO_RESCHEDULE_INTERFACE MRP_RECOMMENDATIONS Interface/API Name Planner Workbench Interface Projected Requirements Interface Projected Supply Interface Sourcing Rule API Outbound Table Yes Outbound Outbound Table Procedure Yes Yes Yes MRP_GROSS_REQUIREMENTS MRP_SOURCING_RULE_PUB. Process. or Procedure Process Iface Man Table. View. or TRM Procedure Name Yes Stored Procedure MRPPL06. View. Module Name.PROCESS_ ASSIGNMENT Oracle Order Management/Shipping Order Import Inbound Table Yes Yes OE_HEADERS_IFACE_ALL OE_LINES_IFACE_ALL OE_RESERVTNS_IFACE_ALL OE_CREDITS_IFACE_ALL OE_PRICE_ADJS_IFACE_ALL OE_LOTSERIALS_IFACE_ALL OE_ACTIONS_IFACE_ALL Delivery-based Ship Confirm Open Interface Inbound Table Yes Yes WSH_DELIVERIES_INTERFACE WSH_PACKED_CONTAINER_ INTERFACE WSH_PICKING_DETAILS_INTERFACE WSH_FREIGHT_CHARGES_ INTERFACE Oracle Shipping Trip Public API Stop Public API Deliveries Public API Inbound Inbound Inbound Procedure Procedure Procedure Yes Yes Yes No No No WSH_TRIPS_PUB (Procedure package) WSH_TRIP_STOPS_PUB (Procedure package) WSH_DELIVERIES_PUB (Procedure package) 1-6 Oracle Order Management Suite APIs and Open Interfaces Manual .Overview of Oracle Order Management APIs and Open Interfaces Table 1–1 Oracle Manufacturing Interfaces/APIs Data Flow Direction Outbound Table.

Overview of Oracle Order Management APIs and Open Interfaces Table 1–1 Oracle Manufacturing Interfaces/APIs Data Flow Direction Inbound Inbound Inbound Interface/API Name Delivery Details Public API Container Public API Freight Costs Public API Table. or TRM Procedure Name No No No WSH_DELIVERY_DETAILS_PUB (Procedure package) WSH_CONTAINER_PUB (Procedure package) WSH_FREIGHT_COSTS_PUB (Procedure package) Oracle Purchasing Requisitions Requisition Reschedule Purchasing Documents Receiving Inbound Inbound Inbound Inbound Table Table Table Table Yes Yes Yes Yes Yes Yes Yes Yes PO_REQUISITIONS_INTERFACE PO_REQ_DIST_INTERFACE PO_RESCHEDULE_INTERFACE PO_HEADERS_INTERFACE PO_LINES_INTERFACE RCV_HEADERS_INTERFACE RCV_TRANSACTIONS_INTERFACE Oracle Pricing Formula Calculation Application Program Interface Inbound/O utbound Table Yes Yes REQ_LINE_ATTRS Process Yes Yes GET_CUSTOM_PRICE PARSE_FORMULA CALCULATE COMPONENT_VALUE Update Formula Prices Application Program Interface Copy Price List Application Program Interface Inbound Process Yes Yes UPDATE_FORMULA_PRICE Inbound Table Yes Yes MAPPING Process Yes Yes COPY_PRICE_LIST PRICE_BREAK_LINE GET_NEW_ID DELETE_DUPLICATE_LINES COPY_DISCOUNTS Integrating Your Systems 1-7 . or Procedure Procedure Procedure Procedure Iface Man Yes Yes Yes Table. Process. View. View. Module Name.

Process. or Procedure Table Iface Man Yes Table. View. or TRM Procedure Name Yes REQ_LINE_ATTRS Interface/API Name Adjust Price List Application Program Interface Business Object for Pricing Formulas Application Program Interface Inbound/O utbound Table Yes Yes FORMULA FORMULA_VAL FORMULA_LINES FORMULA_LINES_VAL Process Yes Yes PROCESS_PRICE_FORMULA GET_PRICE_FORMULA Price Request Application Program Interface Inbound/O utbound Table Yes Yes CONTROL LINE LINE_DETAIL QUAL LINE_ATTR RELATED_LINES Process Business Object for Modifier Setup Application Program Interface Inbound/O utbound Table Yes Yes Yes Yes PRICE_REQUEST MODIFIER_LIST MODIFIER_LIST_VAL MODIFIERS MODIFIERS_VAL QUALIFIERS QUALIFIERS_VAL PRICING_ATTR PRICING_ATTR_VAL Process Qualifiers Application Program Interface Inbound/O utbound Table Yes Yes Yes Yes PROCESS_MODIFIERS QUALIFIER_RULES QUALIFIER_RULES_VAL QUALIFIERS QUALIFIERS_VAL 1-8 Oracle Order Management Suite APIs and Open Interfaces Manual . View. Module Name.Overview of Oracle Order Management APIs and Open Interfaces Table 1–1 Oracle Manufacturing Interfaces/APIs Data Flow Direction Inbound Table.

View. Module Name.Overview of Oracle Order Management APIs and Open Interfaces Table 1–1 Oracle Manufacturing Interfaces/APIs Data Flow Direction Table. or Procedure Process Iface Man Yes Table. Process. or TRM Procedure Name Yes PROCESS_QUALIFIER_RULES LOCK_QUALIFIER_RULES GET_QUALIFIER_RULES COPY_QUALIFIER_RULES Interface/API Name Attribute Mapping Application Program Interface Inbound/O utbound Table Yes Yes CONTEXTS_RESULT Process Yes Yes BUILD_CONTEXTS ADD_CONDITION ADD_SRC_SYSTEM_TO_CONDITION DELETE_CONDITION ADD_ATTRIB_MAPPING_RULE UPDATE_ATTRIB_MAPPING_RULE DELETE_ATTRIB_MAPPING_RULE Oracle Purchasing Requisitions Requisition Reschedule Purchasing Documents Receiving Inbound Inbound Inbound Inbound Table Table Table Table Yes Yes Yes Yes Oracle Quality Collection Import Dynamic Collection Plan View Dynamic Collection Import View Inbound Outbound Inbound Table View View Yes Yes Yes Yes Yes Yes QA_RESULTS_INTERFACE Q_COLLECTION_PLAN_NAME_V Q_COLLECTION_PLAN_NAME_IV Yes Yes Yes Yes PO_REQUISITIONS_INTERFACE PO_REQ_DIST_INTERFACE PO_RESCHEDULE_INTERFACE PO_HEADERS_INTERFACE PO_LINES_INTERFACE RCV_HEADERS_INTERFACE RCV_TRANSACTIONS_INTERFACE Oracle Work in Process Integrating Your Systems 1-9 . View.

For outbound interfaces. You can find information about the tables. where these products are the source. views. and processes involved in outbound interfaces in the product’s Technical Reference Manual. interface tables as well as supporting validation. database views are provided and the destination application should provide the validation. processing. View. Module Name.Overview of Oracle Order Management APIs and Open Interfaces Table 1–1 Oracle Manufacturing Interfaces/APIs Data Flow Direction Inbound Inbound Inbound Interface/API Name Moves Resource Work Order Interface Table. and maintenance programs. or Procedure Table Table Table Iface Man Yes Yes Yes Table. Discussion of Inbound Interfaces Only This overview and the rest of the documents in this chapter discuss only inbound interfaces in detail. where these products are the destination. Note that the Technical Reference Manuals do not contain detailed. View. Open Interface Diagram The general model for open application interfaces is as follows: 1-10 Oracle Order Management Suite APIs and Open Interfaces Manual . narrative discussions about the outbound interfaces. and maintenance programs are provided. or TRM Procedure Name Yes Yes Yes WIP_MOVE_TXN_INTERFACE WIP_COST_TXN_INTERFACE WIP_JOB_SCHEDULE_INTERFACE WIP_JOB_DTLS_INTERFACE Inbound Open Interface Model Oracle Manufacturing products provide both inbound and outbound interfaces. processing. For inbound interfaces. Process.

Overview of Oracle Order Management APIs and Open Interfaces Figure 1–1 Open Interface Diagram Open Application Programmatic Interface (API) Diagram The model used by APIs such as the Service Request interfaces (Oracle Service) is as follows: Integrating Your Systems 1-11 .

These components are described below. Oracle Manufacturing products are the source for outbound interfaces. For example. Source Application You obtain data from a source application to pass on to a destination application for further processing and/or storage.Overview of Oracle Order Management APIs and Open Interfaces Figure 1–2 Open Application Programmatic Interface (API) Diagram Components of an Open Interface There are a number of components that are generally common to all open interfaces. This 1-12 Oracle Order Management Suite APIs and Open Interfaces Manual . However. Typically the data has completed processing in the source application before being passed. Oracle Inventory is the source for the On-Hand Balances Interface. all open interfaces do not include every component. and in some cases the component may be implemented slightly differently than described below.

Oracle Purchasing updates purchase orders for each receiving transaction. The various types of interface columns. typical identifier columns for a move transaction would identify: s The source application. Integrating Your Systems 1-13 . Destination Application You send data to a destination application so that the application can perform further processing and/or storage. the interface table is the intermediary table where the data from the source application temporarily resides until it is validated and processed into an Oracle Manufacturing product. are listed below: Identifier Columns Identifier columns uniquely identify rows in the interface table and provide foreign key reference to both the source and destination applications. processed. Oracle Purchasing is the destination for receiving transactions imported using the Receiving Open Interface. Interface Table For inbound interfaces. For example. such as the bar code device identifier The row’s unique identifier in the source application.Overview of Oracle Order Management APIs and Open Interfaces interface is used to export on-hand balances from Oracle Inventory for use by other planning and distribution destination applications. Data Columns Data columns store the specific attributes that the source application is sending to the Oracle Manufacturing product. such as the Work in Process entity ID. Oracle Manufacturing products are the destinations for inbound interfaces. Required Columns Required columns store the minimum information needed by the Oracle Manufacturing product to successfully process the interface row. For example. such as the job name The destination application’s unique identifier. validated. Additional control columns identify who last updated the row and the last update date. transaction quantity is one attribute of a move transaction. errored. organization code is required for all move transactions. For example. s s Control Columns Control columns track the status of each row in the interface table as it is inserted. For example. and ultimately deleted. with examples from the Oracle Work in Process Move Transaction Interface. and creates and stores the receiving transaction history.

on a move transaction. For example. Oracle Cost Management provides work in process valuation and transaction distribution database views for use by other cost reporting destination products. for move transactions the reason code is not required. the validation program inserts an error into an errors table when resource transaction records fail validation because of a missing piece of required data. For example. Database View Database views are database objects that make data from the Oracle Manufacturing source products available for selection and use by destination applications. Derived Columns Derived columns are created by the destination product from information in the required columns. This allows each row in the interface table to have many errors. In addition to the predefined views that these products use. dynamic views. For example. Oracle Manufacturing products provide predefined views of key data that is likely to be used by destination applications. For example. so that you can manage multiple errors at once. For example. the errors table stores all errors found by the validation and processing functions. In contrast.Overview of Oracle Order Management APIs and Open Interfaces Some columns are conditionally required based on the specifics of the interface. the errors table is a child of the interface table. repetitive move transactions require production line information. which requires you to fix each error independently. 1-14 Oracle Order Management Suite APIs and Open Interfaces Manual . such as the resource transaction quantity. in the Oracle Work in Process Open Resource Transaction Interface. but can optionally be used to collect additional transaction information. the errors are stored in a column within the interface table. Errors Table For inbound interfaces. Optional Columns Optional columns are not necessarily required by Oracle Manufacturing products but can be used for additional value-added functionality. In other cases. Oracle Quality also provides non-predefined. These views join related tables within source products so that the data can be selected by the destination application. In some cases. the primary unit of measure is derived from the assembly being moved. whereas discrete move transactions do not. Order Import in Oracle Order Management/Shipping inserts errors into a single errors column in the interface table when rows fail validation.

In the source application. The programming languages and tools used in the load function are highly dependent on the hardware and system software of the source application. not null columns. Validate Function The validate function is the set of programs that Oracle Manufacturing destination products use to insure the integrity of inbound data. you would likely use a tool such as Pro*C or PL/SQL since these tools work in both environments. For example. if you are passing data between an Oracle based source application and an Oracle Manufacturing product. the validate function can derive additional columns based on the required columns and foreign key relationships with other data elsewhere in the Oracle Manufacturing destination application. the Item Cost Interface in Oracle Cost Management uses SQL to create several database views of the item cost information for use by other budgeting and cost analysis destination applications. For example. However. If you are bringing data from a non-Oracle based application into a product’s interface table. then validates and updates each row indicating either validation complete or errors found. For outbound interfaces. and so on. data types. you can typically validate data upon entry using techniques such as forms triggers. For example. In addition. validation programs need to write errors to the destination application’s errors table or to the interface table’s error column. If errors are found. you would likely use a procedural language available on the source application to select the data and convert it into an ASCII file. several validation tasks are performed by the move transaction validation program within the Oracle Work in Process Open Move Transaction Interface. since Oracle Manufacturing products are not the source of this data. The validation programs check the interface table for rows requiring validation.Overview of Oracle Order Management APIs and Open Interfaces 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 Manufacturing interface tables. These tasks include: s checking the accuracy of specific columns such as the job or schedule name checking the completeness of each row such as the transaction unit of measure and transaction quantity s Integrating Your Systems 1-15 . Then you could use SQL*Loader to insert that file into the destination product’s interface table. the load function is the SQL that creates the database view. validation programs ensure data integrity.

Corrected rows can be resubmitted for processing. the processing generally includes recording transaction history. The specific processing performed varies by application. You must either fix or delete the problem record using the Pending Move Transactions window. Maintain Function The maintain function is generally accomplished from a window within an Oracle Manufacturing product. For example. Most of these windows allow you to query. ensures that you do not have duplicate data when the information is reinserted. When an Oracle Manufacturing product is the source. When an Oracle Manufacturing product is the source product. the destination application should provide the process function. the load validation function catches the error. Deleting problem data. the destination application should provide the validate function. You can generally use these windows to query unprocessed or unvalidated rows and check their current status. then subsequently correcting it at the source. updating inventory and order balances. if invalid information from a bar code device is inserted into the Oracle Work in Process Open Move Transaction interface table. the process function may need to insert rows into the errors table. For open transaction interfaces. update. and resubmit interface records that have validation.Overview of Oracle Order Management APIs and Open Interfaces s checking the relationship between columns in the same row such as the from and to operation sequence numbers The move transaction validation program also derives columns from required columns such as WIP_ENTITY_ID from the job name and PROD_LINE_ID from the line code. For example. Interfaces typically let you control both the frequency and the number of validated rows that the processing programs attempt to process. Process Function The process function is a set of programs that processes the data from the interface table into the Oracle Manufacturing destination product. and charging costs. Upon successful completion of processing. if the Oracle Work in Process Open Move Transaction Interface processing function encounters problems such as lack of grants. it updates the interface table with an error status and inserts an error in the errors table. On occasion. the process function should delete the processed row from the interface table. 1-16 Oracle Order Management Suite APIs and Open Interfaces Manual .

you can use SQL*Plus to query and update the errored interface table rows.Overview of Oracle Order Management APIs and Open Interfaces In the case where there is no formal maintain function. the destination application should provide the maintain function. Integrating Your Systems 1-17 . When an Oracle Manufacturing product is the source application.

Overview of Oracle Order Management APIs and Open Interfaces 1-18 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management with Oracle Receivables for Invoicing on page 2-124. Oracle Order Management Process Order API on page 2-151 s s s s s s s s s s Oracle Order Management Open Interface 2-1 .Oracle Order Management Open Interface This chapter contains information about the following Oracle Order Management open interfaces: s 2 HEADERS INTERFACE on page 2-2 LINES INTERFACE on page 2-21 PRICE ADJUSTMENT INTERFACE on page 2-46 SALES CREDITS INTERFACE on page 2-53 RESERVATION INTERFACE on page 2-57 ACTIONS INTERFACE on page 2-59 LOTSERIAL INTERFACE on page 2-63 Calling The Sales Order Form From Other Modules on page 2-66 Integrating Oracle Order Management Using Order Import on page 2-68.

If you want to enter an accounting rule. then you can enter the AGREEMENT. and if your ACCOUNTING_RULE is not unique. otherwise. Destination: OE_ORDER_HEADERS. and if your AGREEMENT is not unique. AGREEMENT_ID NUMBER Enter the agreement ID that matches your AGREEMENT. If you want to enter an accounting rule. and you are using IDs.ATTRIBUTE1-15 2-2 Oracle Order Management Suite APIs and Open Interfaces Manual . and if your AGREEMENT is not unique. If you are using IDs. If you are not using IDs. you must also enter the ACCOUNTING_RULE_ID. If you are not using IDs. you can enter the AGREEMENT_ID. then you must enter the ACCOUNTING_RULE name. you must also enter the ACCOUNTING_RULE_ID. then you must enter the ACCOUNTING_RULE name. you must also enter the AGREEMENT_ID. Destination: OE_ORDER_HEADERS. If you are not using IDs. and if your ACCOUNTING_RULE is not unique. and you are using IDs. you must also enter the AGREEMENT_ID. you can enter the ACCOUNTING_RULE_ID.ACCOUNTING_RULE_ID AGREEMENT VARCHAR2(50) Enter the name of the agreement for the order. then you must enter the AGREEMENT. Destination: OE_ORDER_HEADERS. If you are using IDs. If you are not using IDs.AGREEMENT_ID ATTRIBUTE1-15 VARCHAR2(240) Enter any information in these 15 columns that you wish to have imported into your descriptive flexfield columns for the context. This is only required if the order type is one which requires an agreement. you can enter the ACCOUNTING_RULE_ ID.HEADERS INTERFACE HEADERS INTERFACE ACCOUNTING_RULE VARCHAR2(30) Enter the name of the accounting rule for the order. or use defaulting. ACCOUNTING_RULE_ID NUMBER Enter the rule ID that matches your accounting rule. it is an optional column. you can enter the AGREEMENT_ID.

CHANGE_SEQUENCE VARCHAR2(50) Used at header level for the EDI transaction to keep track of the changes coming to the order. this column value should be provided for the Audit trail.CANCELLED_FLAG CHANGE_COMMENTS VARCHAR2(2000) Free format text can be optionally supplied for any change. Destination: OE_ORDER_HEADERS.CHECK_NUMBER Oracle Order Management Open Interface 2-3 . Destination: OE_ORDER_HEADERS.HEADERS INTERFACE BOOKED_FLAG VARCHAR2(1) The value for this can be passed as ‘Y’ if user wants to book the imported order at the time of Entry itself.CHANGE_COMMENTS CHANGE_REASON VARCHAR2(30) For Update operation. Destination: OE_ORDER_HEADERS. This to support the previous behavior. If a lower change sequence come after the high change sequence is already applied.CHANGE_SEQUENCE CHECK_NUMBER VARCHAR2(50) Enter the check number for the order if payment type is check.BOOKED_FLAG CANCELLED_FLAG VARCHAR2(1) The value for this can be passed as ‘Y’ if user wants to cancel the order. the right way of booking the order is pass the action of BOOK_ORDER in oe_actions_interface for the order. the old changes will not be applied. Destination: OE_ORDER_HEADERS. Destination: OE_ORDER_HEADERS. Destination: OE_ORDER_HEADERS.CHANGE_REASON CHANGE_REQUEST_CODE VARCHAR2(30) Not Used.

if you entered a currency code other than the functional currency for your set of books and a conversion_type_code equal to User. which will in turn close the existing order in system. Destination: OE_ORDER_HEADERS.OPEN_FLAG CONTEXT VARCHAR2(30) Enter the context for your descriptive flexfield. Destination: OE_ORDER_HEADERS.CONVERSION_RATE_DATE CONVERSION_TYPE VARCHAR2(30) Enter the currency conversion type for the order if you entered a currency code other than the functional currency for your set of books. Passed Closed_Flag of value ‘Y’ will be stored in Open_Flag with value ‘N’.CONVERSION_TYPE_CODE 2-4 Oracle Order Management Suite APIs and Open Interfaces Manual .CONTEXT CONVERSION_RATE NUMBER Enter the currency conversion rate for the order if you entered a currency code other than the functional currency for your set of books and a conversion_type_code equal to User. Destination: OE_ORDER_HEADERS. Destination: OE_ORDER_HEADERS. Should not be confused with functionality of closing the existing order in Order Management System.HEADERS INTERFACE CLOSED_FLAG VARCHAR2(1) Should only be passed for importing the Closed orders from legacy system. For already existing order the Cancelled_Flag should be passed as ‘Y’. if you have enabled a context–sensitive descriptive flexfield. This value will be used to generate the Conversion_type_Code and stored in headers table. Destination: OE_ORDER_HEADERS.CONVERSION_RATE CONVERSION_RATE_DATE DATE Enter the currency conversion date for which the conversion rate is valid for the order. CONVERSION_TYPE_CODE VARCHAR2(30) Enter the currency conversion type for the order if you entered a currency code other than the functional currency for your set of books.

Oracle Order Management Open Interface 2-5 .CREDIT_CARD_APPROVAL_DATE CREDIT_CARD_CODE VARCHAR2(30) Enter the credit card code for the type of credit card the customer is using for payment.CREDIT_CARD_HOLDER_NAME CREDIT_CARD_NUMBER VARCHAR2(80) Enter the credit card number.HEADERS INTERFACE CREATION_DATE NOT NULL DATE Creation date of the Order. Only enter this if the credit card has been pre-approved Destination: OE_ORDER_HEADERS.CREATION_DATE CREATED_BY NOT NULL NUMBER Enter an identification number that you can use to identify the user who Created the record. Only enter this if the credit card has been pre-approved.CREDIT_CARD_CODE CREDIT_CARD_EXPIRATION_DATE DATE Enter the expiration date of the credit card used for payment.CREDIT_CARD_APPROVAL_CODE CREDIT_CARD_APPROVAL_DATE DATE Enter the credit card approval date. CREDIT_CARD_EXPIRATION_DATE CREDIT_CARD_ HOLDER_NAME VARCHAR2(80) Enter the name of the credit card holder. OE_ORDER_HEADERS. Destination: OE_ORDER_HEADERS. Destination: OE_ORDER_HEADERS.CREATED_BY CREDIT_CARD_APPROVAL_CODE VARCHAR2(80) Enter the credit card approval number. Destination: OE_ORDER_HEADERS. Destination: OE_ORDER_HEADERS. Destination: OE_ORDER_HEADERS.

Destination: OE_ORDER_HEADERS. Destination: None CUSTOMER_PAYMENT_TERM VARCHAR2(30) Enter the customer_payment_term. CUSTOMER_NAME VARCHAR2(30) Enter the full name of the customer for this order. DELIVER_TO_CONTACT_ID 2-6 Oracle Order Management Suite APIs and Open Interfaces Manual .CUSTOMER_ PO_NUMBER DELIVER_TO_CONTACT VARCHAR2(30) Enter the Deliver to contact information. DELIVER_TO_CONTACT_ID NUMBER Enter the Deliver to contact Id information. CUSTOMER_NUMBER VARCHAR2(30) Enter the customer number for this order. Destination: OE_ORDER_HEADERS. CUSTOMER_PAYMENT_TERM_ID NUMBER Enter the customer_payment_term_id. doing so will result in warning message and passed Id will be used. In case of duplicate a warning will be issued. If your CUSTOMER_NAME and/or CUSTOMER_NUMBER is not unique.HEADERS INTERFACE Destination: OE_ORDER_HEADERS.customer_payment_term_id. the id will be generated and stored in oe_order_ headers.CUSTOMER_PAYMENT_TERM_ID CUSTOMER_PO_NUMBER VARCHAR2(50) Enter the customer po number. Destination: OE_ORDER_HEADERS. Deliver_to_contact_id will be generated and stored. Both value and id(sold_to_org_id) should not be populated.CREDIT_CARD_NUMBER CUSTOMER_ID NUMBER Use the Sold_to_Org_Id instead of this Column. you must also enter the CUSTOMER_ID.

DEMAND_CLASS_CODE VARCHAR2(30) Enter the Demand Class Code information. Demand Class Code will be generated and stored in oe_order_headers. Do not Populate ERROR_FLAG VARCHAR2(1) This column is used internally. DELIVER_TO_ORG_ID NUMBER Enter the Deliver to Org Id Information.demand_class_code.HEADERS INTERFACE DELIVER_TO_CUSTOMER VARCHAR2(30) Not Used. Destination: OE_ORDER_HEADERS. DELIVER_TO_ORG VARCHAR2(30) Not Used. Destination: OE_ORDER_HEADERS. EARLIEST_SCHEDULE_LIMIT NUMBER Internal Use. DELIVER_TO_ORG_ID DEMAND_CLASS VARCHAR2(30) Enter the Demand Class information. DEMAND_CLASS_CODE DROP_SHIP_FLAG VARCHAR2(1) Internal Use. Destination: OE_ORDER_HEADERS. Y means an error occurred when importing the corresponding header. Do not Populate. DELIVER_TO_CUSTOMER_NUMBER VARCHAR2(30) Not Used.FOB_POINT Oracle Order Management Open Interface 2-7 . FOB_POINT VARCHAR2(30) Enter the FOB point name for the Order.

GLOBAL_ATTRIBUTE_CATEGORY HEADER_ID NUMBER Column for the internal use. Destination: OE_ORDER_HEADERS.FREIGHT_TERMS_CODE GLOBAL_ATTRIBUTE1-20 VARCHAR2(240) Enter any information in these 20 columns that you wish to have imported into your descriptive flexfield columns for the GLOBAL_ATTRIBUTE_CATEGORY. Destination: OE_ORDER_HEADERS. if you have enabled a context–sensitive descriptive flexfield. 2-8 Oracle Order Management Suite APIs and Open Interfaces Manual .HEADERS INTERFACE FOB_POINT_CODE VARCHAR2(30) Enter the FOB point code for the order. FREIGHT_TERMS_CODE VARCHAR2(30) Enter the freight terms code. INTERFACE_STATUS VARCHAR2(1000) Not Used.FOB_POINT_CODE FREIGHT_CARRIER_CODE VARCHAR2(30) Is for Internal used and get derived by Ship Method. Destination: OE_ORDER_HEADERS. specifying the responsibility for freight charges.FREIGHT_CARRIER_CODE FREIGHT_TERMS VARCHAR2(30) Enter the freight terms.GLOBAL_ATTRIBUTE1-20 GLOBAL_ATTRIBUTE_CATEGORY VARCHAR2(30) Enter the context for global descriptive flexfield. HEADER_PO_CONTEXT VARCHAR2(30) Not Used. Destination: OE_ORDER_HEADERS. Destination: OE_ORDER_HEADERS. You have to enter either the FREIGHT_TERMS_CODE or the FREIGHT_TERMS name.

Where are all the rest of the Invoice-To fields? Postal Code.HEADERS INTERFACE INVOICE_ADDRESS1-4 VARCHAR2(35) Enter the street address (4 lines) for your bill–to address. INVOICE_CUSTOMER_NUMBER VARCHAR2(60) Not Used. INVOICE_POSTAL_CODE VARCHAR2(15) Used for the derivation of the invoice_to_org_id. Oracle Order Management Open Interface 2-9 . INVOICE_COUNTY VARCHAR2(25) Enter the county for your bill–to address. INVOICE_CUSTOMER VARCHAR2(60) Not Used. INVOICE_PROVINCE_INT VARCHAR2(30) Not Used. INVOICE_SITE VARCHAR2(30) Not Used. INVOICE_STATE VARCHAR2(30) Enter the state or province for your bill–to address. etc. INVOICE_COUNTRY VARCHAR2(20) Enter the country for your bill–to address. contacts. INVOICE_SITE_CODE VARCHAR2(30) Not Used. Customer name & number. INVOICE_CITY VARCHAR2(30) Enter the city for your bill–to address.

Destination: OE_ORDER_HEADERS. INVOICE_TO_ORG VARCHAR2(30) Not Used. The invoice_to_contact_id will be generated using this and stored in oe_order_headers. Destination: OE_ORDER_HEADERS.HEADERS INTERFACE INVOICE_TO_CONTACT VARCHAR2(30) Used for the derivation of the invoice_to_contact_id.invoice_to_contact_id. Destination: OE_ORDER_HEADERS. INVOICE_TO_ORG_ID NUMBER Enter the id for customer’s invoice use site. Destination: OE_ORDER_HEADERS. Supply either invoice_to_ contact or Invoice_to_contact_id.INVOICE_TO_CONTACT_ID INVOICE_TO_CONTACT_LAST_NAME VARCHAR2(30) Not Used. INVOICE_TO_CONTACT_FIRST_NAME VARCHAR2(30) Not Used.INVOICING_RULE_ID LAST_UPDATE_DATE NOT NULL DATE Enter the current date on which you are entering data. INVOICING_RULE_ID NUMBER Enter the rule ID that matches your invoicing rule.INVOICE_TO_ORG_ID INVOICING_RULE VARCHAR2(30) Enter the name of the invoicing rule for the order. you must also enter the INVOICING_RULE_ID. INVOICE_TO_CONTACT_ID NUMBER Provide the value of invoice_to_contact_id. If your INVOICING_RULE is not unique.LAST_UPDATE_DATE 2-10 Oracle Order Management Suite APIs and Open Interfaces Manual .

Oracle Order Management Open Interface 2-11 . ORDER_SOURCE VARCHAR2(30) Provide the name of the order source id. Destination: OE_ORDER_HEADERS. OPERATION_CODE VARCHAR2(30) Enter UPDATE or DELETE for existing orders.LAST_UPDATE_LOGIN LAST_UPDATED_BY NOT NULL NUMBER Enter an identification number that you can use to identify the user who created or who most recently modified the record.HEADERS INTERFACE LAST_UPDATE_LOGIN NUMBER Enter an identification number that you can use to identify the feeder system that is supplying Order Management with this data. Destination: OE_ORDER_HEADERS.ORDER_DATE_TYPE_CODE ORDER_NUMBER NUMBER Internal Use. Destination: OE_ORDER_HEADERS.LAST_UPDATED_BY LATEST_SCHEDULE_LIMIT NUMBER Not Used. This value will be used to derive the order_ source_id and will be stored in oe_order_headers. You can also leave this column null for new imported orders. MIXED or RETURN. ORDER_CATEGORY VARCHAR2(30) Depending on the order category pass the value ORDER.order_source_id.ORDER_CATEGORY ORDER_DATE_TYPE_CODE VARCHAR2(30) Can have a value of ARRIVAL or SHIP. Destination: OE_ORDER_HEADERS. or enter INSERT for new imported orders.

Destination: Inserts OE_ORDER_TYPES. Destination: OE_ORDER_HEADERS. Destination: OE_ORDER_HEADERS. ORDERED_BY_CONTACT_LAST_NAME VARCHAR2(30) Not Used. The order number or ID you enter provides you with an audit trail from Order Import to your feeder system. Please note that you can populate either the ID or the value regardless of the order source. unlike previous releases where the order source dictated whether you could use Ids or not. Destination: OE_ORDER_HEADERS. ORDERED_DATE DATE Enter the date on which this order was placed in the original system.ORIG_SYS_DOCUMENT_REF 2-12 Oracle Order Management Suite APIs and Open Interfaces Manual .ORDER_TYPE = OE_ORDER_TYPES.ORDERED_DATE ORG_ID NUMBER Internal Use.ORDER_TYPE_ID where OE_HEADERS_INTERFACE.HEADERS INTERFACE ORDER_SOURCE_ID NUMBER This is the ID of the Order Source which is typically defined using the Order Import Sources setup.ORDER_TYPE_ID ORDERED_BY_CONTACT_FIRST_NAME VARCHAR2(30) Not Used.NAME ORDER_TYPE_ID NUMBER Enter the order type ID that matches your order type.ORDER_TYPE_ID into OE_ORDER_ HEADERS.ORDER_SOURCE_ID ORDER_TYPE conditionally NOT NULL VARCHAR2(30) Enter the name of the order type to assign to your order. ORIG_SYS_DOCUMENT_REF VARCHAR2(50) Enter the order number or ID from your original feeder system. Destination: OE_ORDER_HEADERS.

PAYMENT_AMOUNT NUMBER Enter the payment amount for the order if payment type is cash or check. you must also enter the PRICE_LIST_ID. PRICE_LIST VARCHAR2(240) Enter the name of the price list for the Order. PAYMENT_TERM_ID NUMBER Enter the payment terms ID which matches your terms name. PO_ATTRIBUTE1-15 VARCHAR2(240) Not Used. If your PAYMENT_TERM is not unique. PO_REVISION_DATE DATE Not Used.PAYMENT_TERM_ID PAYMENT_TERM_CODE VARCHAR2(30) Not Used.PACKING_INSTRUCTIONS PARTIAL_SHIPMENT_ALLOWED VARCHAR2(1) Internal Use. PRICE_LIST_ID NUMBER Enter the price list ID which matches your price list. Oracle Order Management Open Interface 2-13 . Destination: OE_ORDER_HEADERS. Destination: OE_ORDER_HEADERS. If your PRICE_LIST is not unique. you must also enter the PAYMENT_TERM_ID. Destination: OE_ORDER_HEADERS.HEADERS INTERFACE PACKING_INSTRUCTIONS VARCHAR2(240) Enter any packing instructions you wish to accompany the order.PAYMENT_AMOUNT PAYMENT_TERM VARCHAR2(30) Enter the name of the payment terms for the order.

Set this flag to ‘Y’.HEADERS INTERFACE Destination: OE_ORDER_HEADERS. In order for records to be processed. Destination: OE_ORDER_HEADERS. Destination: OE_ORDER_HEADERS. RETURN_REASON_CODE VARCHAR2(30) The reason code for return. READY_FLAG VARCHAR2(1) Only the records with ready flag as ‘Y’ will be picked up for the processing.PRICE_LIST_ID PROGRAM_APPLICATION_ID NUMBER This column is for Internal use only. PROGRAM_UPDATE_DATE DATE This column is for Internal use only.REJECTED_FLAG REQUEST_DATE DATE The request date for the order.REQUEST_DATE REQUEST_ID NUMBER This column is for internal use only. Destination: OE_ORDER_HEADERS. PROGRAM_ID NUMBER This column is for Internal use only. Is required for the return. It is populated with the concurrent manager request ID for the run of the interface each time you submit the Order Import program.READY_FLAG REJECTED_FLAG VARCHAR2(1) Records with the rejected flag will be picked up for the acknowledgment. will be defaulted on lines.RETURN_REASON_CODE 2-14 Oracle Order Management Suite APIs and Open Interfaces Manual . their request ID must be null or equal to the request ID being processed. with ready flag as ‘N’ to avoid processing them in import processing but available for the acknowledgment process. Destination: OE_ORDER_HEADERS.

(If you do not enter explicit sales credit records. If you are not using IDs.HEADERS INTERFACE SALES_CHANNEL_CODE VARCHAR2(30) Enter the name of the sales channel for the order. Destination: OE_ORDER_HEADERS. SHIP_TO_CONTACT VARCHAR2(30) Supply the contact information for shipping. Ship to contact id will be generated using this data and stored in oe_order_headers_all.SALESREP_ID SHIP_FROM_ORG VARCHAR2(30) Not Used. where the item to be shipped. Destination: OE_ORDER_HEADERS.ship_to_contact_id. you must enter the SALESREP_ID. Oracle Order Management Open Interface 2-15 .SHIP_FROM_ORG_ID SHIP_TO_ADDRESS1-4 VARCHAR2(30) Enter the street address (4 lines) of your ship-to address. Destination: Inserts RA_SALESREPS.SALES_CHANNEL_CODE SALESREP VARCHAR2(30) Enter the name of the primary salesperson for this order. Order Import will automatically assign 100% quota credit for the whole order to this salesperson).SALESREP_ID into OE_ORDER_ HEADERS. then you must enter the SALESREP and if your SALESREP is not unique.SALESREP_ID where RA_SALESREP. SHIP_FROM_ORG_ID NUMBER Supply the site use id.SALESREP SALESREP_ID NUMBER Enter the Salesrep ID for the salesperson. you must also enter the SALESREP_ID. If you are using IDs. SHIP_TO_CITY VARCHAR2(30) Supply city information for shipping. Destination: OE_ORDER_HEADERS.NAME = OE_HEADERS_ INTERFACE. If your SALESREP is not unique. you must also enter the SALESREP_ID.

SHIP_TO_ORG VARCHAR2(30) Enter the name of the customer to receive the shipment. then you must enter the SHIP_TO_ORG. SHIP_TO_CUSTOMER_NUMBER VARCHAR2(30) For future use.SHIP_TO_ORG_ID SHIP_TO_POSTAL_CODE VARCHAR2(30) Supply the postal code for the ship to address. SHIP_TO_COUNTRY VARCHAR2(30) Supply the shipping country name. SHIP_TO_COUNTY VARCHAR2(30) Supply the shipping county name. Destination: OE_ORDER_HEADERS.SHIP_CONTACT_ID SHIP_TO_CONTACT_LAST_NAME VARCHAR2(30) Not Used. SHIP_TO_ORG_ID NUMBER Enter the customer ID of your ship–to customer. SHIP_TO_CONTACT_ID NUMBER Supply the id data for shipping contact. SHIP_TO_CUSTOMER VARCHAR2(30) For future use.HEADERS INTERFACE SHIP_TO_CONTACT_FIRST_NAME VARCHAR2(30) Not Used. If you are not using IDs. 2-16 Oracle Order Management Suite APIs and Open Interfaces Manual . Destination: OE_ORDER_HEADERS.

SHIPPING_INSTRUCTIONS VARCHAR2(240) Enter any shipping instructions you wish to accompany the order.SHIPPING_INSTRUCTIONS Oracle Order Management Open Interface 2-17 . SHIP_TO_SITE_INT VARCHAR2(30) Not Used. Destination: OE_ORDER_HEADERS.SHIP_TOLERANCE_BELOW SHIPMENT_PRIORITY VARCHAR2(30) Enter the shipment priority for the order. SHIP_TO_STATE VARCHAR2(30) Supply the state code for the ship to state. Destination: OE_ORDER_HEADERS. Destination: OE_ORDER_HEADERS. The Code for this will be generated and stored in OE_ORDER_HEADERS.SHIPMENT_PRIORITY_CODE.HEADERS INTERFACE SHIP_TO_PROVINCE VARCHAR2(30) Not Used. SHIP_TOLERANCE_ABOVE NUMBER Supply tolerance percentage value for overshipments.SHIP_TOLERANCE_ABOVE SHIP_TOLERANCE_BELOW NUMBER Supply tolerance percentage value For undershipments. Destination: OE_ORDER_HEADERS.SHIPMENT_PRIORITY_CODE SHIPMENT_PRIORITY_CODE_INT VARCHAR2(30) Not Used. SHIPMENT_PRIORITY_CODE VARCHAR2(30) Enter the shipment priority for the order.

SOLD_FROM_ORG_ID NUMBER Supply the id information for sold from. The Sold to org id will be generated and stored in oe_order_headers. The sold to contact id will be generated for that customer and stored in oe_order_headers. Destination: OE_ORDER_HEADERS. STATUS_FLAG VARHAR2(1000) Not Used.sold_to_org_id. SOLD_TO_CONTACT_ID NUMBER Supply the id information for customer’s contact. Destination: OE_ORDER_HEADERS. The code for this will be generated using OE_SHIP_METHODS_V and code will be stored in OE_ORDER_HEADERS_ ALL. SHIPPING_METHOD_CODE VARCHAR2(30) Enter the Shipping Method for the order.HEADERS INTERFACE SHIPMENT_METHOD VARCHAR2(30) Pass the shipping method value to this field.SOLD_TO_ORG_ID SOLD_TO_ORG VARCHAR2(30) Supply the name of the sold to org.SOLD_TO_CONTACT_ID SOLD_TO_ORG_ID NUMBER Supply the id information for customer id.sold_to_contact_id. 2-18 Oracle Order Management Suite APIs and Open Interfaces Manual . Destination: OE_ORDER_HEADERS.SHIPPING_METHOD_CODE. Destination: OE_ORDER_HEADERS.SOLD_FROM_ORG_ID SOLD_TO_CONTACT VARCHAR2(30) Supply the name of the sold to contact.SHIPPING_METHOD_CODE SOLD_FROM_ORG VARCHAR2(30) Not Used.

TAX_POINT_CODE VARCHAR2(30) Supply the tax point code. you must enter a valid tax exempt reason code. Destination: OE_ORDER_HEADERS.TAX_EXEMPT_REASON_CODE TAX_POINT VARCHAR2(30) Supply the tax point. Standard or Required.TAX_EXEMPT_FLAG TAX_EXEMPT_NUMBER VARCHAR2(50) If you enter E in the TAX_EXEMPT_FLAG field. This stands for Exempt. TAX_EXEMPT_REASON_CODE VARCHAR2(30) If you enter E in the TAX_EXEMPT_FLAG field. you must enter a valid tax exempt reason. Destination: OE_ORDER_HEADERS.TP_ATTRIBUTE1-15 Oracle Order Management Open Interface 2-19 . TAX_EXEMPT_FLAG VARCHAR2(30) Enter E. you can enter an existing certificate number for the ship–to customer or enter a new unapproved exemption certificate number. respectively. S. a code will be derived using this value.TAX_POINT_CODE TP_ATTRIBUTE1-15 VARCHAR2(240) Enter any information in these 15 columns that you wish to have imported into your descriptive flexfield columns for the trading partner context.TAX_EXEMPT_NUMBER TAX_EXEMPT_REASON VARCHAR2(30) If you enter E in the TAX_EXEMPT_FLAG field. or R or accept the default. Destination: OE_ORDER_HEADERS. Code will be derived using this value. Destination: OE_ORDER_HEADERS. Destination: OE_ORDER_HEADERS.HEADERS INTERFACE SUBMISSION_DATETIME DATE Not Used.

TRANSACTIONAL_CURR_CODE VERSION_NUMBER NUMBER Not Used.TP_CONTEXT TRANSACTIONAL_CURR VARCHAR2(30) Not Used. TRANSACTIONAL_CURR_CODE VARCHAR2(3) Enter the currency for the Order. 2-20 Oracle Order Management Suite APIs and Open Interfaces Manual . Destination: OE_ORDER_HEADERS.HEADERS INTERFACE TP_CONTEXT VARCHAR2(30) Enter the trading partner context information. Destination: OE_ORDER_HEADERS.

AGREEMENT VARCHAR2(30) Enter the name of the Agreement. ATTRIBUTE1-15 VARCHAR2(240) Enter any information you wish to pass to the descriptive flexfields columns in OE_ ORDER_LINES.ARRIVAL_SET_ID ARRIVAL_SET_NAME VARCHAR2(30) Enter the arrival set name. Oracle Order Management Open Interface 2-21 . AGREEMENT_ID NUMBER Enter the agreement ID.ARRIVAL_SET_NAME ATO_LINE_ID NUMBER This is for Internal use.ACCOUNTING_RULE_ID ACTUAL_ARRIVAL_DATE DATE Not used. Destination: OE_ORDER_LINES. ACCOUNTING_RULE_ID NUMBER Enter the accounting rule ID only if this is a complete order.LINES INTERFACE LINES INTERFACE ACCOUNTING_RULE VARCHAR2(30) Enter the name of the accounting rule only if this is a complete order. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES_ALL.AGREEMENT_ID ARRIVAL_SET_ID NUMBER Enter the arrival set ID. Destination: OE_ORDER_LINES.

CANCELLED_QUANTITY2 NUMBER Internal Use. 2-22 Oracle Order Management Suite APIs and Open Interfaces Manual . CHANGE_REASON VARCHAR2(30) For Update operation. CANCELLED_QUANTITY NUMBER Internal Use. or enter Y if you want Pricing to price the order line automatically. Destination: OE_ORDER_LINES.ATTRIBUTE1-15 AUTHORIZED_TO_SHIP_FLAG VARCHAR2(1) This is for Internal use. this column value should be provided for the Audit trail. CANCELLED_FLAG VARCHAR2(1) Internal Use. for update operation for totally canceling the line. CHANGE_SEQUENCE VARCHAR2(50) Future Use. Send quantity equal to 0.LINES INTERFACE Destination: OE_ORDER_LINES. CHANGE_COMMENTS VARCHAR2(2000) Future Use.CHANGE_REASON CHANGE_REQUEST_CODE VARCHAR2(30) Future use. CALCULATE_PRICE_FLAG VARCHAR2(1) Enter N if you are providing a list and selling price in the UNIT_LIST_PRICE and UNIT_SELLING_PRICE columns.

CONTEXT VARCHAR2(30) Enter the context for your descriptive flexfields attributes if you have enabled a context–sensitive descriptive flexfields in OE_ORDER_LINES. COMMITMENT VARCHAR2(240) Enter the name of the commitment. Destination: OE_ORDER_LINES.COMPONENT_CODE COMPONENT_SEQUENCE_ID NUMBER This is for Internal use.LINES INTERFACE CLOSED_FLAG VARCHAR2(1) Pass this value as ‘Y’ if you are importing Closed Order. COMMITMENT_ID NUMBER Enter the commitment ID to apply the Line against.CONTEXT CREATED_BY NOT NULL Number Enter an identification number that you can use to identify the user who created the record. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES. This is reserved for future use.COMMITMENT_ID COMPONENT_CODE VARCHAR2(1000) Enter identifier of component within an exploded bill. Destination: OE_ORDER_LINES. This will in turn be stored as ‘N’ for open_flag in oe_order_headers. To be passed for options if it exists in multiple branches of parent BOM.CREATED_BY CREATION_DATE NOT NULL DATE Enter the Creation date of the Line. In case of configurations only the primary UOM is supported.CREATION_DATE Oracle Order Management Open Interface 2-23 . Destination: OE_ORDER_LINES.

Destination: OE_ORDER_LINES. INT. CUSTOMER_ITEM_ID NUMBER Enter the ID of the customer item or generic item. CUSTOMER_ITEM_NET_PRICE NUMBER Enter the customer’s item net price for the line for reference. UPC and others. CUSTOMER_DOCK_CODE VARCHAR2(50) This is for Internal use.CUSTOMER_ITEM_ID CUSTOMER_ITEM_ID_TYPE VARCHAR2(30) The type of item.CUSTOMER_ITEM_NET_PRICE CUSTOMER_ITEM_REVISION VARCHAR2(30) Not Used. inventory item or cross reference item. CUSTOMER_DOCK VARCHAR2(50) This is for Internal use.ITEM_IDENTIFER_TYPE CUSTOMER_ITEM_NAME VARCHAR2(2000) Enter the name of the customer item or generic item. CUSTOMER_JOB VARCHAR2(50) This is for Internal use. 2-24 Oracle Order Management Suite APIs and Open Interfaces Manual . Destination: OE_ORDER_LINES. Valid values are CUST. Destination: OE_ORDER_LINES.LINES INTERFACE CREDIT_INVOICE_LINE_ID NUMBER This is for Internal use. where it is a customer item. CUST_PRODUCTION_SEQ_NUM NUMBER This is for Internal use.

CUSTOMER_LINE_NUMBER CUSTOMER_PAYMENT_TERM VARCHAR2(30) Enter the customer’s payment term for the line for reference. Destination: OE_ORDER_LINES.CUST_PO_NUMBER CUSTOMER_PRODUCTION_LINE VARCHAR2(50) This is for Internal use CUSTOMER_SHIPMENT_NUMBER VARCHAR2(50) Enter the customer’s shipment number for reference.CUSTOMER_SHIPMENT_NUMBER DELIVER_LEAD_TIME NUMBER Enter the deliver lead time. You have to enter either the DELIVER_TO_ CONTACT_ID or the DELIVER_TO_CONTACT name. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES.CUSTOMER_PAYMENT_TERM CUSTOMER_PAYMENT_TERM_ID NUMBER Enter the customer’s payment term ID for the line for reference. Customer’s who have an alphanumeric line number can store their line number information in this field.PAYMENT_TERM_ID CUSTOMER_PO_NUMBER VARCHAR2(50) Enter the customer’s PO number for reference. Customer’s who have an alphanumeric shipment number can store their shipment number information in this field. Destination: OE_ORDER_LINES.LINES INTERFACE CUSTOMER_LINE_NUMBER VARCHAR2(50) Enter the customer’s line number for reference. Oracle Order Management Open Interface 2-25 . Destination: OE_ORDER_LINES.DELIVER_LEAD_TIME DELIVER_TO_CONTACT VARCHAR2(30) Enter the deliver to contact name. Destination: OE_ORDER_LINES.

DROP_SHIP_FLAG VARCHAR2(1) This is for Internal use. Destination: OE_ORDER_LINES.g.DEMAND_CLASS_CODE DROP_SHIP_FLAG VARCHAR2(1) Not used. You have to enter either the DEMAND_CLASS_ CODE or the DEMAND_CLASS name. discrete. DEMAND_BUCKET_TYPE_CODE VARCHAR2(30) Enter the bucket type designator.DEMAND_BUCKET_TYPE_CODE DEMAND_CLASS VARCHAR2(30) Enter the Demand Class name.LINES INTERFACE DELIVER_TO_CONTACT_ID NUMBER Enter the deliver to contact ID. (e. weekly.DELIVER_TO_CONTACT_ID DELIVER_TO_ORG VARCHAR2(30) Not Used. DEMAND_CLASS_CODE VARCHAR2(30) Enter the Demand Class code. 2-26 Oracle Order Management Suite APIs and Open Interfaces Manual . Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES. monthly) associated with the Order Line.DELIVER_TO_ORG_ID DEMAND STREAM VARCHAR2(30) For Internal use only. DELIVER_TO_ORG_ID NUMBER Enter the ID of the organization which will be the end consumer of the goods.

Do not pass included items as the system will explode them. FULFILLED_QUANTITY NUMBER Enter the fulfilled quantity. Number of effectivity controlled item. EXPLOSION_DATE DATE This is for Internal use..FULFILLED_QUANTITY FULFILLED_QUANTITY2 NUMBER Enter the quantity fulfilled in secondary UOM.GLOBAL_ATTRIBUTE_CATEGORY GLOBAL_ATTRIBUTE1.20 VARCHAR2(240) Descriptive flexfield segments. Destination: OE_ORDER_LINES_ALL. Destination: OE_ORDER_LINES.FULFILLMENT_SET_ID FULFILLMENT_SET_NAME VARCHAR2(30) Enter the fulfillment set name.FULFILLMENT_SET_NAME GLOBAL_ATTRIBUTE_CATEGORY VARCHAR2(30) Enter the context for the global attributes flexfield. Destination: OE_ORDER_LINES_ALL. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES. Oracle Order Management Open Interface 2-27 .FULFILLED_QUANTITY2 FULFILLMENT_SET_ID NUMBER Enter the fulfillment set ID. END_ITEM_UNIT_NUMBER ERROR_FLAG VARCHAR2(1) This column is for Internal use only. Destination: OE_ORDER_LINES.LINES INTERFACE END_ITEM_UNIT_NUMBER VARCHAR2(30) Uniquely identifies which bill of material to be used for building a specific Model/Unit.

Destination: OE_ORDER_LINES.INDUSTRY_ATTRIBUTE1-15 INDUSTRY_CONTEXT VARCHAR2(30) Enter the context for the industry specific descriptive flexfields if it is enabled in OE_ORDER_LINES.INVENTORY_ITEM_ID INVENTORY_ITEM_SEGMENTS_1-20 VARCHAR2(240) Enter the segments of the inventory item you wish to order on the Order Line.GLOBAL_ATTRIBUTE1. Order Import knows which segment columns to place the values in. For example. You must enter either the INVENTORY_ITEM_SEGMENT columns or INVENTORY_ITEM_ID. You must enter either the INVENTORY_ITEM_ SEGMENT columns or INVENTORY_ITEM_ID.. As long as you enter the segments in the correct sequence. if you use three segments. depending on whether you are using IDs.15 INDUSTRY_ATTRIBUTE1-15 VARCHAR2(240) Enter the attributes for the industry specific descriptive flexfields for the corresponding context if the flexfield is enabled in OE_ORDER_LINES.INDUSTRY_CONTEXT INTERFACE_STATUS VARCHAR2(1000) This column is for Internal use only. 2-28 Oracle Order Management Suite APIs and Open Interfaces Manual . INVENTORY_ITEM VARCHAR230) Enter the inventory item. enter values in segments 1–3. Destination: OE_ORDER_LINES. INVOICE_SET_ID NUMBER Not used. depending on whether you are using IDs.LINES INTERFACE Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES. INVENTORY_ITEM_ID NUMBER Enter the inventory item code combination ID which matches your combination of inventory item segments.

MODEL.ITEM_TYPE_CODE LAST_UPDATE_DATE NOT NULL DATE Enter the current date on which you are entering data into your feeder system.INVOICE_TO_CONTACT INVOICE_TO_CONTACT_ID NUMBER Enter the ID of the contact person of the organization that will foot the bill.INVOICE_TO_CONTACT_ID INVOICING_RULE VARCHAR2(30) Enter the name of the invoicing rule only if this is a complete order. or STANDARD to indicate the type of item for the order line. Destination: OE_ORDER_LINES. INVOICING_RULE_ID NUMBER Enter the invoicing rule ID only if this is a complete order.INVOICING_RULE_ID ITEM_REVISION VARCHAR2(3) Enter the item revision number for a return Line. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES.LAST_UPDATE_DATE Oracle Order Management Open Interface 2-29 . KIT.ITEM_REVISION ITEM_TYPE_CODE VARCHAR2(30) Enter CLASS. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES. INVOICE_TO_CONTACT VARCHAR2(30) Enter the name of the contact person of the organization that will foot the bill.LINES INTERFACE INVOICE_SET_NAME VARCHAR2(30) Not used.

Destination: OE_ORDER_LINES. and kits. 2-30 Oracle Order Management Suite APIs and Open Interfaces Manual . (This does not need to be entered for the top–level item.LAST_UPDATE_LOGIN LAST_UPDATED_BY NOT NULL NUMBER Enter an identification number that you can use to identify the user who created or who most recently modified the record. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES. LINE_NUMBER NUMBER Enter the line number of the order line.LINE_TYPE LINK_TO_LINE_REF VARCHAR2(50) Enter the Original System Line Reference of the line for the item that is immediately above the item in this line in the bill of material (BOM) structure. option classes. LINE_TYPE VARCHAR2(30) Enter the line type. This column only needs to be populated for option items. Destination: OE_ORDER_LINES.LAST_UPDATED_BY LINE_ID NUMBER This column is for Internal use.LINES INTERFACE LAST_UPDATE_LOGIN NUMBER Enter an identification number that you can use to identify the feeder system that is supplying Order Management with this data. The line number can be from the original system.) LOAD_SEQ_NUMBER NUMBER This is for Internal use.LINE_NUMBER LINE_PO_CONTEXT VARCHAR2(30) Not used.

Enter N or null for base models or regular items. Destination: OE_ORDER_LINES. ORDER_QUANTITY_UOM VARCHAR2(3) Enter the ordered quantity UOM. Destination: OE_ORDER_LINES. OPTION_FLAG VARCHAR2(1) Enter Y to indicate that the item on this line is an option item or option class. OPERATION_CODE VARCHAR2(30) Enter UPDATE or DELETE for existing order lines. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES.LINES INTERFACE MODEL_GROUP_NUMBER NUMBER This is for Internal use.ORDERED_QUANTITY Oracle Order Management Open Interface 2-31 .ORDER_SOURCE_ID ORDERED_QUANTITY NUMBER Enter the quantity ordered.ORDER_QUANTITY_UOM ORDER_SOURCE_ID NUMBER This is the ID of the Order Source which is typically defined using the Order Import Sources setup. You can also leave this column null for new imported lines. or enter INSERT for new imported lines.ORDER_SOURCE_ID ORDER_SOURCE_ID NUMBER This is the ID of the Order Source which is typically defined using the Order Import Sources setup.OPTION_FLAG OPTION_NUMBER NUMBER This is for Internal use. Destination: OE_ORDER_LINES.

ORIG_SYS_DOCUMENT_REF ORIG_SYS_DOCUMENT_REF VARCHAR2(50) Enter the order number or ID from your original feeder system. Destination: OE_ORDER_LINES.ORIG_SYS_DOCUMENT_REF ORIG_SYS_LINE_REF VARCHAR2(50) Enter the line ID from your feeder system. Destination: OE_ORDER_LINES.LINES INTERFACE ORDERED_QUANTITY_UOM2 VARCHAR2(3) Ordered Quantity secondary unit of measure. Destination: OE_ORDER_LINES.OVER_SHIP_REASON_CODE OVER_SHIP_RESOLVED_FLAG VARCHAR2(1) Flag to indicate that the over shipment beyond tolerance has been resolved.ORIG_SYS_SHIPMENT_REF OVER_SHIP_REASON_CODE VARCHAR2(30) Reason for over shipment beyond tolerance.ORIG_SYS_LINE_REF ORIG_SYS_SHIPMENT_REF VARCHAR2(50) Enter the shipment ID of the line from your feeder system. Destination: OE_ORDER_LINES.ORDERED_QUANTITY2 ORIG_SYS_DOCUMENT_REF VARCHAR2(50) Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES.ORDERED_QUANTITY_UOM2 ORDERED_QUANTITY2 NUMBER Ordered quantity in secondary inventory unit of measure. Destination: OE_ORDER_LINES.OVER_SHIP_RESOLVED_FLAG 2-32 Oracle Order Management Suite APIs and Open Interfaces Manual . The order number or ID you enter provides you with an audit trail from Order Import to your feeder system. Destination: OE_ORDER_LINES.

PRICE_LIST PRICE_LIST_ID NUMBER Enter the price list ID for the line. Destination: OE_ORDER_LINES.PREFERRED_GRADE PRICE_LIST VARCHAR2(240) Enter the name of the price list for the line. Destination: OE_ORDER_LINES. A different interface table for pricing attributes will be implemented in future PRICING_CONTEXT VARCHAR2(30) Not used. Destination: OE_ORDER_LINES. PRICING_QUANTITY NUMBER Enter the quantity in pricing UOM. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES. A different interface table for pricing attributes will be implemented in future.LINES INTERFACE PACKING_INSTRUCTIONS VARCHAR2(2000) Enter packing instructions for Line.PRICE_LIST_ID PRICING_ATTRIBUTE1-10 VARCHAR2(240) Not used.PRICING_QUANTITY_UOM Oracle Order Management Open Interface 2-33 .PRICING_QUANTITY PRICING_QUANTITY_UOM VARCHAR2(3) Enter the UOM in which the item is priced. Destination: OE_ORDER_LINES.PACKING_INSTRUCTIONS PREFERRED_GRADE VARCHAR2(4) Enter the preferred grade.

Destination: OE_ORDER_LINES. PROGRAM_ID NUMBER This column is for Internal use only.REFERENCE_LINE_ID 2-34 Oracle Order Management Suite APIs and Open Interfaces Manual . Destination: OE_ORDER_LINES.PROJECT_ID PROMISE_DATE DATE Enter the promise date.PROJECT PROJECT_ID NUMBER Enter the line’s project ID. Destination: OE_ORDER_LINES. Used for Project Manufacturing. Destination: OE_ORDER_LINES.LINES INTERFACE PROGRAM_APPLICATION_ID NUMBER This column is for Internal use only. REFERENCE_LINE_ID NUMBER Enter the Sales Order line id this return line references.PROMISE_DATE REFERENCE_HEADER VARCHAR2(30) This column is not used. PROJECT VARCHAR2(30) Enter the line’s project name. Used for Project Manufacturing. REFERENCE_HEADER_ID NUMBER Enter the Sales Order header id this return line references. PROGRAM_UPDATE_DATE DATE This column is for Internal use only. Destination: OE_ORDER_LINES.REFERENCE_HEADER_ID REFERENCE_LINE VARCHAR2(30) This column is not used.

Destination: OE_ORDER_LINES. SCHEDULE_ITEM_DETAIL VARCHAR2(30) Not Used. Destination: OE_ORDER_LINES. RETURN_ATTRIBUTE1. In order for records to be processed.LINES INTERFACE REQUEST_ID NUMBER This column is for internal use only. SCHEDULE_SHIP_DATE Date Enter the scheduled shipment date for the order line or use defaulting. Destination: OE_ORDER_LINES.15 VARCHAR2(240) Descriptive flexfield segments for the returns related flexfield.SALESREP_ID SCHEDULE_ARRIVAL_DATE DATE Enter the date the line will arrive at the ship to location.. their request ID must be null or equal to the request ID being processed. Destination: OE_ORDER_LINES. SALESREP_ID NUMBER Enter the sales representative’s ID. Destination: OE_ORDER_LINES.SCHEDULE_SHIP_DATE Oracle Order Management Open Interface 2-35 .15 RETURN_CONTEXT VARCHAR2(30) Enter the context for the returns related descriptive flexfield.. It is populated with the concurrent manager request ID for the run of the interface each time you submit the Order Import program.RETURN_ATTRIBUTE1.RETURN_CONTEXT SALESREP VARCHAR2(30) Enter the name of the Sales representative.SCHEDULE_ARRIVAL_DATE SCHEDULE_DATE DATE Not Used.

SERVICE_COTERMINATE_FLAG SERVICE_DURATION NUMBER Internal use only. Destination: OE_ORDER_LINES..15 SERVICE_CONTEXT VARCHAR2(30) Enter the context for the service related descriptive flexfield.SERVICE_ATTRIBUTE1.SERVICE_PERIOD SERVICE_REFERENCE_LINE VARCHAR2(50) The feeder system line number for the order specified in service_reference_order.15 VARCHAR2(240) Descriptive flexfield segments for the service related descriptive flexfield. Destination: OE_ORDER_LINES.SERVICE_CONTEXT SERVICE_COTERMINATE_FLAG VARCHAR2(1) Enter ‘Y’ if the service can be co-terminated or else enter ‘N’.SERVICE_END_DATE SERVICE_NUMBER NUMBER Internal Use. SERVICE_ATTRIBUTE1. Destination: OE_ORDER_LINES. 2-36 Oracle Order Management Suite APIs and Open Interfaces Manual . SERVICE_PERIOD VARCHAR2(3) Enter the period for which the service is offered. for which the service line is being imported. Destination: OE_ORDER_LINES.. SERVICE_END_DATE DATE Internal use only. Destination: OE_ORDER_LINES.LINES INTERFACE SCHEDULE_STATUS_CODE VARCHAR2(30) This is for Internal use.

You have to enter either the SHIP_FROM_ORG_ID or the SHIP_FROM_ORG name. Destination: OE_ORDER_LINES.SERVICE_TXN_REASON_CODE SERVICED_LINE_ID NUMBER Internal Use.SERVICE_START_DATE SERVICE_TXN_COMMENTS VARCHAR2(2000) Enter service related comments.SERVICE_TXN_COMMENTS SERVICE_TXN_REASON_CODE VARCHAR2(30) Enter service transaction reason code. Valid values are CUSTOMER_ PRODUCT and ORDER.SHIP_FROM_ORG_ID Oracle Order Management Open Interface 2-37 . Destination: OE_ORDER_LINES. SERVICE_REFERENCE_SYSTEM VARCHAR2(50) The customer system install base reference. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES.LINES INTERFACE SERVICE_REFERENCE_ORDER VARCHAR2(50) The feeder system order number. SERVICE_REFERENCE_TYPE_CODE VARCHAR2(30) Enter the code to identify the service reference type. which will be moved to service_ reference_system_id. for which the service line is being imported. SHIP_FROM_ORG_ID NUMBER Enter the organization ID from where the line is shipped.SERVICE_REFERENCE_TYPE_CODE SERVICE_START_DATE DATE Enter the start date for the service. Destination: OE_ORDER_LINES. SHIP_FROM_ORG VARCHAR2(30) Enter the name of the Organization from where the Line is shipped.

Generated based on the setting in MTL_SYSTEM_ITEMS. SHIP_SET_ID NUMBER Enter the ship set ID if the item belongs to a ship set. Destination: OE_ORDER_LINES. SHIP_TO_ADDRESS1-4 VARCHAR2(30) Enter the street address (using up to 4 lines. SHIP_TO_CONTACT_FIRST_NAME VARCHAR2(30) Not Used.SHIP_SET_ID SHIP_SET_NAME VARCHAR2(30) Enter the name of the ship set if the item belongs to a ship set. SHIP_TO_CONTACT_AREA_CODE3 VARCHAR2(10) Not Used. SHIP_TO_CONTACT VARCHAR2(30) Enter the name of your ship-to-contact. one in each column) for the line–level ship–to address if it differs from the address on the header. You have to enter either the SHIP_SET_ID or the SHIP_SET name if you want this line to go into a ship set. SHIP_TO_CITY VARCHAR2(30) Enter the city for the line–level ship–to address if it differs from the address on the header. 2-38 Oracle Order Management Suite APIs and Open Interfaces Manual . SHIP_TO_CONTACT_AREA_CODE1 VARCHAR2(10) Not Used. SHIP_TO_CONTACT_AREA_CODE2 VARCHAR2(10) Not Used.LINES INTERFACE SHIP_MODEL_COMPLETE_FLAG VARCHAR2(1) This is for Internal use.

SHIP_TO_COUNTY VARCHAR2(30) Enter the county for the line–level ship–to address if it differs from the address on the header. SHIP_TO_ORG_ID NUMBER Enter the site use id where the line to be shipped for the customer. SHIP_TO_STATE VARCHAR2(30) Enter the state or province for the line–level ship–to address if it differs from the address on the header. SHIP_TO_COUNTRY VARCHAR2(30) Enter the country for the line–level ship–to address if it differs from the address on the header. SHIP_TO_CONTACT_LAST_NAME VARCHAR2(30) Not Used. Destination: OE_ORDER_LINES.SHIP_TO_CONTACT_ID SHIP_TO_CONTACT_JOB_TITLE VARCHAR2(30) Not Used. SHIP_TO_ORG VARCHAR2(30) Not Used.SHIP_TO_ORG_ID SHIP_TO_POSTAL_CODE VARCHAR2(30) Enter the post code for the line–level ship–to address if it differs from the address on the header. SHIP_TOLERANCE_ABOVE NUMBER Supply tolerance percentage value for overshipments Oracle Order Management Open Interface 2-39 .LINES INTERFACE SHIP_TO_CONTACT_ID NUMBER Enter the contact ID for your ship–to contact. Destination: OE_ORDER_LINES.

SHIPPING_INSTRUCTIONS SHIPPING_METHOD VARCHAR2(30) Not used. Destination: OE_ORDER_LINES. if you are importing this order as complete. Destination: OE_ORDER_LINES.SHIPMENT_NUMBER SHIPMENT_PRIORITY VARCHAR2(30) Not Used.SHIP_TOLERANCE_ABOVE SHIP_TOLERANCE_BELOW NUMBER Supply tolerance percentage value for undershipments.SHIPPED_QUANTITY2 SHIPPING_INSTRUCTIONS VARCHAR2(2000) Enter the shipping instructions for Line. Destination: OE_ORDER_LINES.SHIP_TOLERANCE_BELOW SHIPMENT_NUMBER NUMBER Enter the shipment sequence number within the Line.SHIPMENT_PRIORITY_CODE SHIPPED_QUANTITY NUMBER Enter the shipped quantity. If you enter a shipped quantity on an open order it is ignored. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES.SHIPPED_QUANTITY SHIPPED_QUANTITY2 NUMBER Enter the quantity shipped in secondary UOM.LINES INTERFACE Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES. SHIPMENT_PRIORITY_CODE VARCHAR2(30) Enter the shipment priority for the line or use defaulting. 2-40 Oracle Order Management Suite APIs and Open Interfaces Manual .

Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES.LINES INTERFACE SHIPPING_METHOD_CODE VARCHAR2(30) Enter the Shipping Method for the line or use defaulting. Destination: OE_ORDER_LINES.SOLD_FROM_ORG_ID SOLD_TO_ORG VARCHAR2(30) Enter the name of the sold to org.SOLD_TO_ORG_ID Oracle Order Management Open Interface 2-41 .SHIPPING_METHOD_CODE SHIPPING_QUANTITY NUMBER Enter the shipping quantity. SOLD_FROM_ORG_ID NUMBER Supply the id information for sold from. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES.SHIPPING_QUANTITY_UOM SHIPPING_QUANTITY_UOM2 VARCHAR2(3) Enter the secondary unit of measure the item is shipped.SHIPPING_QUANTITY_UOM2 SOLD_FROM_ORG VARCHAR2(30) Not Used.SHIPPING_QUANTITY2 SHIPPING_QUANTITY_UOM VARCHAR2(3) Enter the shipping quantity UOM.SHIPPING_QUANTITY SHIPPING_QUANTITY2 NUMBER Enter the shipping quantity in secondary UOM. SOLD_TO_ORG_ID NUMBER Enter the Customer ID. Destination: OE_ORDER_LINES.

Tax code is required if the Tax Exempt Flag on the order is R or the 2-42 Oracle Order Management Suite APIs and Open Interfaces Manual . Destination: OE_ORDER_LINES.LINES INTERFACE SORT_ORDER VARCHAR2(240) This is for Internal use. STATUS_FLAG VARCHAR2(1) Internal use. If you enter different values in SOURCE_TYPE_CODE and in SOURCE_TYPE_NAME.SUBINVENTORY TASK VARCHAR2(30) Enter the line’s task name. SOURCE_TYPE_CODE VARCHAR2(30) Enter INTERNAL or EXTERNAL to specify whether this line will be sourced internally or externally.SOURCE_TYPE_CODE SPLIT_FROM_LINE_ID NUMBER This column is for Internal use. TAX_CODE VARCHAR2(30) If Value Added Tax is applicable. Destination: OE_ORDER_LINES. Used for Project Manufacturing. Destination: OE_ORDER_LINES.TASK_ID TAX VARCHAR2(50) Not used. the value in SOURCE_TYPE_NAME is used. you must either enter a value for SOURCE_TYPE_NAME or specify a source type in the Sales Orders window after you import your order.TASK TASK_ID NUMBER Enter the line’s task ID. enter the tax code for the order line or accept the default. Destination: OE_ORDER_LINES. If you leave this value null. SUBINVENTORY VARCHAR2(10) Enter the sub inventory from where you want the item to be picked from.

TAX_EXEMPT_REASON_CODE TAX_POINT VARCHAR2(30) This column is for Internal use only.TAX_CODE TAX_DATE DATE Enter the date on which the tax was computed.LINES INTERFACE Receivables Transaction Type associated with the order type requires tax calculation. Destination: OE_ORDER_LINES.TAX_VALUE Oracle Order Management Open Interface 2-43 .TAX_EXEMPT_NUMBER TAX_EXEMPT_REASON VARCHAR2(30) Enter the tax exempt reason.TAX_DATE TAX_EXEMPT_FLAG VARCHAR2(1) Enter the tax exempt indicator. Destination: OE_ORDER_LINES. TAX_POINT_CODE VARCHAR2(30) This column is for Internal use only. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES.TAX_EXEMPT_FLAG TAX_EXEMPT_NUMBER VARCHAR2(80) Enter the tax exemption certificate number. TAX_VALUE NUMBER Enter the amount of Tax. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES. TAX_EXEMPT_REASON_CODE VARCHAR2(30) Enter the tax exemption reason code.

UNIT_PERCENT_BASE_PRICE UNIT_SELLING_PERCENT NUMBER This column is for Internal use only. UNIT_SELLING_PRICE NUMBER Enter the selling price per unit for the order line or use automatic pricing. This column is required if you enter No in the CALCULATE_PRICE_FLAG column.15 TP_CONTEXT VARCHAR2(30) Enter the context for the RLM related flexfield. Destination: OE_ORDER_LINES. Destination: OE_ORDER_LINES. option classes and optional standard items.LINES INTERFACE TOP_MODEL_LINE_REF VARCHAR2(50) Enter the Original System Line Reference of the line for the item that is the top level item of the BOM to which the item in this line belongs.. Destination: OE_ORDER_LINES.. This column is required if you enter No in the CALCULATE_PRICE_FLAG column.) TP_ATTRIBUTE1. This only needs to be populated for option items. UNIT_PERCENT_BASE_PRICE NUMBER Enter the base price used for percent based pricing.TP_CONTEXT UNIT_LIST_PERCENT NUMBER This column is for Internal use only.TP_ATTRIBUTE1. 2-44 Oracle Order Management Suite APIs and Open Interfaces Manual .15 VARCHAR2(240) Descriptive flexfield segments for the RLM related flexfield.UNIT_LIST_PRICE UNIT_LIST_PRICE_PER_PQTY NUMBER Not Used. Destination: OE_ORDER_LINES. (This does not need to be entered for the top–level item. UNIT_LIST_PRICE NUMBER Enter the list price per unit for the order line or use automatic pricing.

Oracle Order Management Open Interface 2-45 .UNIT_SELLING_PRICE UNIT_SELLING_PRICE_PER_PQTY NUMBER Not Used.LINES INTERFACE Destination: OE_ORDER_LINES. VEH_CUS_ITEM_CUM_KEY_ID NUMBER This is for Internal use.

ATTRIBUTE1–15 AUTOMATIC_FLAG VARCHAR2(1) Indicates if the discount was applied automatically 2-46 Oracle Order Management Suite APIs and Open Interfaces Manual .PRICE ADJUSTMENT INTERFACE PRICE ADJUSTMENT INTERFACE AC_ATTRIBUTE1 – 15 VARCHAR2(150) Enter any information you wish to pass to the additional charges descriptive flexfield columns in OE_PRICE_ADJUSTMENTS. which are not yet applied by the user. Used for manual discounts .ARITHMETIC_OPERATOR ATTRIBUTE1 – 15 VARCHAR2(150) Enter any information you wish to pass to the descriptive flexfield columns in OE_ PRICE_ADJUSTMENTS.APPLIED_FLAG ARITHMETIC_OPERATOR NUMBER Qualifies the value in operand . Destination: OE_PRICE_ADJUSTMENTS.ADJUSTED_AMOUNT APPLIED_FLAG NUMBER Tells .AC_CONTEXT ADJUSTED_AMOUNT NUMBER Stores the adjusted amount for the adjustment level Destination: OE_PRICE_ADJUSTMENTS. Destination: OE_PRICE_ADJUSTMENTS.AC_ATTRIBUTE1–15 AC_CONTEXT VARCHAR2(30) Enter the context for your additional charges descriptive flexfield attributes if you have enabled a context–sensitive pricing descriptive flexfield in OE_PRICE_ ADJUSTMENTS. Destination: OE_PRICE_ADJUSTMENTS.Amount or a New Price) Destination: OE_PRICE_ADJUSTMENTS. ( % . Destination: OE_PRICE_ADJUSTMENTS. if the adjustment has been applied to the order line.

CHANGE_SEQUENCE VARCHAR2(50) Send the change sequence for the adjustment.CONTEXT Oracle Order Management Open Interface 2-47 .CHANGE_SEQUENCE CHARGE_SUBTYPE_CODE NUMBER Charge Sub Type Code Destination: OE_PRICE_ADJUSTMENTS. Destination: OE_PRICE_ADJUSTMENTS.CHARGE_TYPE_CODE CONTEXT VARCHAR2(30) Enter the context for your descriptive flexfield attributes if you have enabled a context–sensitive descriptive flexfield in OE_PRICE_ADJUSTMENTS.PRICE ADJUSTMENT INTERFACE Destination: OE_PRICE_ADJUSTMENTS.AUTOMATIC_FLAG CHANGE_COMMENT VARCHAR2(2000) Future use.CHANGE_REASON_TEXT CHANGE_REQUEST_CODE VARCHAR2(30) Future use.CHARGE_SUBTYPE_CODE CHARGE_TYPE_CODE NUMBER Type code of charge Destination: OE_PRICE_ADJUSTMENTS. CHANGE_REASON_CODE VARCHAR2(30) User entered reason code for making a change to the adjustment value Destination: OE_PRICE_ADJUSTMENTS.CHANGE_REASON_CODE CHANGE_REASON_TEXT VARCHAR2(30) User entered free format text for making a change to the adjustment value Destination: OE_PRICE_ADJUSTMENTS. Destination:OE_PRICE_ADJUSTMENTS.

CREATION_DATE CREDIT_OR_CHARGE_FLAG NUMBER Indicates if the adjustment record is a credit or charge to a customer. Destination: OE_PRICE_ADJUSTMENTS. Destination:OE_PRICE_ADJUSTMENTS. Enter the date on which you originally entered the data into your feeder system. Destination: OE_PRICE_ADJUSTMENTS.CREATED_BY CREATION_DATE Not Null DATE.CREDIT_OR_CHARGE_FLAG DISCOUNT_ID NUMBER Not Used.ESTIMATED_FLAG 2-48 Oracle Order Management Suite APIs and Open Interfaces Manual . ESTIMATED_FLAG NUMBER Flag indicating whether the charge amount is estimated or fixed.COST_ID CREATED_BY Not Null NUMBER Enter an identification number that you can use to identify the user who created the record.PRICE ADJUSTMENT INTERFACE COST_ID NUMBER COST ID. Y means an error occurred when importing this order. Destination:OE_PRICE_ADJUSTMENTS. ERROR_FLAG VARCHAR2(1) This column is used internally. Destination: OE_PRICE_ADJUSTMENTS. DISCOUNT_NAME VARCHAR2(30) Not Used. DISCOUNT_LINE_ID NUMBER Not Used.

Destination: OE_PRICE_ADJUSTMENTS. Destination: OE_PRICE_ADJUSTMENTS.PRICE ADJUSTMENT INTERFACE INC_IN_SALES_PERFORMANCE NUMBER Flag indicating whether the charge should be included in Sales Performance calculation. Destination: OE_PRICE_ADJUSTMENTS.LAST_UPDATE_LOGIN LAST_UPDATED_BY Not Null NUMBER Enter an identification number that you can use to identify the user who created or who most recently modified the record. Destination: OE_PRICE_ADJUSTMENTS.INC_IN_SALES_PERFORMANCE INTERFACE_STATUS VARCHAR2(1000) Not Used INVOICED_FLAG NUMBER Flag indicating whether the charge is invoiced or not.LIST_HEADER_ID Oracle Order Management Open Interface 2-49 .LAST_UPDATED_BY LIST_HEADER_ID NUMBER Enter the discount ID which matches the discount name you want to use for this order line. Destination: OE_PRICE_ADJUSTMENTS.PRICE_LIST_ID. Internal Use. If you enter a value here.LAST_UPDATE_DATE LAST_UPDATE_LOGIN NUMBER Enter an identification number that you can use to identify the feeder system that is supplying Order Management with this data. LAST_UPDATE_DATE Not Null DATE Enter the current date on which you are entering data into your feeder system. you must also supply a value for OE_ HEADERS_INTERFACE.

e.PRICE ADJUSTMENT INTERFACE LIST_LINE_ID NUMBER Enter the discount line ID which matches the discount name you want to use for this order line.PRICE_LIST_ID.MODIFIED_TO MODIFIER_MECHANISM_TYPE_CODE VARCHAR2(30) Not Used. to which an item was upgraded Destination: OE_PRICE_ADJUSTMENTS.g. ‘DIS’. If you enter a value here. Qualified by Arithmetic_Operator Destination:OE_PRICE_ADJUSTMENTS. Destination:OE_PRICE_ADJUSTMENTS.MODIFIED_FROM MODIFIED_TO NUMBER Used for Storing Value of the item code. Destination: OE_PRICE_ADJUSTMENTS.LIST_LINE_TYPE_CODE LIST_NAME VARCHAR2(240) Enter the discount Name which matches the discount you want to use for this order. MODIFIED_FROM NUMBER Used for storing value of the item code. you must also supply a value for OE_ HEADERS_INTERFACE.OPERAND 2-50 Oracle Order Management Suite APIs and Open Interfaces Manual . OPERAND NUMBER Stores the Adjustment value . LIST_LINE_TYPE_CODE VARCHAR2(30) Line Type of the Modifier. which was upgraded Destination: OE_PRICE_ADJUSTMENTS.LIST_LINE_ID LIST_LINE_NUMBER VARCHAR2(30) This column in combination of version_number and list name can be used to pass the name for the list line instead of passing list line id. ‘SUR’ and ‘TAX’.

ORDER_SOURCE_ID Not Null NUMBER Enter the order import source ID. Destination: OE_PRICE_ADJUSTMENTS. enter the line ID from your feeder system. If this is an order–level discount. Oracle Order Management Open Interface 2-51 . This is one of the column of the primary key. enter the sales discount ID from your feeder system. ORIG_SYS_LINE_REF VARCHAR2(50) If the discount applies to the order line. Based on the combination of this with other columns of the key the relation with the parent record is resolved. For Update this column in combination of ORIG_SYS_DOCUMENT_REF and ORIG_ SYS_LINE_REF(if line level discount) will be used to confirm the existence of the discount line.PRICE ADJUSTMENT INTERFACE OPERATION_CODE VARCHAR2(30) Enter UPDATE or DELETE for existing price adjustments. or enter INSERT for new imported price adjustments. You can also leave this column null for new imported price adjustments.ORIG_SYS_DISCOUNT_REF ORIG_SYS_DOCUMENT_REF Not Null VARCHAR2(50) Enter the order number or ID from your feeder system. leave this column null.PARENT_ADJUSTMENT_ID PERCENT NUMBER Not Used. ORIG_SYS_DISCOUNT_REF VARCHAR2(50) If the discount applies. ORIG_SYS_SHIPMENT_REF VARCHAR2(50) Not used PARENT_ADJUSTMENT_ID NUMBER Adjustment ID for the parent record in the case of Tax on charge. Destination: OE_PRICE_ADJUSTMENTS.

UPDATED_FLAG NUMBER For the Manual adjustment it should be passed as “Y”. TAX_CODE NUMBER Tax code defined for the Charges. PROGRAM_ID NUMBER(15) This column is for internal use only. REQUEST_ID NUMBER This column is for internal use only. In order for records to be processed. It is populated with the concurrent manager request ID for the interface run each time you submit the Order Import program.TAX_CODE UPDATE_ALLOWED NUMBER Internal Use. 2-52 Oracle Order Management Suite APIs and Open Interfaces Manual .PRICE ADJUSTMENT INTERFACE PRICING_PHASE_ID NUMBER Phase Id . in which this adjustment was created PROGRAM_APPLICATION_ID NUMBER(15) This column is for internal use only. PROGRAM_UPDATE_DATE DATE This column is for internal use only. STATUS_FLAG VARCHAR2(1) This columns is not used.UPDATED_FLAG VERSION_NUMBER NUMBER Version of the List Name. Destination: OE_PRICE_ADJUSTMENTS. their request IDs must be null or equal to the request ID being processed. Destination:OE_PRICE_ADJUSTMENTS.

Destination:OE_SALES_CREDITS. CHANGE_SEQUENCE VARCHAR2(50) Future use. Enter the date on which you originally entered the data into your feeder system.CONTEXT CREATED_BY Not Null NUMBER Enter an identification number that you can use to identify the user who created the record. CHANGE_REASON VARCHAR2(30) Future use. Destination:OE_SALES_CREDITS. CHANGE_REQUEST_CODE VARCHAR2(30) Future use.ATTRIBUTE1 – 15 CHANGE_COMMENT VARCHAR2(2000) Future use.CREATION_DATE Oracle Order Management Open Interface 2-53 .SALES CREDITS INTERFACE SALES CREDITS INTERFACE ATTRIBUTE1 – 15 VARCHAR2(150) Enter any information you wish to pass to the descriptive flexfield column in OE_ SALES_CREDITS.CREATED_BY CREATION_DATE Not Null DATE. Destination:OE_SALES_CREDITS. CONTEXT VARCHAR2(30) Enter the context for your descriptive flexfield information if you have enabled a context–sensitive descriptive flexfield in OE_SALES_CREDITS. Destination:OE_SALES_CREDITS.

INTERFACE_STATUS VARCHAR2(1000) Not Used. ORDER_SOURCE_ID Not Null NUMBER Enter the order import source ID.LAST_UPDATED_BY OPERATION_CODE VARCHAR2(30) Enter UPDATE or DELETE for existing sales credits. This is one of the column of the primary key. LAST_UPDATE_DATE Not Null DATE Enter the current date on which you are entering data into your feeder system. or enter INSERT for new imported sales credits. You can also leave this column null for new imported sales credits. Destination: OE_SALES_CREDITS. if a Y is generated it means an error occurred when importing the order. Destination: OE_SALES_CREDITS. Destination: None 2-54 Oracle Order Management Suite APIs and Open Interfaces Manual . Destination: OE_SALES_CREDITS.LAST_UPDATE_DATE LAST_UPDATE_LOGIN NUMBER Enter an identification number that you can use to identify the feeder system that is supplying Order Management with this data.LAST_UPDATE_LOGIN LAST_UPDATED_BY Not Null NUMBER Enter an identification number that you can use to identify the user who created or who most recently modified the record.SALES CREDITS INTERFACE ERROR_FLAG VARCHAR2(1) This column is used internally. Based on the combination of this with other columns of the key the relation with the parent record is resolved.

Used to determine in combination of other key columns the relationship with parent record. Destination:OE_SALES_CREDITS.SALES CREDITS INTERFACE ORIG_SYS_CREDIT_REF VARCHAR2(50) If the sales credit applies.ORIG_SYS_CREDIT_REF ORIG_SYS_DOCUMENT_REF Not Null VARCHAR2(50) Enter the order number or ID from your feeder system. In combination for the above reference column. it will be used to get the ids for the existing sales credits. enter the sales credit ID from your feeder system. It is populated with the concurrent manager request ID for the interface run each time you submit the Order Import program. Destination: OE_SALES_CREDITS. PROGRAM_UPDATE_DATE DATE This column is for internal use only. PROGRAM_ID NUMBER(15) This column is for internal use only. QUOTA_FLAG VARCHAR2(1) Leave this field null. it is derived from the SALES_CREDIT_TYPE column. Oracle Order Management Open Interface 2-55 . REQUEST_ID NUMBER This column is for internal use only. Destination: None PERCENT Not Null NUMBER Enter the percent of the sales credit type you are assigning to the salesperson. In order for records to be processed. The total quota credit must always equal 100% for each line and for the header.PERCENT PROGRAM_APPLICATION_ID NUMBER(15) This column is for internal use only. their request IDs must be null or equal to the request ID being processed (only when using Import button of the Correction Form).

If you want multiple credits.SALESREP_ID STATUS_FLAG VARCHAR2(1) This columns is not used.SALE_CREDIT_TYPE_ID SALESREP VARCHAR2(30) Enter the name of the salesperson to whom you are assigning the sales credit. Destination:OE_SALES_CREDITS. 2-56 Oracle Order Management Suite APIs and Open Interfaces Manual .SALES CREDITS INTERFACE SALES_CREDIT_TYPE VARCHAR2(30) Enter the name of the sales credit type you are assigning to the salesrep (such as Quota Sales Credit or Nonquota Sales Credit). Destination: OE_SALES_CREDITS. Either of the value can be specified if both values are passed a warning message will be issued that both id and value exists and id will be used. SALESREP_ID NUMBER Enter the salesrep ID that matches the SALESREP_NAME you entered. SALES_CREDIT_TYPE_ID NUMBER Enter the SALES_CREDIT_TYPE_ID for the SALES_CREDIT_TYPE you entered. you must have multiple records in the oe_credits_interface table. The total quota credit must always equal 100% for each line and for the header.

Oracle Order Management Open Interface 2-57 . LOT_NUMBER VARCHAR2(30) Pass the lot number you want to use to reserve the corresponding line item. You can also leave this column null for new imported sales credits. OPERATION_CODE VARCHAR2(30) Enter UPDATE or DELETE for existing sales credits. ERROR_FLAG VARCHAR2(1) This column is used internally. LOCATOR_ID NUMBER Future use. LOT_NUMBER_ID NUMBER Future use. INTERFACE_STATUS VARCHAR2(1000) This column is used internally to store information about any invalid data. For Future use. ATTRIBUTE1 – 15 VARCHAR2(150) Enter any information you wish to pass to the reservation descriptive flexfield CHANGE_SEQUENCE VARCHAR2(50) Future use. or enter INSERT for new imported sales credits. if a Y is generated it means an error occurred when importing the order. INVENTOR_ITEM_ID NUMBER Inventory Item Id for the Item to be reserved.RESERVATION INTERFACE RESERVATION INTERFACE ATTRIBUTE_CATEGORY VARCHAR2(30) Enter the context for your reservation descriptive flexfield attributes.

enter the line ID from your feeder system. Based on the combination of this with other columns of the key the relation with the parent record is resolved. leave this column null. their request IDs must be null or equal to the request ID being processed (only when using Import button of the Correction Form). Used to determine in combination of other key columns the relationship with parent record. QUANTITY NUMBER Quantity of the item to be reserved.RESERVATION INTERFACE ORDER_SOURCE_ID Not Null NUMBER Enter the order import source ID. REQUEST_ID NUMBER This column is for internal use only. ORIG_SYS_LINE_REF VARCHAR2(50) If the sales credit applies to the order line. ORIG_SYS_DOCUMENT_REF Not Null VARCHAR2(50) Enter the order number or ID from your feeder system. This is one of the column of the primary key. enter the sales credit ID from your feeder system. In order for records to be processed. SUBINVENTORY_CODE VARCHAR2(10) For reserving the item from sub-inventory provide value for this column. Destination:This sub-inventory will be used for reserving the item. SUBINVENTORY_ID NUMBER Future use. If this is an order–level discount. 2-58 Oracle Order Management Suite APIs and Open Interfaces Manual . It is populated with the concurrent manager request ID for the interface run each time you submit the Order Import program. REVISION VARCHAR2(3) Future use. ORIG_SYS_RESERVATION_REF VARCHAR2(50) If the sales credit applies.

END_DATE_ACTIVE DATE Not Used. CHANGE_SEQUENCE VARCHAR2(50) Future use. For Future use. COMMENTS VARCHAR2(240) Future use. DESCRIPTION VARCHAR2(240) Not Used.ACTIONS INTERFACE ACTIONS INTERFACE ATTACHMENT_ID NUMBER Not Used. ATTRIBUTE1 – 15 VARCHAR2(150) Enter any information you wish to pass to the action descriptive flexfield CATEGORY_ID NUMBER Not Used. DOCUMENT_TEXT VARCHAR2(2000) Not Used. Oracle Order Management Open Interface 2-59 . ENTITY_CODE VARCHAR2(50) Internal Use. DOCUMENT_ID NUMBER Not Used. CONTEXT VARCHAR2(30) Enter the context for your action descriptive flexfield attributes.

OPERATION_CODE VARCHAR2(30) AUTOMATIC_ATCHMT For applying automatic attachment BOOK_ORDER For Booking the Order APPLY_HOLD For Applying the Holds RELEASE_HOLD For Releasing the Holds LINK_CONFIG For Linking the Config items DELINK_CONFIG For De-linking the Config Items MATCH_AND_RESERVE Match and Reserve for Config Items 2-60 Oracle Order Management Suite APIs and Open Interfaces Manual . HOLD_ID NUMBER Hold Id. HOLD_TYPE_CODE VARCHAR2(1) Hold Type Code. ERROR_FLAG VARCHAR2(1) This column is used internally. if it is available then the ENTITY_CODE will be set to OE_GLOBAL.G_ENTITY_HEADER. ENTITY_INDEX VARCHAR2(50) Internal Use.G_ENTITY_LINE else it is set to OE_ GLOBAL. HOLD_TYPE_ID NUMBER Hold Type Id HOLD_UNTIL_DATE DATE Hold Until Date. INTERFACE_STATUS VARCHAR2(1000) Not Used.ACTIONS INTERFACE Depending on the value of the ORIG_SYS_LINE_REF. if a Y is generated it means an error occurred when importing this order.

ORIG_SYS_CREDIT_REF VARCHAR2(50) Future Use.ACTIONS INTERFACE ORDER_SOURCE_ID Not Null NUMBER Enter the order import source ID. leave this column null. It is populated with the concurrent manager request ID for the interface run each time you submit the Order Import program. ORIG_SYS_DOCUMENT_REF Not Null VARCHAR2(50) Enter the order number or ID from your feeder system. This is one of the column of the primary key. Used to determine in combination of other key columns the relationship with parent record. ORIG_SYS_DISCOUNT_REF VARCHAR2(50) Future Use. RELEASE_REASON_CODE VARCHAR2(30) Used when the operation code is RELEASE_HOLD. In order for records to be processed. ORIG_SYS_SHIPMENT_REF VARCHAR2(50) Future Use. If this is an order–level discount. their request IDs must be null or equal to the request ID being processed (only when using Import button of the Correction Form). Oracle Order Management Open Interface 2-61 . REQUEST_ID NUMBER This column is for internal use only. ORIG_SYS_LOTSERIAL_REF VARCHAR2(50) Future Use. Based on the combination of this with other columns of the key the relation with the parent record is resolved. ORIG_SYS_LINE_REF VARCHAR2(50) If the sales credit applies to the order line. enter the line ID from your feeder system.

ACTIONS INTERFACE SECURITY_ID NUMBER Not Used. SECURITY_TYPE VARCHAR2(30) Not Used. STATUS_FLAG VARCHAR2(1) Not Used 2-62 Oracle Order Management Suite APIs and Open Interfaces Manual . START_DATE_ACTIVE DATE Not Used.

CHANGE_SEQUENCE VARCHAR2(50) Not Used. Enter the date on which you originally entered the data into your feeder system. Destination: OE_LOT_SERIAL_NUMBERS.LOTSERIAL INTERFACE LOTSERIAL INTERFACE ATTRIBUTE1 – 15 VARCHAR2(240) Enter any information you wish to pass to the lotserial descriptive flexfield CHANGE_REQUEST_CODE VARCHAR2(50) Not Used. Oracle Order Management Open Interface 2-63 . FROM_SERIAL_NUMBER NUMBER Enter From Serial Number Destination: OE_LOT_SERIAL_NUMBERS. CONTEXT VARCHAR2(30) Enter the context for your lotserial descriptive flexfield attributes.FROM_SERIAL_NUMBER INTERFACE_STATUS VARCHAR2(1000) Not Used. if a Y is generated it means an error occurred when importing the order. CREATED_BY Not Null NUMBER Enter an identification number that you can use to identify the user who created the record. Destination: OE_LOT_SERIAL_NUMBERS.CREATED_BY CREATION_DATE Not Null DATE.CREATION_DATE ERROR_FLAG VARCHAR2(1) This column is used internally.

This is one of the column of the primary key. or enter INSERT for new imported lotserials. You can also leave this column null for new imported lotserials.LOTSERIAL INTERFACE LAST_UPDATE_DATE Not Null DATE Enter the current date on which you are entering data into your feeder system. ORDER_SOURCE_ID Not Null NUMBER Enter the order import source ID. Destination: OE_LOT_SERIAL_NUMBERS. Destination: OE_LOT_SERIAL_NUMBERS. Based on the combination of this with other columns of the key the relation with the parent record is resolved. ORIG_SYS_DOCUMENT_REF Not Null VARCHAR2(50) Enter the order number or ID from your feeder system. for which this lot is returned. Destination: OE_LOT_SERIAL_NUMBERS.LAST_UPDATE_DATE LAST_UPDATE_LOGIN NUMBER Enter an identification number that you can use to identify the feeder system that is supplying Order Management with this data. 2-64 Oracle Order Management Suite APIs and Open Interfaces Manual .LOT_NUMBER OPERATION_CODE VARCHAR2(30) Enter UPDATE or DELETE for existing lotserials. Used to determine in combination of other key columns the relationship with parent record.LAST_UPDATE_LOGIN LAST_UPDATED_BY Not Null NUMBER Enter an identification number that you can use to identify the user who created or who most recently modified the record. ORIG_SYS_LINE_REF VARCHAR2(50) Enter the line ID from your feeder system. Destination: OE_LOT_SERIAL_NUMBERS.LAST_UPDATED_BY LOT_NUMBER NUMBER Enter the Lot information.

PROGRAM_ID NUMBER(15) This column is for internal use only. QUANTITY NUMBER Enter the returned quantity for particular lot or serials.ORIG_SYS_LOTSERIAL_REF ORIG_SYS_SHIPMENT_REF VARCHAR2(50) Future Use. Destination: OE_LOT_SERIAL_NUMBERS. It is populated with the concurrent manager request ID for the interface run each time you submit the Order Import program. STATUS_FLAG VARHAR2(1) Not Used.LOTSERIAL INTERFACE ORIG_SYS_LOTSERIAL_REF VARCHAR2(50) Enter the id for the lot and serial table from your feeder system. Destination: OE_LOT_SERIAL_NUMBERS. their request IDs must be null or equal to the request ID being processed (only when using Import button of the Correction Form). Destination: OE_LOT_SERIAL_NUMBERS. PROGRAM_APPLICATION_ID NUMBER(15) This column is for internal use only. In order for records to be processed.QUANTITY REQUEST_ID NUMBER This column is for internal use only. 1 to 10. TO_SERIAL_NUMBER NUMBER Enter To Serial Number. e.TO_SERIAL_NUMBER Oracle Order Management Open Interface 2-65 . PROGRAM_UPDATE_DATE DATE This column is for internal use only. Only make sense when the serial from and to are in sequence.g.

If the sales order form is invoked in the query mode then user will be allowed to view only the data. sold_to_ customer_id.Calling The Sales Order Form From Other Modules Calling The Sales Order Form From Other Modules Overview The sales order form can be invoked from other modules by calling the fnd_ function. header_id of the sales order. header_id of the sales order. sold_ to_contact_id Order Organizer: View ONT_OEXOEORD_VW Sales Orders The sales order form can be called either in a query only mode or in an normal mode.execute procedure with the function name. User Function Name Sales Orders Additional Parameters Accepted None Internal Function Name ONT_OEXOEORD Form Sales Orders Default Parameters STARTUP_ MODE=SALES_ ORDERS Order Organizer ONT_OEXOEORD_ SUMMARY Sales Orders Startup_mode. There are some predefined seeded functions provided by Order Management. The value for the parameter Query_Only will identify if the sales order form is invoked in the query only mode or not. All the data blocks will be set to read only. The sales order form can be invoked in different formats depending on the value that is passed for the startup_mode parameter. The default value for the Query_only parameter is “No”.e Either the Order Organizer or the sales order form is opened depending on the value being passed for the startup_ mode. The following are the valid values for startup_mode parameter along with format in which the sales order form is opened. sold_ to_contact_id QUERY_ONLY=YES Startup_mode. Please review the following table for the list of some of the seeded functions that OM supports. 2-66 Oracle Order Management Suite APIs and Open Interfaces Manual . sold_to_ customer_id. i. If the sales order form is invoked in the normal mode then users can enter/update the data in the sales order form.

Oracle Order Management Open Interface 2-67 . OPEN_FLAG => 'Y'. Ex: FND_FUNCTION. If the function is seeded with a default startup_ mode parameter then the callers are not allowed to overwrite the value for this parameter. sold_to_contact_id. created by the OTA. “INVENTORY”. sold_to_customer_id. OTHER_PARAMS => 'HEADER_ID ="' ||l_header_id|| '" STARTUP_MODE="' ||'CRM'|| '"'). “OTA”. Default Value for the startup_mode parameter is “GATEWAY” if there is no value passed while calling the function. SESSION_FLAG => 'N'. Order Organizer with appropriate data queried depending on the other additional parameters INVENTORY Order Organizer with appropriate data queried depending on the other additional parameters CRM Order Organizer with appropriate data queried depending on the other additional parameters ORDER_PURGE OTA Order Organizer Sales Order Form with the order queried. Sales Order Form Order Organizer with cursor in the Lines Summary tab. Callers can pass additional parameters while calling the sales order form function. The values passed for these parameters will be used for querying the appropriate data and displayed in the format determined by the startup_mode. These additional parameters are valid only for the “CRM”. “PURCHASING”.Calling The Sales Order Form From Other Modules Startup Mode Default Window Opened (Format) GATEWAY SALES_ORDERS RLM PURCHASING Order Organizer with Find Window on the top.EXECUTE (FUNCTION_NAME => 'ONT_OEXOEORD_SUMMARY' . “RLM” startup_modes. These additional parameters are not valid for some of the startup_modes. The additional parameters that can be passed for some of the functions are header_ id.

applying and releasing of order holds. You can use the Order Import Correction window to examine the order and optionally correct data if it fails the import process. change. and completed sales orders or returns from other applications such as a legacy system. Note: You cannot specify a value in the DROP_SHIP column of the OE_HEADERS_IFACE_ALL. Transaction Sources Importing from External Systems You can define order numbering in the Define Document Sequences window. 2-68 Oracle Order Management Suite APIs and Open Interfaces Manual .Integrating Oracle Order Management Using Order Import Integrating Oracle Order Management Using Order Import Order Import is an Order Management Open Interface that consists of open interface tables and a set of APIs. scheduling of shipments. Each time you run Order Import. and sales credits in the base Order Management tables. Order Management checks all the data during the import process to ensure its validity within Order Management. Valid transactions are then converted into orders with lines. price adjustments. Order Import can import new. The orders may come from any source such as EDI transactions that are processed by the Oracle e-Commerce Gateway or internal orders created for internal requisitions developed in Oracle Purchasing or returns. the Order Import concurrent program will fail. updating or deleting the orders in the base Order Management tables. Order Management produces a summary of information letting you know of the total number of orders that Order Import evaluates. Order Import features include validation and defaulting. processing constraint checks. If you enter a value in this column. the internal sales orders are processed as regular sales orders. then ultimately inserting. Once imported. reservations. You can use the Error Message window to determine if your data failed to import. Internal Sales Orders Oracle Purchasing uses Order Import to transfer requisitions for internally sourced products to Order Management. and succeeded or failed.

based on certain common attributes for a new or existing order. if any line attribute. You can update or delete orders. You will need to provide the set ID or name in the Order Import tables. which is also a set attribute. Order Import ensures that all required fields for entry or booking are validated appropriately as the orders are imported. the set attribute value will overwrite the line attribute. called sets. and sales credits. price adjustments. You can use change sequence numbers to control the sequence of changes you want to make to orders. booked or closed orders. A request to book an order will only work if on importing the order. order lines. If that set already exists. both methods are supported.Integrating Oracle Order Management Using Order Import Returns Returns can be imported like a regular sales order. Order Management retains the order in the Entered status and notifies you of the error. you will not be able to book orders with invalid configurations. it stops at the book-eligible block. If an order is imported with an entry status of Booked (OE_HEADERS_IFACE_ALL. you can import valid and invalid configurations.BOOKED_FLAG=Y) the result after import is that a Action Request of BOOK_ORDER is initiated. If any of the required fields for a booked order are not supplied. Oracle Order Management Open Interface 2-69 . For EDI orders. You can also add a line to an existing set. Order Management utilizes workflow activities to import returns. However. a new set will be created and the line will be added to the set. Line Sets You can import grouped order lines. In addition. however. You may also pass the Action Request to BOOK_ORDER. Order Import imports the order in as Entered and attempts to book it. Import Types Configurations Order Management provides you with the ability to import ATO and PTO configurations. Order Status You can import new. does not match with the set attribute value. the line will be included in the set. Changes You can import changes to orders that have been imported by passing all changed data through Order Import. if the set does not already exist.

Profile Options s OM: Reservation Time Fence--This profile option controls automatic reservations during scheduling. pricing. Define and enable your Order Import sources using the Order Import Sources window.Integrating Oracle Order Management Using Order Import Prerequisites and Set-Up Before using this program to import orders. and bill attribute validation and logic for imported orders as for orders entered in the Sales Orders window. s Parameter The following parameter affects the operation of the Order Import program: s OM: Item Validation Organization--Determines the organization used for validating items and bill of material structures. item pricing. You also need to define bills of material in Oracle Bills of Material for models if you have any complex items that customers can order in various configurations. customer or generic formats: s Supplier Specific Internal Part number Customer Specific Item number Generic (depending on what you have set up in Oracle Inventory as cross-references): s s s CLEI (Common Language Equipment Identifier) EAN (European Article Number) code s 2-70 Oracle Order Management Suite APIs and Open Interfaces Manual . you should: s Set up every aspect of Order Management that you want to use with imported orders. including customers. You need to define items using Oracle Inventory for items to be orderable via Order Import. items. and bills. s Items and Bills Order Management uses the same customer. OM: Apply Automatic Attachments--This profile option determines whether rule-based attachments are applied without user intervention. Order Import provides the ability to import an item specified in the following supplier.

Data Values and Options Manual and Automatic Pricing You can indicate whether you want to manually enter prices for imported orders or allow Order Management to automatically price the order. and not automatic.Integrating Oracle Order Management Using Order Import s ISBN (International Standard Book Number) JAN (Japanese Article Number) code UPC (Universal Product code) code s s Defaulting Rules You can setup your defaulting rules which allow you to default columns in the same way as for orders entered online. you should define all your discounts as line level. free goods. using the same rules as online order entry. you should set the column OE_LINES_INTERFACE. You can use automatic pricing or manual pricing for your imported orders. promotions.CALCULATE_PRICE_ FLAG to Y. In this case. However. in Oracle Pricing and Order Management. the order will still be imported. and define all your pricing setup including discounts. Note: Order Import does not support the importing of free goods. etc. and other item discounts for manual pricing. overridable. Pricing Agreements You can specify an agreement name if you want to order against a specific customer agreement for an order or order line. surcharges. If the scheduling request is unsuccessful on an imported order. If you want to use automatic pricing. You can pass the column value Null to Order Import if you want the defaulting rules to populate the column. Order Import displays an error message without importing the order. and the scheduling exceptions can be viewed Oracle Order Management Open Interface 2-71 . you should set the column OE_ LINES_ INTERFACE. for any reason. However.CALCULATE_PRICE_FLAG to N. if you want to use the manual pricing. if the column is defined as Not Null or Mandatory column and the defaulting rules fail to default the column. promotions. Scheduling Order Import allows you to reserve orders as they are imported.

You can also apply holds or release holds using the actions interface table. with all lines and other entities. The API also performs the scheduling and returns a promise date. For example. at a time to the Process Order Interface. Credit Checking Order Management performs credit checking on all imported orders or changes. Holds and Releases Order Management automatically applies all holds to imported orders and order lines that meet hold criteria. You can use Schedule. Errors at any line or entity level will cause the order to fail the importing of the entire order. Validations Process Order Interface (API) The Process Order Interface is the central application process interface (API) provided by Order Management to perform all common operations such as inserting. Order Import warns you of the differences. Attachments Order Management applies any automatic attachments to imported orders that meet your automatic note criteria based on the setting of the OM: Apply Automatic Attachments profile option. Unschedule. between the two prices as discrepancies. 2-72 Oracle Order Management Suite APIs and Open Interfaces Manual . updating. and validating an order or order line. just as you would for orders entered through the Sales Orders window. Order Import allows you to apply holds on imported orders for review. inserting or updating an order or line. Price Comparisons Order Import performs a price comparison on your imported orders. This API is called by Order Import. along with the operations that need to be completed on the order or line such as. if you provide a selling price and also want the system to calculate a price. Order Import passes one order. if any.Integrating Oracle Order Management Using Order Import in the Error Messages of the Order Import Corrections window. Reserve or Unreserve as values for scheduling actions. deleting. according to the credit checking rules you have defined in Order Management. Order Import processes only those orders and lines which are not rejected and do not have the ERROR_FLAG column set to Y from previous processes. In addition.

so you can have visibility to what your customer sent in. update. Order Import saves your customer-provided value for payment terms in a column on the order line table so that you can have visibility to what your customer sent in. the ERROR_FLAG for the record is updated to N. then choose the Validate button to perform a validation check. and delete are acceptable by your security standards. Order Import raises a warning of the difference. Order Import raises a warning of the difference. Make necessary corrections to the transactions in the Order Import window.Integrating Oracle Order Management Using Order Import The warning can be viewed in the Error Message window of the Order Import Corrections window. Processing Constraints Order Import checks the processing constraints you have defined in Order Management to assure that any operation such as insert. You can set the REJECT_FLAG to Y for headers and line in case your data cannot be corrected by using the Order Import Corrections window. The validation-only mode may also facilitate testing of transactions through Order Import even in a production environment to take advantage of all the setup is the production environment. This mode allows the transaction to be validated against all the Order Management rules but not pass valid transactions to the base Order Management tables. If there is a difference between your selling price and the system calculated price. If you choose you can run production transactions in validation-only mode for a preview of exceptions. Payment Term Comparison Order Import performs payment term comparisons. Order Import displays an error message if it encounters a processing constraint that has been violated. Corrected Data Once the data is corrected. Oracle Order Management Open Interface 2-73 . If there is a difference between your payment terms. Request Submission Validation-Only Mode You can run the Order Import process in the validation-only mode. Order Import saves your customer-provided value for the selling price in a column on the order line table.

You can modify the orders here. Errors: Displays all the errors encountered while importing. reservations and action requests information. all the errors are displayed for that line. lines. Validate: Validates the data but does not import it. The orders that have errors display in red. the order will be rejected and the error messages can be viewed by choosing the Errors button. If you choose the Errors button from the Order Headers region. Only the selected orders will be imported and the import is performed online. Original System. Import: Imports the orders. price adjustments. These windows have related fields grouped as tabs. If you encountered errors while importing orders. The Order Import window displays all orders or selected orders based on the criteria given in the Find window. you will not be able to view that order in the Order Import Corrections window. If you choose the Errors button from the Lines region.Integrating Oracle Order Management Using Order Import Order Import window The Order Import window consists of the Find and Summary windows. If an error is encountered while importing. If you attempt to re-query the window. If an order is successfully imported. update. and delete the orders and lines in the interface tables. Document Reference. Buttons s Lines: Displays line level information for orders. You can navigate from the Errors window to the Order Headers or Lines region where the error has occurred. s s s s 2-74 Oracle Order Management Suite APIs and Open Interfaces Manual . you can also fix these errors in the window and try importing the order again. You can update one or multiple orders or lines at the same time through the Summary window. Only the selected orders will be validated and performed online. Discounts: Displays discount information for orders. it also gets deleted from the interface tables. The Find window allows you to find orders to be imported based on certain attributes such as Request ID. lot serials. The error messages are stored context sensitive. The Summary windows displays order headers. There are separate windows for the header and line level data. sales credits. Order Source. The data is validated before being imported. You can insert. You have the ability to remove columns from the folder. You can also mark an order or a line to be rejected by setting the REJECTED flag. and Change Sequence. all the errors for that order are displayed.

s Request You can submit a request by selecting Order Import Request and select the appropriate parameter and choose Submit. but not imported into the base orders tables. Oracle Order Management Open Interface 2-75 . Validate Only (Yes/No) Choose whether to validate only the data in the interface tables. or leave this parameter blank so that all enabled sources are processed for data existing in the interface tables. Order References You can enter the System Document Reference if you want to run Order Import for a specific order. Order Management automatically generates an Order Import processing results summary log which identifies the total number of successful and failed imported orders. Parameters The Order Import program provides the following parameters: Order Source Choose a specific Order Import source that you have defined in the Order Import Sources window so that only records with that source are processed. The default value is No. Processing Results Each time you run Order Import. Sales Credits: Displays sales credit information for orders.Integrating Oracle Order Management Using Order Import s Actions: Displays order actions for orders. If Yes. the order will be validated.

Integrating Oracle Order Management Using Order Import Oracle Order Management Interface Tables and Column Descriptions Order Import uses the following tables and columns: Table 2–1 OE_HEADERS_IFACE_ALL Required Column Name ORDER_SOURCE_ ID ORIG_SYS_ DOCUMENT_REF CHANGE_ SEQUENCE CHANGE_ REQUEST_CODE ORDER_SOURCE ORG_ID HEADER_ID ORDER_NUMBER VERSION_ NUMBER ORDERED_DATE ORDER_ CATEGORY ORDER_TYPE_ID ORDER_TYPE PRICE_LIST_ID PRICE_LIST CONVERSION_ RATE CONVERSION_ RATE_DATE Type NUMBER VARCHAR2(50) VARCHAR2(50) VARCHAR2(30) VARCHAR2(30) NUMBER NUMBER NUMBER NUMBER DATE VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER DATE C C C C C C X C X X X X (C = Conditionally Required) C REQUIRED X X Conditionally Required for Booking Derived Optional 2-76 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–1 OE_HEADERS_IFACE_ALL Required Column Name CONVERSION_ TYPE_CODE CONVERSION_ TYPE TRANSACTIONAL _CURR_CODE TRANSACTIONAL _CURR SALESREP_ID SALESREP SALES_ CHANNEL_CODE RETURN_ REASON_CODE Type VARCHAR2(30) VARCHAR2(30) VARCHAR2(3) VARCHAR2(30) NUMBER VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) C for future use only X X X C C X X X X X X X (C = Conditionally Required) C C X X Conditionally Required for Booking Derived Optional TAX_POINT_CODE VARCHAR2(30) TAX_POINT TAX_EXEMPT_ FLAG TAX_EXEMPT_ NUMBER TAX_EXEMPT_ REASON_CODE TAX_EXEMPT_ REASON AGREEMENT_ID AGREEMENT INVOICING_ RULE_ID INVOICING_RULE VARCHAR2(30) VARCHAR2(30) VARCHAR2(50) VARCHAR2(30) VARCHAR2(30) NUMBER VARCHAR2(50) NUMBER VARCHAR2(30) Oracle Order Management Open Interface 2-77 .

Integrating Oracle Order Management Using Order Import Table 2–1 OE_HEADERS_IFACE_ALL Required Column Name ACCOUNTING_ RULE_ID ACCOUNTING_ RULE PAYMENT_TERM_ ID PAYMENT_TERM DEMAND_CLASS_ CODE DEMAND_CLASS SHIPMENT_ PRIORITY_CODE SHIPMENT_ PRIORITY SHIPPING_ METHOD_CODE SHIPPING_ METHOD FREIGHT_ CARRIER_CODE FREIGHT_TERMS_ CODE FREIGHT_TERMS FOB_POINT_CODE FOB_POINT PARTIAL_ SHIPMENTS_ ALLOWED SHIP_ TOLERANCE_ ABOVE Type NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30 VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(1) (C = Conditionally Required) Conditionally Required for Booking X X X X X X X X X X X X X X X X Derived Optional NUMBER X 2-78 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–1 OE_HEADERS_IFACE_ALL Required Column Name SHIP_ TOLERANCE_ BELOW SHIPPING_ INSTRUCTIONS PACKING_ INSTRUCTIONS ORDER_DATE_ TYPE_CODE EARLIEST_ SCHEDULE_LIMIT LATEST_ SCHEDULE_LIMIT CUSTOMER_PO_ NUMBER CUSTOMER_ PAYMENT_TERM_ ID CUSTOMER_ PAYMENT_TERM PAYMENT_TYPE_ CODE PAYMENT_ AMOUNT CHECK_NUMBER CREDIT_CARD_ CODE CREDIT_CARD_ HOLDER_NAME CREDIT_CARD_ NUMBER Type NUMBER (C = Conditionally Required) Conditionally Required for Booking Derived Optional X VARCHAR2(240) VARCHAR2(240) VARCHAR2(30) NUMBER NUMBER VARCHAR2(50) NUMBER X X X X X X X VARCHAR2(30) VARCHAR2(30) NUMBER VARCHAR2(50) VARCHAR2(30) VARCHAR2(50) VARCHAR2(50) X X X X X X X Oracle Order Management Open Interface 2-79 .

Integrating Oracle Order Management Using Order Import Table 2–1 OE_HEADERS_IFACE_ALL Required Column Name CREDIT_CARD_ EXPIRATION_ DATE CREDIT_CARD_ APPROVAL_CODE SOLD_FROM_ ORG_ID SOLD_FROM_ORG SOLD_TO_ORG_ID SOLD_TO_ORG SHIP_FROM_ORG_ ID SHIP_FROM_ORG SHIP_TO_ORG_ID SHIP_TO_ORG INVOICE_TO_ ORG_ID INVOICE_TO_ORG DELIVER_TO_ ORG_ID DELIVER_TO_ORG DELIVER_TO_ CUSTOMER_ NUMBER DELIVER_TO_ CUSTOMER SOLD_TO_ CONTACT_ID SOLD_TO_ CONTACT Type DATE (C = Conditionally Required) Conditionally Required for Booking Derived Optional X VARCHAR2(50) NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) VARCHAR2(30) X X C C C C X X X X X X X X VARCHAR2(30) NUMBER VARCHAR2(30) X X X 2-80 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–1 OE_HEADERS_IFACE_ALL Required Column Name SHIP_TO_ CONTACT_ID SHIP_TO_ CONTACT INVOICE_TO_ CONTACT_ID INVOICE_TO_ CONTACT DELIVER_TO_ CONTACT_ID DELIVER_TO_ CONTACT CUSTOMER_ID CUSTOMER_ NAME SHIPMENT_ PRIORITY_CODE_ INT SHIP_TO_ ADDRESS1 SHIP_TO_ ADDRESS2 SHIP_TO_ ADDRESS3 SHIP_TO_ ADDRESS4 SHIP_TO_CITY SHIP_TO_ CONTACT_FIRST_ NAME Type NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) VARCHAR2(30) C X (C = Conditionally Required) Conditionally Required for Booking Derived Optional X X X X X X X VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) C C C C C X Oracle Order Management Open Interface 2-81 .

Integrating Oracle Order Management Using Order Import Table 2–1 OE_HEADERS_IFACE_ALL Required Column Name SHIP_TO_ CONTACT_LAST_ NAME Type VARCHAR2(30) (C = Conditionally Required) Conditionally Required for Booking Derived Optional X SHIP_TO_COUNTY VARCHAR2(30) SHIP_TO_ CUSTOMER SHIP_TO_ CUSTOMER_ NUMBER SHIP_TO_POSTAL_ CODE SHIP_TO_ PROVINCE VARCHAR2(30) VARCHAR2(30) C C C VARCHAR2(30) VARCHAR2(30) C C X C C C C C C C C C SHIP_TO_SITE_INT VARCHAR2(30) SHIP_TO_STATE SHIP_TO_ COUNTRY INVOICE_ ADDRESS1 INVOICE_ ADDRESS2 INVOICE_ ADDRESS3 INVOICE_ ADDRESS4 INVOICE_CITY INVOICE_ COUNTRY INVOICE_ COUNTY VARCHAR2(30) VARCHAR2(30) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(30) VARCHAR2(20) VARCHAR2(25) 2-82 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–1 OE_HEADERS_IFACE_ALL Required Column Name INVOICE_ CUSTOMER INVOICE_ CUSTOMER_ NUMBER INVOICE_ POSTAL_CODE INVOICE_ PROVINCE_INT INVOICE_SITE INVOICE_SITE_ CODE INVOICE_STATE INVOICE_TO_ CONTACT_FIRST_ NAME INVOICE_TO_ CONTACT_LAST_ NAME ORDERED_BY_ CONTACT_FIRST_ NAME ORDERED_BY_ CONTACT_LAST_ NAME DROP_SHIP_FLAG BOOKED_FLAG CLOSED_FLAG CANCELLED_ FLAG REJECTED_FLAG Type VARCHAR2(60) VARCHAR2(30) (C = Conditionally Required) Conditionally Required for Booking C C Derived Optional VARCHAR2(15) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) C C X X C X VARCHAR2(30) X VARCHAR2(30) X VARCHAR2(30) X VARCHAR2(1) VARCHAR2(1) VARCHAR2(1) VARCHAR2(1) VARCHAR2(1) X X X X X Oracle Order Management Open Interface 2-83 .

Integrating Oracle Order Management Using Order Import Table 2–1 OE_HEADERS_IFACE_ALL Required Column Name CONTEXT ATTRIBUTE1 ATTRIBUTE2 ATTRIBUTE3 ATTRIBUTE4 ATTRIBUTE5 ATTRIBUTE6 ATTRIBUTE7 ATTRIBUTE8 ATTRIBUTE9 ATTRIBUTE10 ATTRIBUTE11 ATTRIBUTE12 ATTRIBUTE13 ATTRIBUTE14 ATTRIBUTE15 HEADER_PO_ CONTEXT PO_ATTRIBUTE_1 PO_ATTRIBUTE_2 PO_ATTRIBUTE_3 PO_ATTRIBUTE_4 PO_ATTRIBUTE_5 PO_ATTRIBUTE_6 PO_ATTRIBUTE_7 Type VARCHAR2(30) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(30) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) (C = Conditionally Required) Conditionally Required for Booking Derived Optional X X X X X X X X X X X X X X X X X X X X X X X X 2-84 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–1 OE_HEADERS_IFACE_ALL Required Column Name PO_ATTRIBUTE_8 PO_ATTRIBUTE_9 PO_ATTRIBUTE_10 PO_ATTRIBUTE_11 PO_ATTRIBUTE_12 PO_ATTRIBUTE_13 PO_ATTRIBUTE_14 PO_ATTRIBUTE_15 PO_REVISION_ DATE GLOBAL_ ATTRIBUTE_ CATEGORY GLOBAL_ ATTRIBUTE1 GLOBAL_ ATTRIBUTE2 GLOBAL_ ATTRIBUTE3 GLOBAL_ ATTRIBUTE4 GLOBAL_ ATTRIBUTE5 GLOBAL_ ATTRIBUTE6 GLOBAL_ ATTRIBUTE7 GLOBAL_ ATTRIBUTE8 Type VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) DATE VARCHAR2(30) (C = Conditionally Required) Conditionally Required for Booking Derived Optional X X X X X X X X X X VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) X X X X X X X X Oracle Order Management Open Interface 2-85 .

Integrating Oracle Order Management Using Order Import Table 2–1 OE_HEADERS_IFACE_ALL Required Column Name GLOBAL_ ATTRIBUTE9 GLOBAL_ ATTRIBUTE10 GLOBAL_ ATTRIBUTE11 GLOBAL_ ATTRIBUTE12 GLOBAL_ ATTRIBUTE13 GLOBAL_ ATTRIBUTE14 GLOBAL_ ATTRIBUTE15 GLOBAL_ ATTRIBUTE16 GLOBAL_ ATTRIBUTE17 GLOBAL_ ATTRIBUTE18 GLOBAL_ ATTRIBUTE19 GLOBAL_ ATTRIBUTE20 CREATED_BY CREATION_DATE LAST_UPDATED_ BY LAST_UPDATE_ DATE Type VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) NUMBER DATE NUMBER DATE REQUIRED REQUIRED REQUIRED REQUIRED (C = Conditionally Required) Conditionally Required for Booking Derived Optional X X X X X X X X X X X X 2-86 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–1 OE_HEADERS_IFACE_ALL Required Column Name LAST_UPDATE_ LOGIN PROGRAM_ APPLICATION_ID PROGRAM_ID PROGRAM_ UPDATE_DATE REQUEST_ID REQUEST_DATE SUBMISSION_ DATETIME OPERATION_ CODE ERROR_FLAG READY_FLAG STATUS_FLAG FORCE_APPLY_ FLAG CHANGE_ REASON CHANGE_ COMMENTS Type NUMBER NUMBER NUMBER DATE NUMBER DATE DATE VARCHAR2(30) VARCHAR2(1) VARCHAR2(1) VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) VARCHAR2(200) REQUIRED X X X X X X X X X (C = Conditionally Required) Conditionally Required for Booking Derived Optional X X X X Oracle Order Management Open Interface 2-87 .

Integrating Oracle Order Management Using Order Import Table 2–2 OE_HEADERS_IFACE_ALL Conditional Settings Column Name ORDER_SOURCE_ID ORDER_SOURCE ORDER_TYPE_ID ORDER_TYPE CONVERSION_RATE CONVERSION_RATE_DATE CONVERSION_TYPE_CODE CONVERSION_TYPE TAX_EXEMPT_REASON_CODE TAX_EXEMPT_REASON RETURN_REASON_CODE PRICE_LIST_ID PRICE_LIST SOLD_FROM_ORG_ID SOLD_FROM_ORG Conditional Setting requirement Condition is that either one of the columns should be populated Condition is that either one of the columns should be populated Condition is that either one of the columns should be populated Condition is that either one of the columns should be populated Condition is that either one of the columns should be populated Required for returns only Condition is that either one of the columns should be populated Condition is that either one of the columns should be populated 2-88 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–2 OE_HEADERS_IFACE_ALL Conditional Settings Column Name SOLD_TO_ORG_ID SOLD_TO_ORG CUSTOMER_NAME SHIP_TO_ADDRESS1 SHIP_TO_ADDRESS2 SHIP_TO_ADDRESS3 SHIP_TO_ADDRESS4 SHIP_TO_CITY SHIP_TO_COUNTY SHIP_TO_CUSTOMER SHIP_TO_CUSTOMER_NUMBER SHIP_TO_POSTAL_CODE SHIP_TO_PROVINCE SHIP_TO_SITE_INT SHIP_TO_STATE SHIP_TO_COUNTRY INVOICE_ADDRESS1 INVOICE_ADDRESS2 INVOICE_ADDRESS3 INVOICE_ADDRESS4 INVOICE_CITY INVOICE_COUNTRY INVOICE_COUNTY INVOICE_CUSTOMER INVOICE_CUSTOMER_NUMBER INVOICE_POSTAL_CODE INVOICE_PROVINCE_INT INVOICE_STATE These columns or Invoice_To_Org_id should be provided. These columns or Ship_to_Org_id should be provided Conditional Setting requirement Condition is that one of the columns should be populated Oracle Order Management Open Interface 2-89 .

Integrating Oracle Order Management Using Order Import

Table 2–3 OE_LINES_INTERFACE
Required Column Name Type (C = Conditionally Required) REQUIRED REQUIRED REQUIRED REQUIRED X X X X X X X X X X C REQUIRED C Conditionally Required for Booking

Derived

Optional

ORDER_SOURCE_ NUMBER ID ORIG_SYS_ VARCHAR2(50) DOCUMENT_REF ORIG_SYS_LINE_ REF ORIG_SYS_ SHIPMENT_REF CHANGE_ SEQUENCE CHANGE_ REQUEST_CODE ORG_ID LINE_NUMBER SHIPMENT_ NUMBER LINE_ID SPLIT_FROM_ LINE_ID LINE_TYPE_ID LINE_TYPE ITEM_TYPE_ CODE INVENTORY_ ITEM_ID INVENTORY_ ITEM TOP_MODEL_ LINE_REF VARCHAR2(50) VARCHAR2(50) VARCHAR2(50) VARCHAR2(30) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(30) VARCHAR2(30) NUMBER VARCHAR2(30) VARCHAR2(50)

2-90

Oracle Order Management Suite APIs and Open Interfaces Manual

Integrating Oracle Order Management Using Order Import

Table 2–3 OE_LINES_INTERFACE
Required Column Name LINK_TO_LINE_ REF EXPLOSION_ DATE ATO_LINE_ID COMPONENT_ SEQUENCE_ID COMPONENT_ CODE SORT_ORDER MODEL_GROUP_ NUMBER OPTION_ NUMBER OPTION_FLAG SHIP_MODEL_ COMPLETE_ FLAG SOURCE_TYPE_ CODE SCHEDULE_ STATUS_CODE SCHEDULE_ SHIP_DATE SCHEDULE_ ARRIVAL_DATE ACTUAL_ ARRIVAL_DATE REQUEST_DATE PROMISE_DATE Type VARCHAR2(50) DATE NUMBER NUMBER VARCHAR2(50) VARCHAR2(240) NUMBER NUMBER VARCHAR2(1) VARCHAR2(1) X X X X X X X (C = Conditionally Required) C X X Conditionally Required for Booking

Derived

Optional

VARCHAR2(30) VARCHAR2(30) DATE DATE DATE DATE DATE REQUIRED C C C C

X

X

X

Oracle Order Management Open Interface 2-91

Integrating Oracle Order Management Using Order Import

Table 2–3 OE_LINES_INTERFACE
Required Column Name Type (C = Conditionally Required) Conditionally Required for Booking

Derived

Optional X

SCHEDULE_DATE DATE DELIVERY_ LEAD_TIME DELIVERY_ID ORDERED_ QUANTITY NUMBER NUMBER NUMBER REQUIRED REQUIRED REQUIRED REQUIRED C C C C C C C C C C C

ORDER_ VARCHAR2(3) QUANTITY_UOM SHIPPING_ QUANTITY NUMBER

SHIPPING_ VARCHAR2(3) QUANTITY_UOM SHIPPED_ QUANTITY CANCELLED_ QUANTITY FULFILLED_ QUANTITY PRICING_ QUANTITY NUMBER NUMBER NUMBER NUMBER

PRICING_ VARCHAR2(3) QUANTITY_UOM SOLD_FROM_ ORG_ID SOLD_FROM_ ORG SOLD_TO_ORG_ ID SOLD_TO_ORG SHIP_FROM_ ORG_ID NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER

X

2-92

Oracle Order Management Suite APIs and Open Interfaces Manual

Integrating Oracle Order Management Using Order Import

Table 2–3 OE_LINES_INTERFACE
Required Column Name Type (C = Conditionally Required) Conditionally Required for Booking

Derived

Optional X X X

SHIP_FROM_ORG VARCHAR2(30) SHIP_TO_ORG_ID NUMBER SHIP_TO_ORG DELIVER_TO_ ORG_ID DELIVER_TO_ ORG INVOICE_TO_ ORG_ID INVOICE_TO_ ORG SHIP_TO_ ADDRESS1 SHIP_TO_ ADDRESS2 SHIP_TO_ ADDRESS3 SHIP_TO_ ADDRESS4 SHIP_TO_CITY SHIP_TO_ COUNTY SHIP_TO_STATE SHIP_TO_ POSTAL_CODE SHIP_TO_ COUNTRY VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) C C C C C C C C C C C X X

SHIP_TO_ VARCHAR2(30) CONTACT_FIRST_ NAME

X

Oracle Order Management Open Interface 2-93

Integrating Oracle Order Management Using Order Import

Table 2–3 OE_LINES_INTERFACE
Required Column Name Type (C = Conditionally Required) Conditionally Required for Booking

Derived

Optional X

VARCHAR2(30) SHIP_TO_ CONTACT_LAST_ NAME SHIP_TO_ CONTACT_JOB_ TITLE SHIP_TO_ CONTACT_ AREA_CODE1 SHIP_TO_ CONTACT_ AREA_CODE2 SHIP_TO_ CONTACT_ AREA_CODE3 SHIP_TO_ CONTACT_ID SHIP_TO_ CONTACT DELIVER_TO_ CONTACT_ID DELIVER_TO_ CONTACT INVOICE_TO_ CONTACT_ID INVOICE_TO_ CONTACT DROP_SHIP_ FLAG VEH_CUS_ITEM_ CUM_KEY_ID VARCHAR2(30)

X

VARCHAR2(10)

X

VARCHAR2(10)

X

VARCHAR2(10)

X

NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) VARCHAR2(1) NUMBER

X X X X X X X X

2-94

Oracle Order Management Suite APIs and Open Interfaces Manual

Integrating Oracle Order Management Using Order Import

Table 2–3 OE_LINES_INTERFACE
Required Column Name CUST_ PRODUCTION_ SEQ_NUM LOAD_SEQ_ NUMBER OVER_SHIP_ REASON_CODE Type NUMBER (C = Conditionally Required) Conditionally Required for Booking

Derived

Optional X

NUMBER VARCHAR2(30)

X X X X X

OVER_SHIP_ VARCHAR2(1) RESOLVED_FLAG AUTHORIZED_ TO_SHIP_FLAG SHIP_ TOLERANCE_ ABOVE SHIP_ TOLERANCE_ BELOW SHIP_SET_ID SHIP_SET_NAME ARRIVAL_SET_ID ARRIVAL_SET_ NAME INVOICE_SET_ID INVOICE_SET_ NAME FULFILLMENT_ SET_ID FULFILLMENT_ SET_NAME PRICE_LIST_ID PRICE_LIST VARCHAR2(1) NUMBER

NUMBER

X

NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) C C

X X X X X X X X

Oracle Order Management Open Interface 2-95

Integrating Oracle Order Management Using Order Import

Table 2–3 OE_LINES_INTERFACE
Required Column Name PRICING_DATE Type DATE (C = Conditionally Required) Conditionally Required for Booking C C

Derived

Optional

UNIT_LIST_PRICE NUMBER UNIT_LIST_ NUMBER PRICE_PER_PQTY UNIT_SELLING_ PRICE UNIT_SELLING_ PRICE_PQTY CALCULATE_ PRICE_FLAG TAX_CODE TAX TAX_VALUE TAX_DATE TAX_POINT_ CODE TAX_POINT TAX_EXEMPT_ FLAG TAX_EXEMPT_ NUMBER TAX_EXEMPT_ REASON_CODE TAX_EXEMPT_ REASON AGREEMENT_ID AGREEMENT INVOICING_ RULE_ID VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER NUMBER NUMBER VARCHAR2(1) VARCHAR2(50) VARCHAR2(50) NUMBER DATE VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(50)

C

X X X X X For future use X X X X X X X C

2-96

Oracle Order Management Suite APIs and Open Interfaces Manual

Integrating Oracle Order Management Using Order Import

Table 2–3 OE_LINES_INTERFACE
Required Column Name INVOICING_ RULE ACCOUNTING_ RULE_ID ACCOUNTING_ RULE Type VARCHAR2(30 NUMBER VARCHAR2(30) (C = Conditionally Required) Conditionally Required for Booking C C C C C X C X X X X X X X X X X X

Derived

Optional

PAYMENT_TERM_ NUMBER ID PAYMENT_TERM DEMAND_ CLASS_CODE VARCHAR2(30) VARCHAR2(30)

DEMAND_CLASS VARCHAR2(30) SHIPMENT_ PRIORITY_CODE SHIPMENT_ PRIORITY SHIPPING_ METHOD_CODE SHIPPING_ METHOD SHIPPING_ INSTRUCTIONS PACKING_ INSTRUCTIONS FREIGHT_ CARRIER_CODE FREIGHT_ TERMS_CODE FREIGHT_TERMS FOB_POINT_ CODE VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(240) VARCHAR2(240) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30)

Oracle Order Management Open Interface 2-97

Integrating Oracle Order Management Using Order Import

Table 2–3 OE_LINES_INTERFACE
Required Column Name FOB_POINT SALESREP_ID SALESREP RETURN_ REASON_CODE REFERENCE_ TYPE REFERENCE_ HEADER_ID REFERENCE_ HEADER REFERENCE_ LINE_ID REFERENCE_ LINE CREDIT_ INVOICE_LINE_ ID CUSTOMER_PO_ NUMBER CUSTOMER_ LINE_NUMBER CUSTOMER_ SHIPMENT_ NUMBER CUSTOMER_ ITEM_ID CUSTOMER_ ITEM_ID_TYPE CUSTOMER_ ITEM_NAME NUMBER VARCHAR2(30) VARCHAR2(2000) Type VARCHAR2(30) NUMBER VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER C C C C C C X X X (C = Conditionally Required) Conditionally Required for Booking

Derived

Optional X

VARCHAR2(50) VARCHAR2(50)

X X X

X X X

2-98

Oracle Order Management Suite APIs and Open Interfaces Manual

Integrating Oracle Order Management Using Order Import

Table 2–3 OE_LINES_INTERFACE
Required Column Name CUSTOMER_ ITEM_REVISION Type VARCHAR2(50) (C = Conditionally Required) Conditionally Required for Booking

Derived

Optional X X X

CUSTOMER_ NUMBER ITEM_NET_PRICE NUMBER CUSTOMER_ PAYMENT_TERM_ ID CUSTOMER_ PAYMENT_TERM DEMAND_ BUCKET_TYPE_ CODE DEMAND_ BUCKET_TYPE SCHEDULE_ ITEM_DETAIL DEMAND_ STREAM CUSTOMER_ DOCK_CODE CUSTOMER_ DOCK CUSTOMER_JOB CUSTOMER_ PRODUCTION_ LINE CUST_MODEL_ SERIAL_NUMBER PROJECT_ID PROJECT TASK_ID NUMBER VARCHAR2(30) NUMBER VARCHAR2(50) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(50) VARCHAR2(50) VARCHAR2(50) VARCHAR2(30)

X X

X X X X X X X

X X X X

Oracle Order Management Open Interface 2-99

Integrating Oracle Order Management Using Order Import Table 2–3 OE_LINES_INTERFACE Required Column Name TASK END_ITEM_ UNIT_NUMBER ITEM_REVISION SERVICE_ DURATION SERVICE_START_ DATE SERVICE_END_ DATE SERVICE_ COTERMINATE_ FLAG UNIT_SELLING_ PERCENT UNIT_LIST_ PERCENT UNIT_PERCENT_ BASE_PRICE SERVICE_ NUMBER SERVICED_LINE_ ID Type VARCHAR2(30) VARCHAR2(30) VARCHAR2(3) NUMBER DATE DATE VARCHAR2(1) C C C C (C = Conditionally Required) Conditionally Required for Booking Derived Optional X X X NUMBER NUMBER NUMBER NUMBER NUMBER X X X X X X X X X X FULFILLED_FLAG VARCHAR2(1) CLOSED_FLAG CANCELLED_ FLAG REJECTED_FLAG CONTRACT_PO_ NUMBER VARCHAR2(1) VARCHAR2(1) VARCHAR2(1) VARCHAR2(150) 2-100 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–3 OE_LINES_INTERFACE Required Column Name LINE_PO_ CONTEXT ATTRIBUTE1 ATTRIBUTE2 ATTRIBUTE3 ATTRIBUTE4 ATTRIBUTE5 ATTRIBUTE6 ATTRIBUTE7 ATTRIBUTE8 ATTRIBUTE9 ATTRIBUTE10 ATTRIBUTE11 ATTRIBUTE12 ATTRIBUTE13 ATTRIBUTE14 ATTRIBUTE15 INDUSTRY_ CONTEXT INDUSTRY_ ATTRIBUTE1 INDUSTRY_ ATTRIBUTE2 INDUSTRY_ ATTRIBUTE3 INDUSTRY_ ATTRIBUTE4 Type VARCHAR2(30) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(30) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) (C = Conditionally Required) Conditionally Required for Booking Derived Optional X X X X X X X X X X X X X X X X X X X X X Oracle Order Management Open Interface 2-101 .

Integrating Oracle Order Management Using Order Import Table 2–3 OE_LINES_INTERFACE Required Column Name INDUSTRY_ ATTRIBUTE5 INDUSTRY_ ATTRIBUTE6 INDUSTRY_ ATTRIBUTE7 INDUSTRY_ ATTRIBUTE8 INDUSTRY_ ATTRIBUTE9 INDUSTRY_ ATTRIBUTE10 INDUSTRY_ ATTRIBUTE11 INDUSTRY_ ATTRIBUTE12 INDUSTRY_ ATTRIBUTE13 INDUSTRY_ ATTRIBUTE14 INDUSTRY_ ATTRIBUTE15 INDUSTRY_ ATTRIBUTE16 INDUSTRY_ ATTRIBUTE17 INDUSTRY_ ATTRIBUTE18 INDUSTRY_ ATTRIBUTE19 INDUSTRY_ ATTRIBUTE20 Type VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) (C = Conditionally Required) Conditionally Required for Booking Derived Optional X X X X X X X X X X X X X X X X 2-102 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–3 OE_LINES_INTERFACE Required Column Name INDUSTRY_ ATTRIBUTE21 INDUSTRY_ ATTRIBUTE22 INDUSTRY_ ATTRIBUTE23 INDUSTRY_ ATTRIBUTE24 INDUSTRY_ ATTRIBUTE25 INDUSTRY_ ATTRIBUTE26 INDUSTRY_ ATTRIBUTE27 INDUSTRY_ ATTRIBUTE28 INDUSTRY_ ATTRIBUTE29 INDUSTRY_ ATTRIBUTE30 PRICING_ CONTEXT PRICING_ ATTRIBUTE1 PRICING_ ATTRIBUTE2 PRICING_ ATTRIBUTE3 PRICING_ ATTRIBUTE4 Type VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(150) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) (C = Conditionally Required) Conditionally Required for Booking Derived Optional X X X X X X X X X X X X X X X Oracle Order Management Open Interface 2-103 .

Integrating Oracle Order Management Using Order Import Table 2–3 OE_LINES_INTERFACE Required Column Name PRICING_ ATTRIBUTE5 PRICING_ ATTRIBUTE6 PRICING_ ATTRIBUTE7 PRICING_ ATTRIBUTE8 PRICING_ ATTRIBUTE9 PRICING_ ATTRIBUTE10 GLOBAL_ ATTRIBUTE_ CATEGORY GLOBAL_ ATTRIBUTE1 GLOBAL_ ATTRIBUTE2 GLOBAL_ ATTRIBUTE3 GLOBAL_ ATTRIBUTE4 GLOBAL_ ATTRIBUTE5 GLOBAL_ ATTRIBUTE6 GLOBAL_ ATTRIBUTE7 GLOBAL_ ATTRIBUTE8 Type VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(30) (C = Conditionally Required) Conditionally Required for Booking Derived Optional X X X X X X X VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) X X X X X X X X 2-104 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–3 OE_LINES_INTERFACE Required Column Name GLOBAL_ ATTRIBUTE9 GLOBAL_ ATTRIBUTE10 GLOBAL_ ATTRIBUTE11 GLOBAL_ ATTRIBUTE12 GLOBAL_ ATTRIBUTE13 GLOBAL_ ATTRIBUTE14 GLOBAL_ ATTRIBUTE15 GLOBAL_ ATTRIBUTE16 GLOBAL_ ATTRIBUTE17 GLOBAL_ ATTRIBUTE18 GLOBAL_ ATTRIBUTE19 GLOBAL_ ATTRIBUTE20 RETURN_ ATTRIBUTE1 RETURN_ ATTRIBUTE2 RETURN_ ATTRIBUTE3 Type VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) (C = Conditionally Required) Conditionally Required for Booking Derived Optional X X X X X X X X X X X X X X X Oracle Order Management Open Interface 2-105 .

Integrating Oracle Order Management Using Order Import Table 2–3 OE_LINES_INTERFACE Required Column Name RETURN_ ATTRIBUTE4 RETURN_ ATTRIBUTE5 RETURN_ ATTRIBUTE6 RETURN_ ATTRIBUTE7 RETURN_ ATTRIBUTE8 RETURN_ ATTRIBUTE9 RETURN_ ATTRIBUTE10 RETURN_ ATTRIBUTE11 RETURN_ ATTRIBUTE12 RETURN_ ATTRIBUTE13 RETURN_ ATTRIBUTE14 RETURN_ ATTRIBUTE15 Type VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) (C = Conditionally Required) Conditionally Required for Booking Derived Optional X X X X X X X X X X X X X INVENTORY_ VARCHAR2(240) ITEM_SEGMENT_ 1 INVENTORY_ VARCHAR2(240) ITEM_SEGMENT_ 2 X 2-106 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–3 OE_LINES_INTERFACE Required Column Name Type (C = Conditionally Required) Conditionally Required for Booking Derived Optional X INVENTORY_ VARCHAR2(240) ITEM_SEGMENT_ 3 INVENTORY_ VARCHAR2(240) ITEM_SEGMENT_ 4 INVENTORY_ VARCHAR2(240) ITEM_SEGMENT_ 5 VARCHAR2(240) INVENTORY_ ITEM_SEGMENT_ 6 INVENTORY_ VARCHAR2(240) ITEM_SEGMENT_ 7 INVENTORY_ VARCHAR2(240) ITEM_SEGMENT_ 8 INVENTORY_ VARCHAR2(240) ITEM_SEGMENT_ 9 INVENTORY_ VARCHAR2(240) ITEM_SEGMENT_ 10 INVENTORY_ VARCHAR2(240) ITEM_SEGMENT_ 11 INVENTORY_ VARCHAR2(240) ITEM_SEGMENT_ 12 INVENTORY_ VARCHAR2(240) ITEM_SEGMENT_ 13 X X X X X X X X X X Oracle Order Management Open Interface 2-107 .

Integrating Oracle Order Management Using Order Import Table 2–3 OE_LINES_INTERFACE Required Column Name Type (C = Conditionally Required) Conditionally Required for Booking Derived Optional X VARCHAR2(240) INVENTORY_ ITEM_SEGMENT_ 14 INVENTORY_ VARCHAR2(240) ITEM_SEGMENT_ 15 INVENTORY_ VARCHAR2(240) ITEM_SEGMENT_ 16 VARCHAR2(240) INVENTORY_ ITEM_SEGMENT_ 17 INVENTORY_ VARCHAR2(240) ITEM_SEGMENT_ 18 INVENTORY_ VARCHAR2(240) ITEM_SEGMENT_ 19 INVENTORY_ ITEM_SEGMENT_ 20 SERVICE_ CONTEXT SERVICE_ ATTRIBUTE1 SERVICE_ ATTRIBUTE2 SERVICE_ ATTRIBUTE3 SERVICE_ ATTRIBUTE4 SERVICE_ ATTRIBUTE5 VARCHAR2(30) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) X X X X X X X X X X X X 2-108 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–3 OE_LINES_INTERFACE Required Column Name SERVICE_ ATTRIBUTE6 SERVICE_ ATTRIBUTE7 SERVICE_ ATTRIBUTE8 SERVICE_ ATTRIBUTE9 SERVICE_ ATTRIBUTE10 SERVICE_ ATTRIBUTE11 SERVICE_ ATTRIBUTE12 SERVICE_ ATTRIBUTE13 SERVICE_ ATTRIBUTE14 SERVICE_ ATTRIBUTE15 CREATED_BY Type VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) NUMBER REQUIRED REQUIRED REQUIRED X X X X (C = Conditionally Required) Conditionally Required for Booking Derived Optional X X X X X X X X X X CREATION_DATE DATE LAST_UPDATED_ NUMBER BY LAST_UPDATE_ DATE LAST_UPDATE_ LOGIN DATE NUMBER PROGRAM_ NUMBER APPLICATION_ID PROGRAM_ID NUMBER Oracle Order Management Open Interface 2-109 .

Integrating Oracle Order Management Using Order Import Table 2–3 OE_LINES_INTERFACE Required Column Name PROGRAM_ UPDATE_DATE REQUEST_ID OPERATION_ CODE ERROR_FLAG STATUS_FLAG CHANGE_ REASON CHANGE_ COMMENTS SERVICE_TXN_ REASON_CODE SERVICE_TXN_ COMMENTS Type DATE NUMBER VARCHAR2(30) VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) VARCHAR2(2000) VARCHAR2(30) VARCHAR2(2000) REQUIRED X X X X X X X (C = Conditionally Required) Conditionally Required for Booking Derived Optional X Table 2–4 OE_LINES_INTERFACE Conditional Settings Column Name INVENTORY_ITEM_ID INVENTORY_ITEM TOP_MODEL_LINE_REF LINK_TO_LINE_REF SHIPPING_QUANTITY SHIPPING_QUANTITY_ UOM PRICING_QUANTITY PRICING_QUANTITY_ UOM Condition is that both columns should be populated Condition is that both columns should be populated Required for model items only Conditional Setting requirement Condition is that either column should be populated 2-110 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–4 OE_LINES_INTERFACE Conditional Settings Column Name RETURN_REASON_ CODE REFERENCE_TYPE REFERENCE_HEADER_ ID REFERENCE_HEADER REFERENCE_LINE_ID REFERENCE_LINE SERVICE_DURATION SERVICE_START_DATE SERVICE_END_DATE SERVICE_ COTERMINATE_FLAG SOLD_FROM_ORG_ID SOLD_FROM_ORG SOLD_TO_ORG_ID SOLD_TO_ORG INVOICE_TO_ ORG_ID INVOICE_TO_ORG SHIP_TO_ADDRESS1 SHIP_TO_ADDRESS2 SHIP_TO_ADDRESS3 SHIP_TO_ADDRESS4 SHIP_TO_CITY SHIP_TO_COUNTY SHIP_TO_STATE SHIP_TO_POSTAL_CODE SHIP_TO_COUNTRY PRICE_LIST_ID PRICE_LIST Condition is that either column should be populated These columns or Ship_to_Org_id should be present. Reference_Type should be there to populate either reference_header_id/reference_header and reference_line_id/reference_line (either id or value column should be populated. not both) Oracle Order Management Open Interface 2-111 . Condition is that either column should be populated Condition is that either column should be populated Condition is that either column should be populated Should be populated only for service items Conditional Setting requirement Only required for returns.

Integrating Oracle Order Management Using Order Import Table 2–4 OE_LINES_INTERFACE Conditional Settings Column Name Conditional Setting requirement ACCOUNTING_RULE_ID Condition is that either column should be populated ACCOUNTING_RULE PAYMENT_TERM_ID PAYMENT_TERM DEMAND_CLASS_CODE Condition is that either column should be populated DEMAND_CLASS Condition is that either column should be populated Table 2–5 OE_PRICE_ADJS_INTERFACE Required Column Name ORIG_SYS_ DOCUMENT_REF ORIG_SYS_LINE_ REF ORIG_SYS_ SHIPMENT_REF ORIG_SYS_ DISCOUNT_REF CHANGE_ SEQUENCE CHANGE_ REQUEST_CODE ORG_ID DISCOUNT_ID DISCOUNT_LINE_ ID Type VARCHAR2(50) VARCHAR2(50) VARCHAR2(50) VARCHAR2(50) VARCHAR2(50) VARCHAR2(30) NUMBER NUMBER NUMBER REQUIRED REQUIRED REQUIRED X X X (C= Conditionally Required) REQUIRED REQUIRED REQUIRED REQUIRED X X Conditionally Required for Booking Derived Optional DISCOUNT_NAME VARCHAR2(30 PERCENT AUTOMATIC_ FLAG NUMBER VARCHAR2(1) 2-112 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–5 OE_PRICE_ADJS_INTERFACE Required Column Name CONTEXT ATTRIBUTE1 ATTRIBUTE2 ATTRIBUTE3 ATTRIBUTE4 ATTRIBUTE5 ATTRIBUTE6 ATTRIBUTE7 ATTRIBUTE8 ATTRIBUTE9 ATTRIBUTE10 ATTRIBUTE11 ATTRIBUTE12 ATTRIBUTE13 ATTRIBUTE14 ATTRIBUTE15 PRICING_ CONTEXT PRICING_ ATTRIBUTE1 PRICING_ ATTRIBUTE2 PRICING_ ATTRIBUTE3 PRICING_ ATTRIBUTE4 Type VARCHAR2(30) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(30) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) (C= Conditionally Required) Conditionally Required for Booking Derived Optional X X X X X X X X X X X X X X X X X X X X X Oracle Order Management Open Interface 2-113 .

Integrating Oracle Order Management Using Order Import Table 2–5 OE_PRICE_ADJS_INTERFACE Required Column Name PRICING_ ATTRIBUTE5 PRICING_ ATTRIBUTE6 PRICING_ ATTRIBUTE7 PRICING_ ATTRIBUTE8 PRICING_ ATTRIBUTE9 PRICING_ ATTRIBUTE10 PRICING_ ATTRIBUTE11 PRICING_ ATTRIBUTE12 PRICING_ ATTRIBUTE13 PRICING_ ATTRIBUTE14 PRICING_ ATTRIBUTE15 CREATION_DATE CREATED_BY LAST_UPDATE_ DATE LAST_UPDATED_ BY LAST_UPDATE_ LOGIN Type VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) DATE NUMBER DATE NUMBER NUMBER REQUIRED REQUIRED REQUIRED REQUIRED X (C= Conditionally Required) Conditionally Required for Booking Derived Optional X X X X X X X X X X X 2-114 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–5 OE_PRICE_ADJS_INTERFACE Required Column Name PROGRAM_ APPLICATION_ID PROGRAM_ID PROGRAM_ UPDATE_DATE REQUEST_ID OPERATION_ CODE ERROR_FLAG STATUS_FLAG Type NUMBER NUMBER DATE NUMBER VARCHAR2(30) VARCHAR2(1) VARCHAR2(1) REQUIRED X X (C= Conditionally Required) Conditionally Required for Booking Derived Optional X X X X Table 2–6 OE_CREDITS_INTERFACE Required Column Name Type (C= Conditionally Required) REQUIRED Conditionally Required for Booking Derived Optional ORDER_SOURCE_ID NUMBER ORIG_SYS_ DOCUMENT_REF ORIG_SYS_LINE_ REF ORIG_SYS_ SHIPMENT_REF ORIG_SYS_CREDIT_ REF CHANGE_ SEQUENCE CHANGE_ REQUEST_CODE VARCHAR2(5 REQUIRED 0) VARCHAR2(5 REQUIRED 0) VARCHAR2(5 REQUIRED 0) VARCHAR2(5 REQUIRED 0) VARCHAR2(5 0) VARCHAR2(3 0) X X Oracle Order Management Open Interface 2-115 .

Integrating Oracle Order Management Using Order Import Table 2–6 OE_CREDITS_INTERFACE Required Column Name ORG_ID SALESREP_ID SALESREP SALES_CREDIT_ TYPE_ID SALES_CREDIT_ TYPE QUOTA_FLAG PERCENT CONTEXT ATTRIBUTE1 ATTRIBUTE2 ATTRIBUTE3 ATTRIBUTE4 ATTRIBUTE5 ATTRIBUTE6 ATTRIBUTE7 ATTRIBUTE8 ATTRIBUTE9 Type NUMBER NUMBER VARCHAR2(3 0) NUMBER C (C= Conditionally Required) Conditionally Required for Booking Derived X X X Optional VARCHAR2(3 C 0) VARCHAR2(1 ) NUMBER VARCHAR2(3 0) VARCHAR2(2 40) VARCHAR2(2 40) VARCHAR2(2 40) VARCHAR2(2 40) VARCHAR2(2 40) VARCHAR2(2 40) VARCHAR2(2 40) VARCHAR2(2 40) VARCHAR2(2 40) REQUIRED X X X X X X X X X X X 2-116 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–6 OE_CREDITS_INTERFACE Required Column Name ATTRIBUTE10 ATTRIBUTE11 ATTRIBUTE12 ATTRIBUTE13 ATTRIBUTE14 ATTRIBUTE15 CREATED_BY CREATION_DATE LAST_UPDATED_BY LAST_UPDATE_ DATE LAST_UPDATE_ LOGIN PROGRAM_ APPLICATION_ID PROGRAM_ID PROGRAM_ UPDATE_DATE REQUEST_ID Type VARCHAR2(2 40) VARCHAR2(2 40) VARCHAR2(2 40) VARCHAR2(2 40) VARCHAR2(2 40) VARCHAR2(2 40) NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER DATE NUMBER X X X X X X X X X (C= Conditionally Required) Conditionally Required for Booking Derived Optional X X X X X X Oracle Order Management Open Interface 2-117 .

Integrating Oracle Order Management Using Order Import Table 2–6 OE_CREDITS_INTERFACE Required Column Name OPERATION_CODE ERROR_FLAG STATUS_FLAG Type (C= Conditionally Required) Conditionally Required for Booking Derived Optional VARCHAR2(3 REQUIRED 0) VARCHAR2(1 ) VARCHAR2(1 ) X X Table 2–7 OE_CREDITS_INTERFACE Column Name Conditional Setting requirement SALES_CREDIT_TYPE_ID Condition is that either one these columns should be populated SALES_CREDIT_TYPE Table 2–8 OE_LOTSERIALS_INTERFACE Required Column Name ORDER_ SOURCE_ID Type NUMBER (C= Conditionally Required) REQUIRED REQUIRED REQUIRED X REQUIRED X Conditionally Required for Booking Derived Optional ORIG_SYS_ VARCHAR2(50) DOCUMENT_REF ORIG_SYS_LINE_ REF ORIG_SYS_ SHIPMENT_REF ORIG_SYS_ LOTSERIAL_REF CHANGE_ SEQUENCE VARCHAR2(50) VARCHAR2(50) VARCHAR2(50) VARCHAR2(50) 2-118 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–8 OE_LOTSERIALS_INTERFACE CHANGE_ REQUEST_CODE ORG_ID LOT_NUMBER FROM_SERIAL_ NUMBER TO_SERIAL_ NUMBER QUANTITY CONTEXT ATTRIBUTE1 ATTRIBUTE2 ATTRIBUTE3 ATTRIBUTE4 ATTRIBUTE5 ATTRIBUTE6 ATTRIBUTE7 ATTRIBUTE8 ATTRIBUTE9 ATTRIBUTE10 ATTRIBUTE11 ATTRIBUTE12 ATTRIBUTE13 ATTRIBUTE14 ATTRIBUTE15 CREATED_BY VARCHAR2(30) NUMBER NUMBER VARCHAR2(30) VARCHAR2(30) NUMBER VARCHAR2(30) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) NUMBER REQUIRED REQUIRED REQUIRED C C C REQUIRED X X X X X X X X X X X X X X X X X X CREATION_DATE DATE LAST_UPDATED_ NUMBER BY Oracle Order Management Open Interface 2-119 .

Integrating Oracle Order Management Using Order Import Table 2–8 OE_LOTSERIALS_INTERFACE LAST_UPDATE_ DATE LAST_UPDATE_ LOGIN PROGRAM_ APPLICATION_ ID PROGRAM_ID PROGRAM_ UPDATE_DATE REQUEST_ID OPERATION_ CODE ERROR_FLAG STATUS_FLAG DATE NUMBER NUMBER REQUIRED REQUIRED X NUMBER DATE NUMBER REQUIRED VARCHAR2(30) VARCHAR2(1) VARCHAR2(1) X X X X X Table 2–9 OE_RESERVTNS_INTERFACE Required Column Name ORDER_ SOURCE_ID Type NUMBER (C= Conditionally Required) REQUIRED REQUIRED REQUIRED X REQUIRED Conditionally Required for Booking Derived Optional ORIG_SYS_ VARCHAR2(50) DOCUMENT_REF ORIG_SYS_LINE_ REF ORIG_SYS_ SHIPMENT_REF ORIG_SYS_ RESERVATION_ REF CHANGE_ SEQUENCE VARCHAR2(50) VARCHAR2(50) VARCHAR2(50) VARCHAR2(50) X 2-120 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–9 OE_RESERVTNS_INTERFACE Required Column Name ORG_ID INVENTORY_ ITEM_ID REVISION LOT_NUMBER_ ID LOT_NUMBER Type NUMBER NUMBER VARCHAR2(3) NUMBER VARCHAR2(30) REQUIRED X X REQUIRED X X X X X X X X X X X X X REQUIRED X X X (C= Conditionally Required) Conditionally Required for Booking Derived X Optional SUBINVENTORY_ NUMBER ID SUBINVENTORY_ VARCHAR2(10) CODE LOCATOR_ID QUANTITY ATTRIBUTE_ CATEGORY ATTRIBUTE1 ATTRIBUTE2 ATTRIBUTE3 ATTRIBUTE4 ATTRIBUTE5 ATTRIBUTE6 ATTRIBUTE7 ATTRIBUTE8 ATTRIBUTE9 ATTRIBUTE10 ATTRIBUTE11 ATTRIBUTE12 NUMBER NUMBER VARCHAR2(30) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) Oracle Order Management Open Interface 2-121 .

Integrating Oracle Order Management Using Order Import Table 2–9 OE_RESERVTNS_INTERFACE Required Column Name ATTRIBUTE13 ATTRIBUTE14 ATTRIBUTE15 OPERATION_ CODE REQUEST_ID ERROR_FLAG Type VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(30) NUMBER VARCHAR2(1) REQUIRED X X (C= Conditionally Required) Conditionally Required for Booking Derived Optional X X X Table 2–10 OE_ACTIONS_INTERFACE Required Column Name ORDER_ SOURCE_ID Type NUMBER REQUIRED X X X X X X X (C= Conditionally Required) Conditionally Required for Booking Derived Optional X ORIG_SYS_ VARCHAR2(50) DOCUMENT_REF ORIG_SYS_LINE_ REF ORIG_SYS_ SHIPMENT_REF CHANGE_ SEQUENCE ORG_ID HOLD_ID HOLD_TYPE_ CODE HOLD_TYPE_ID VARCHAR2(50) VARCHAR2(50) VARCHAR2(50) NUMBER NUMBER VARCHAR2(1) NUMBER 2-122 Oracle Order Management Suite APIs and Open Interfaces Manual .

Integrating Oracle Order Management Using Order Import Table 2–10 OE_ACTIONS_INTERFACE HOLD_UNTIL_ DATE RELEASE_ REASON_CODE COMMENTS CONTEXT ATTRIBUTE1 ATTRIBUTE2 ATTRIBUTE3 ATTRIBUTE4 ATTRIBUTE5 ATTRIBUTE6 ATTRIBUTE7 ATTRIBUTE8 ATTRIBUTE9 ATTRIBUTE10 ATTRIBUTE11 ATTRIBUTE12 ATTRIBUTE13 ATTRIBUTE14 ATTRIBUTE15 REQUEST_ID OPERATION_ CODE ERROR_FLAG STATUS_FLAG DATE VARCHAR2(30) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) VARCHAR2(240) NUMBER VARCHAR2(30) VARCHAR2(1) VARCHAR2(1) REQUIRED X X X X X X X X X X X X X X X X X X X X X X Oracle Order Management Open Interface 2-123 .

If placed at the order header level. and manage sales credits from Order Management transactions. Using order management transaction types and profile options. and credits on account from Order Management transactions Major Features Invoicing Interface Activity Order Management provides a powerful program that automatically collects order and return information and populates the Oracle Receivables AutoInvoice interface tables. you control certain accounting aspects of the information being transferred to Oracle Receivables. credit memos. create credit memos and credits on account. you can create invoices. all lines in an order are populated in AutoInvoice interface tables at the same time.Integrating Oracle Order Management with Oracle Receivables for Invoicing Integrating Oracle Order Management with Oracle Receivables for Invoicing Oracle Order Management provides functionality to integrate with Oracle Receivables. Order Management uses the invoice source setup at the transaction type level or the profile option OM: Invoice Source when populating order line information into AutoInvoice interface tables. Invoice Source You must setup invoice sources in Oracle Receivables prior to using Oracle Order Management. recognize revenue. Invoicing module is modeled using workflow and can happen after shipping for shippable flows and any time after booking for non-shippable flows. Basic Needs Oracle Order Management and Oracle Receivables provide features you need to satisfy the following integration needs: s Create accurate and timely invoices. Invoicing can be placed at both order line level workflows as well as order header level workflows. Using Oracle Order Management Invoice Interface and Oracle Receivables AutoInvoice. you must create at least one invoice source for Order Management’s use if you want to interface orders and returns for processing by AutoInvoice. When defining invoice sources in Oracle Receivables. 2-124 Oracle Order Management Suite APIs and Open Interfaces Manual .

Oracle Order Management Open Interface 2-125 .Integrating Oracle Order Management with Oracle Receivables for Invoicing The following table shows the necessary field values for the Transaction Source window in Oracle Receivables.

No if set to Delivery Name Customer Information region Sold-to Customer Bill-to Customer Bill-to Address Bill-to Contact Ship-to Customer Ship-to Address Ship-to Contact Payment Method Rule Customer Bank Account Id Id Id Id Id Id Id (any) (any) Accounting Information region Invoicing Rule Accounting Rule Accounting Flexfield Derive Date Payment Terms Revenue Account allocation Id Id (any) (any) Id (any) Other Information region Transaction Type Memo Reason Agreement Memo Line Rule Id Id Id Id 2-126 Oracle Order Management Suite APIs and Open Interfaces Manual .Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–11 Transaction Sources Window: Required Settings Field in Transaction Sources Window Necessary Value Batch Source region Type Status Automatic Transaction Numbering Imported Active Yes if OM: Invoice Numbering Method is set to Automatic.

Automatic Account Code Creation Oracle Receivables uses AutoAccounting to determine the revenue account for all transactions from Order Management. AutoInvoice automatically calculates sales tax based on the Sales Tax Location flexfield combination. regardless of your setting for the OM: Invoice Numbering Method profile. This information is transferred to Oracle Receivables and used to determine the invoice date (invoicing rule) and general ledger distribution records (accounting rule). you must define at least one transaction source with automatic invoice numbering. if you have designated an item as non-taxable. AutoAccounting lets you define what information is used to define the various segments of your Accounting Flexfield.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–11 Transaction Sources Window: Required Settings Field in Transaction Sources Window Sales Territory Inventory Item Unit of Measure FOB Point Freight Carrier Related Document Necessary Value (any) Id Id Code Code Id Sales Credits Validation region Salesperson Sales Credit Type Sales Credit Id Id Percent Note: In the Batch Source region. AutoInvoice will not tax the item. Order Management Oracle Order Management Open Interface 2-127 . Similarly. If you have designated a customer as tax-exempt. AutoInvoice will not tax any items billed for the customer. Accounting and Invoicing Rules Order Management uses accounting and invoicing rules. Automatic Tax Calculation As orders from Order Management are processed.

In R11i Invoice interface code always get this information from the sales order line. then. If you referenced a commitment on the order line that is associated with an agreement that does not allow override of the accounting rule. then. 3. 2.. Agreement Order type For Order Line 1. The user needs to setup appropriate defaulting rules to populate this information.ACCOUNTING_ RULE_ID). 4. . if not. Order Management inserts the accounting rule from the associated agreement (OE_AGREEMENTS. except for when the accounting rule is Immediate. Order Management inserts the accounting rule from the agreement (OE_AGREEMENTS.. in which case Order Management does not pass any value (inserts null). 2 2-128 Oracle Order Management Suite APIs and Open Interfaces Manual . 2. Agreement Line Type Inventory Item Order Header Table 2–12 Accounting Rule Hierarchy for Sales Order Lines Accounting Rule Hierarchy for Sales Order Lines 1 If you referenced an agreement on the order that does not allow override of the accounting rule. We have seeded a defaulting rule to derive the following hierarchy: 1..Integrating Oracle Order Management with Oracle Receivables for Invoicing passes an invoicing rule and accounting rule for each order transaction interfaced to Oracle Receivables. ACCOUNTING_RULE_ID).. if not. Accounting Rules The hierarchy given for Accounting rules and Invoicing rules was followed in R11 but not now.

5 6 7 Invoicing Rules Order Management determines the invoicing rule for a sales order line based on the following hierarchy: Table 2–13 Invoicing Rule Hierarchy for Sales Order Lines Invoicing Rule Hierarchy for Sales Order Lines 1 If you referenced an agreement on the order that does not allow override of the invoicing rule.ACCOUNTING_RULE_ID).. then.ACCOUNTING_RULE_ID). if not. Order Management inserts the invoicing rule from the agreement (OE_ AGREEMENTS. If you referenced a commitment on the order that is associated with an agreement that does allow override of the accounting rule. If you referenced a commitment on the order line that is associated with an agreement that does not allow override of the invoicing rule.. If you defined an accounting rule for the item..ACCOUNTING_RULE_ID). if not.ACCOUNTING_ RULE_ID). then.. then.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–12 Accounting Rule Hierarchy for Sales Order Lines Accounting Rule Hierarchy for Sales Order Lines 3 4 Line transaction types associated with the order line (OE_TRANSACTION_ TYPES.. Order Management inserts the accounting rule on the order. then... Order Management inserts the invoicing rule from the agreement (OE_AGREEMENTS. if not. Order Management inserts the accounting rule from the agreement (OE_AGREEMENTS. Order Management inserts the accounting rule from the associated agreement (OE_AGREEMENTS. then. In all other cases... Order Management will use the accounting rule for the item (MTL_SYSTEM_ITEMS. 2 Oracle Order Management Open Interface 2-129 .INVOICING_RULE_ID). if not.INVOICING_RULE_ID). If you referenced an agreement on the order line that does allow override of the accounting rule.. if not.

. even if it is placed in the internal sales order’s workflow. If you defined an invoicing rule for the item. If the Credit Method for Accounting Rule field for the order type is null. This credit method is recognized only by invoices that use duration accounting rules. Order Management inserts the invoicing rule from that agreement (OE_AGREEMENTS.. This credit method is used for crediting an invoice that uses split payment terms.INVOICING_ RULE_ID). if not.INVOICING_RULE_ID). You can assign a Credit Method for Installments to the order type of the return. Internal sales orders are orders that originate in Oracle Purchasing as internal requisitions.. 5 6 7 Credit Method for Accounting Rule Order Management transfers a Credit Method for Accounting Rule for each return line.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–13 Invoicing Rule Hierarchy for Sales Order Lines Invoicing Rule Hierarchy for Sales Order Lines 3 4 Line transaction types associated with the order line (OE_TRANSACTION_ TYPES. then. Order Management will use the invoicing rule for the item (MTL_SYSTEM_ITEMS. You can assign a Credit Method for Accounting Rule to the order type of the return.. Order Management inserts the invoicing rule from the agreement. Order Management inserts the invoicing rule on the order. if not. and are imported to Order Management as internal sales orders using Order Import. then. Credit Method for Installments Order Management transfers a Credit Method for Installments for each return line. then Order Management transfers LIFO (Last In First Out).ACCOUNTING_RULE_ID). If the Credit Method for Installments field for the order type is null.INVOICING_RULE_ID).. In all other cases. If you referenced an agreement on the order that does allow override of the invoicing rule. if not. 2-130 Oracle Order Management Suite APIs and Open Interfaces Manual .. (OE_ AGREEMENTS. then Order Management transfers LIFO (Last In First Out). then. Internal Sales Orders The Invoicing Activity does not process internal sales order lines. If you referenced a commitment on the order line that is associated with an agreement that does allow override of the invoicing rule.

Order Management does not pass invoicing information to Oracle Receivables for any order lines for the components within the configuration. For an item to be invoiceable. including Model A and Model 1.Integrating Oracle Order Management with Oracle Receivables for Invoicing See Also Using AutoAccounting. Oracle Receivables User’s Guide Invoicing of ATO Configurations Invoicing Attributes For ATO configurations. Oracle Order Management Open Interface 2-131 . the control relationship is the child affecting the parent. Invoiceable Item and Invoice Enabled need to be set properly. Oracle Inventory User’s Guide Accounting for Credit Memos. the immediate parent. Oracle Receivables User’s Guide Entering Commitments. It looks at the item attributes of each line separately to determine whether to interface that line or not. Required for Revenue Attribute The bill of material attribute Required for Revenue allows you to define specific items in a bill that must be shipped before their parent can be invoiced. All other components. Order Management then considers these item attributes for each component in the bill of material for the model to see if they should be invoiced in Oracle Receivables. Oracle Receivables User’s Guide Defining Items. Option A is not eligible to interface to Oracle Receivables until Included Item A is shipped. For example: Included Item A has the Required for Revenue attribute set to Yes. Order Management considers the base model’s item attribute of a configuration to see if it should consider passing invoice information to Oracle Receivables for each order line in the configuration. These attributes are set when you define the items. Except for classes. Oracle Receivables User’s Guide Accounting Rules. If the item attributes Invoiceable Item or Invoice Enabled are set to No for the base model item. even if Option A is also shippable and has shipped. the item attributes. If you have the item attributes Invoiceable Item and Invoice Enabled set to Yes for the base model item. It is not determine based on the base model’s item attributes as mentioned in the document. In all cases the control applies to only one level. regardless of the item attribute settings. Invoice Interface processes each line in ATO configuration individually. are eligible to interface regardless of Included Item A’s shipment status.

The following describes what information Order Management interfaces for each order and order line. RA_INTERFACE_ DISTRIBUTIONS is not described in this essay because all account code creation is done by AutoInvoice based on the AutoAccounting rules you have defined.NAME in the base language. And again.Integrating Oracle Order Management with Oracle Receivables for Invoicing Example #2: Included Item B has the Required for Revenue attribute set to Yes. create an invoice line ordering rule with the attribute SALES_ ORDER_LINE to list the items on the invoice in the same order as they appear on the sales order.ORDER_NUMBER. Oracle Order Management User’s Guide Overview of Bills of Material. both Option C and Class C are not eligible to interface until Included Item C is shipped. Oracle Bills of Material User’s Guide Understanding the Interface Tables Oracle Order Management inserts information into two of the three AutoInvoice interface tables (RA_INTERFACE_LINES and RA_INTERFACE_SALES_CREDITS). See Also Item Attributes Used by Order Management. Model 1 is not eligible to interface to Oracle Receivables until Included Item B is shipped. Option A is not eligible to interface until Included Item A is shipped. Therefore. For example. Suggestion: If you are importing transactions from Oracle Order Management. Order Management inserts your value for the OM: Source Code profile option Order Management inserts OE_ HEADERS. Order Management inserts OE_ORDER_ TYPES_V. each sales credit. Table 2–14 RA_INTERFACE_LINES Column Name INTERFACE_LINE_ ID INTERFACE_LINE_ CONTEXT INTERFACE_LINE_ ATTRIBUTE1 INTERFACE_LINE_ ATTRIBUTE2 Null? Type NUMBER(15) Varchar2(30) Varchar2(30) Varchar2(30) Description Order Management does not insert a value into this column. then that item must be shipped before the parent item and the other items in the class are eligible to interface. in the figure above. 2-132 Oracle Order Management Suite APIs and Open Interfaces Manual . Example #3: If any item below a class in a bill has the Required for Revenue attribute set to Yes. Included Item C has the Required for Revenue attribute set to Yes. and each freight charge.

Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–14 RA_INTERFACE_LINES Column Name INTERFACE_LINE_ ATTRIBUTE3 Null? Type Varchar2(30) Description For a Shipped order line and for Freight Charges: Order Management inserts sunstr(wsh_new_deliveries. if one is defined. INTERFACE_LINE_ ATTRIBUTE6 Varchar2(30) For a Sales order or return line: Order Management inserts OE_ORDER_ LINES. For Freight charges: OE_CHARGE_LINES_ V. a return line. For Freight charges: Order Management inserts a value of 1(one). For all other lines '0' is passed. oe_price_adjustments.SHIP_FROM_ORD_ID. a non-shipped order line.CHARGE_ID. it inserts 0 (zero).price_adjustment_ id for discount lines: profile (OM: Show Discount Details on Invoice must be Yes.waybill1. or for Freight Charges: Order Management inserts zero (0).LINE_ID. a return line.30 For a Non-shipped order line or a Return Line: Order Management inserts 0 (zero). Order Management inserts the customer item number. INTERFACE_LINE_ ATTRIBUTE4 Varchar2(30) For a Shipped order line and for Freight Charges: Order Management inserts: sunstr(wsh_new_deliveries.). INTERFACE_LINE_ ATTRIBUTE7 INTERFACE_LINE_ ATTRIBUTE8 INTERFACE_LINE_ ATTRIBUTE9 INTERFACE_LINE_ ATTRIBUTE10 INTERFACE_LINE_ ATTRIBUTE11 Varchar2(30) For a shipped order line. For a shipped order line. Varchar2(30) Varchar2(30) Varchar2(30) Varchar2(30) Oracle Order Management Open Interface 2-133 . Otherwise.. or for Freight Charges: Order Management inserts zero (0). INTERFACE_LINE_ ATTRIBUTE5 Varchar2(30) For a Sales order or return line: Order Management inserts the number of times the order or return line has been interfaced for invoice or credit..name1. Order Management inserts OE_ORDER_ LINES.30 For a Non-shipped order line or a Return Line: Order Management inserts 0 (zero).

Order Line Transaction Type associated with the order line being interfaced to AutoInvoice. 3.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–14 RA_INTERFACE_LINES Column Name INTERFACE_LINE_ ATTRIBUTE12-15 BATCH_SOURCE_ NAME Null? Type Varchar2(30) Not Null Varchar2(50) Description Order Management does not insert any values into any of these column Order Management enters the invoice source name using the following rules: If OM: Invoice Numbering Method is set to Delivery Name. 2. Line type 2. otherwise the system inserts LINE. but line is non-shippable or a return line. Order Management uses the following sequence to determine the invoice source: 1. Order Transaction Type associated with the order line being interfaced to AutoInvoice. Order Management passes the value of the profile option OM: Non-Delivery Invoice Source. SET_OF_BOOKS_ID Not Null NUMBER (15) Order Management inserts the ID from the OE: Set of Books system parameter for the operating unit of the order line. Non-Delivery Invoice Source is also derived from the following hierarchy: 1. Not Null Varchar2(20) For a Sales order or return line: Order Management inserts LINE. LINE _TYPE 2-134 Oracle Order Management Suite APIs and Open Interfaces Manual . Value of the profile option OM: Invoice Source. Profile Option OM:Non-Delivery Invoice Source For all other lines. Order Type 3. For Freight charges: Order Management inserts FREIGHT for shipment freight charges if the profile option TAX: Invoice Freight as Revenue is set to No.

Order Management rounds the amount based on the minimum accounting unit and precision associated with the currency of the order.transactiona_curr_code for all shipped/non shipped order/return lines. For a Sales order or return line: Order Management inserts a calculated amount (OE_ORDER_LINES. For Freight charges: Order Management inserts: oe_charge_lines_v.charge_amount CUST_TRX_TYPE_ NAME CUST_TRX_TYPE_ID Varchar2(20) Order Management does not insert a value into this column AMOUNT NUMBER NUMBER (15) Please refer to the heading CUST_TRX_ TYPE_ID at the end of this table for more information Oracle Order Management Open Interface 2-135 .DESCRIPTION for the item or if order line uses item identifiers (item/generic item): s Not Null Varchar2(240) if a description exists. if the description is null then mtl_ system_items_vl. customer item/generic item description is passed.description) for shipment freight charges.CREATION_SIGN.UNIT_SELLING_ PRICE multiplied by OE_ORDER_ LINES.description is passed s For Freight charges: Order Management inserts description of the change (OE_ CHARGE_TYPES.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–14 RA_INTERFACE_LINES Column Name DESCRIPTION Null? Type Description For a Sales order or return line: Order Management inserts MTL_ SYSTEM_ITEMS. The amount sign will match the sign on the quantity based on the value of RA_ CUST_TRX_TYPES.ORDERED_QUANTITY) based on the calculated quantity. CURRENCY_CODE Not Null Varchar2(30) oe_order_headers.

payment_ term_id. NUMBER (15) Order Management inserts: oe_order_ lines. Order Management inserts: SELECT customer_id FROM oe_invoice_to_orgs_v WHERE organization_id = oe_order_ lines.invoice_to_org_id NUMBER(15) ORIG_SYSTEM_ BILL_ADDRESS_REF ORIG_SYSTEM_ BILL_ADDRESS_ID Varchar2(240) Order Management does not insert a value into this column. For a Return line: Order Management does not insert a value into this column.invoice_to_contact_id Varchar2(240) Order Management does not insert a value into this column 2-136 Oracle Order Management Suite APIs and Open Interfaces Manual . NUMBER (15) For a Sales order line: Order Management inserts OE_ORDER_LINES.invoice_to_org_id ORIG_SYSTEM_ BILL_CONTACT_REF ORIG_SYSTEM_ BILL_CONTACT_ID ORIG_SYSTEM_ SHIP_CUSTOMER_ REF Varchar2(240) Order Management does not insert a value into this column. ORIG_SYSTEM_ BILL_CUSTOMER_ REF ORIG_SYSTEM_ BILL_CUSTOMER_ID Varchar2(240) Order Management does not insert a value into this column. NUMBER (15) Order Management inserts: SELECT address_id FROM oe_invoice_to_orgs_v WHERE organization_id = oe_order_ lines.PAYMENT_ TERM_ID.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–14 RA_INTERFACE_LINES Column Name TERM_NAME TERM_ID Null? Type Varchar2(15) Description Order Management does not insert a value into this column. for Freight charges: Order Management inserts: oe_order_lines_all.

Order Management does not insert any values into any of these columns.SOLD_TO_ORG_ID.15 Vaqrchar2(24) Order Management does not insert a value into this column.SITE_USE_ID = OE_ORDER_ HEADERS.ship_to_contact_id Order Management does not insert a value into this column.ADDRESS_ID FROM RA_ ADDRESSES WHERE RA_SITE_ USES.SITE_USE_ID = NVL(OE_ORDER_ LINES. NUMBER(15) Varchar2(240) NUMBER(15) NUMBER(15) Vharchar2(30) Vharchar2(30) Oracle Order Management Open Interface 2-137 . Order Management inserts: oe_order_ lines.SHIP_TO_SITE_ USE_ID))). Order Management does not insert a value into this column. For a Sales order or return line: Order Management inserts RA_SITE_ USES. Order Management does not insert a value into this column. OE_ ORDER_HEADERS.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–14 RA_INTERFACE_LINES Column Name ORIG_SYSTEM_ SHIP_CUSTOMER_ ID Null? Type Description NUMBER (15) Order Management inserts SELECT customer_id FROM oe_ship_to_orgs_v WHERE organization_id = oe_order_ lines.ADDRESS_ID FROM RA_ADDRESSES WHERE RA_ SITE_USES. ORIG_SYSTEM_ SHIP_CONTACT_ REF ORIG_SYSTEM_ SHIP_CONTACT_ID ORIG_SYSTEM_ SOLD_CUSTOMER_ REF ORIG_SYSTEM_ SOLD_CUSTOMER_ ID LINK_TO_LINE_ID LINK_TO_LINE_ CONTEXT LINK_TO_LINE_ ATTRIBUTE1 .ship_to_org_id ORIG_SYSTEM_ SHIP_ADDRESS_REF ORIG_SYSTEM_ SHIP_ADDRESS_ID Varchar2(240) NUMBER(15) Order Management does not insert a value into this column. Order Management inserts OE_ORDER__ LINES. For Freight charges: Order Management inserts RA_SITE_USES.SHIP_TO_SITE_USE_ID.SHIP_TO_SITE_USE_ID).

Order Management does not insert a value into this column. For example. If the profile is set to Delivery Name. Order Management might insert delivery for the first invoice.CONVERSION_DATE.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–14 RA_INTERFACE_LINES Column Name RECEIPT_METHOD_ NAME RECEIPT_METHOD_ ID CONVERSION_TYPE Not NULL CONVERSION_DATE CONVERSION_RATE CUSTOMER_TRX_ID TRX_DATE GL_DATE DOCUMENT_ NUMBER TRX_NUMBER Null? Type Vharchar2(30) NUMBER(15) Varchar2(30) Description Order Management does not insert a value into this column. Order Management inserts a delivery name. Order Management inserts OE_ORDER_ HEADERS. An index is appended if the delivery has more than one invoice. Date NUMBER NUMBER(15) Date Date NUMBER(15) Varchar2(240) LINE_NUMBER NUMBER(15) 2-138 Oracle Order Management Suite APIs and Open Interfaces Manual . If the OM: Invoice Numbering Method profile is set to Automatic. delivery-1 for the second. delivery-2 for the third. Order Management inserts OE_ORDER_ HEADERS. Order Management does not insert a value into this column. Order Management inserts NVL(OE_ ORDER_HEADERS. Order Management does not insert a value into this column. Order Management does not insert a value into this column. Order Management does not insert a value into this column.CONVERSION_RATE.CONVERSION_ TYPE. Order Management does not insert a value into this column. AutoInvoice determines a unique number for this transaction. and so on. User).

For Freight charges: Order Management does not insert a value into this column UNIT_SELLING_ PRICE NUMBER For a Sales order line or return lines: Order Management inserts OE_ORDER_ LINES.UNIT_LIST_PRICE.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–14 RA_INTERFACE_LINES Column Name QUANTITY Null? Type NUMBER Description Order Management inserts a calculated quantity based on the type of line being interfaced. Order Management does not insert a value into this column. For a Sales order line or return line: Order Management inserts OE_ORDER_ LINES. For Freight charges: Order Management does not insert a value into this column. For a Sales order line: The quantity will be either negative or positive. If RA_ CUST_TRX_TYPES. QUANTITY_ ORDERED NUMBER For a Sales order line or return line: Order Management inserts OE_ORDER_ LINES. over and under shipments. PRINTING_OPTION INTERFACE_STATUS REQUEST_ID Varchar2(20) Varchar2(1) NUMBER(15) Order Management does not insert a value into this column. required for revenue and what was previously invoiced.CREATION_SIGN associated with the invoice type for the sales order.ORDERED_QUANTITY. depending on the value of RA_CUST_TRX_ TYPES. UNIT_SELLING_ PRICE_PER_PQTY UNIT_STANDARD_ PRICE NUMBER NUMBER Unit Selling Price Per Pricing Quantity. This calculation is based on rules for fulfillment. then quantity passed is -1 multiplied by the quantity calculated.UNIT_SELLING_PRICE. For Freight charges: Order Management does not insert a value into this column. Oracle Order Management Open Interface 2-139 . Order Management does not insert a value into this column. CREATION_SIGN is N.

Line transaction type 2.tax_code Order Management does not insert a value into this column. then pass oe_order_lines. If OM: Tax: Allow Override of Tax Code = Yes. Line transaction type 2.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–14 RA_INTERFACE_LINES Column Name RELATED_BATCH_ SOURCE_NAME RELATED_TRX_ NUMBER RELATED_ CUSTOMER_TRX_ID PREVIOUS_ CUSTOMER_TRX_ID CREDIT_METHOD_ FOR_ACCT_RULE Null? Type Varchar2(50) Varchar2(20) NUMBER(15) NUMBER(15) Varchar2(30) Description Order Management does not insert a value into this column.RETURN_ REASON_CODE TAX_RATE TAX_CODE TAX_PRECEDENCE NUMBER Varchar2(50) NUMBER(15) Order Management does not insert a value into this column. Order Management does not insert a value into this column. Order transaction type REASON_CODE Varchar2(30 For a Sales order line: Order Management does not insert a value into this column. For a Return line: Order Management inserts OE_ORDER_LINES. For a Sales order line: Order Management does not insert a value into this column. Order transaction type 3. For a Return line: Order Management inserts from based upon the following hierarchy: 1. Order Management does not insert a value into this column. For a Return line: Order Management inserts from based upon the following hierarchy: 1. else insert constant value LIFO CREDIT_METHOD_ FOR_ INSTALLMENTS Varchar2(30) For a Sales order line: Order Management does not insert a value into this column. 2-140 Oracle Order Management Suite APIs and Open Interfaces Manual . Order Management does not insert a value into this column.

SHIP_VIA Varchar2(20) Either nvl(wsh_carrier_ship_methods_ v.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–14 RA_INTERFACE_LINES Column Name EXCEPTION_ID EXEMPTION_ID SHIP_DATE_ ACTUAL Null? Type NUMBER(15) NUMBER(15) Date Description Order Management does not insert a value into this column.FOB_POINT_ CODE. For a Shipped order line: Order Management inserts OE_ORDER_ LINES. INVOICING_RULE_ NAME Varchar2(30) Order Management does not insert a value into this column. For a Shipped order lines and for Freight charge lines: Order Management inserts: wsh_new_deliveries. FOB_POINT Varchar2(20) Order Management only populates this column if the order line being invoiced has been shipped. WAYBILL_NUMBER Varchar2(50) Oracle Order Management Open Interface 2-141 .initial_pickup_date.FOB_POINT_CODE.1. For a Non-shipped order line: Order Management does not insert a value into this column. Order Management does not insert a value into this column.waybill.freight_ carrier_code) For a Shipped order line and For Freight charges: Order Management inserts: substr(wsh_new_deliveries. For Freight charges: Order Management inserts OE_ORDER_LINES. For Freight charges: Order Management inserts OE_ORDER_LINE_ACTUAL_ SHIPMENT_DATE.feight_code or oe_order_lines.30) For a Non-shipped order line: Order Management does not insert a value into this column. For a Non-shipped order line: Order Management does not insert a value into this column.

INVOICING_RULE_ID). Order Management inserts NVL (OE_ ORDER_LINES. ACCOUNTING_ RULE_DURATION RULE_START_DATE PRIMARY_ SALESREP_NUMBER PRIMARY_ SALESREP_ID SALES_ORDER SALES_ORDER_LINE NUMBER(15) If the accounting rule is of type Variable Duration then insert Service Duration for Service lines.1. For a Sales order or return line: Order Management inserts OE_ORDER_ LINES. For a Return line: Order Management does not insert a value into this column. Order Management inserts OE_ORDER_ HEADERS.SALESREP_ID. OE_ ORDER_HEADERS. NULL. Date Varchar2(30) NUMBER(15) Varchar2(50) Varchar2(30) 2-142 Oracle Order Management Suite APIs and Open Interfaces Manual .1.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–14 RA_INTERFACE_LINES Column Name INVOICING_RULE_ ID Null? Type NUMBER(15) Description For a Sales order line and for Freight charge lines: Order Management inserts DECODE(ACCOUNTING_RULE_ID. For a Non-shipped order line: Order Management does not insert a value into this column.SALESREP_ID. Order Management does not insert a value into this column.ORDER_NUMBER. For Freight charges: Order Management does not insert a value into this column.LINE_NUMBER.ACCOUNTING_RULE_ID).ORDERED_DATE. Order Management inserts your value for the OM: Source Code profile option. Order Management does not insert a value into this column. SALES_ORDER_ DATE SALES_ORDER_ SOURCE Date Varchar2(50) Order Management inserts OE_ORDER_ HEADERS. For a Sales order line and for Freight charge lines: Order Management inserts DECODE(ACCOUNTING_RULE_ID. ACCOUNTING_ RULE_NAME ACCOUNTING_ RULE_ID Varchar2(30) NUMBER(15) Order Management does not insert a value into this column. NULL.

For a Sales order line: Order Management inserts OE_ORDER_ LINES. for a Sales order or return line: Order Management inserts OE_ORDER_ LINES. Order Management does not insert a value into this column...INVENTORY_ITEM_ID. For return lines with an invoice reference: Order Management does not insert a value into this column. For Freight charges: Order Management does not insert a value into this column. Order Management does not insert a value into this column. MTL_SYSTEM_ ITEMS_SEG1.LINES. the value of the profile option TAX: Inventory Item For Freight is used. If the profile option TAX: Invoice Freight As Revenue is set to Yes. For Freight charges: Order Management does not insert a value into this column. Order Management does not insert a value into this column.20 Varchar2(30) Order Management does not insert values into any of these columns.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–14 RA_INTERFACE_LINES Column Name SALES_ORDER_ REVISION PURCHASE_ORDER PURCHASE_ORDER_ REVISION PURCHASE_ORDER_ DATE AGREEMENT_ NAME AGREEMENT_ID Null? Type NUMBER Varchar2(50) Varchar2(50) Date Varchar2(30) NUMBER(15) Description Order Management does not insert a value into this column.. Order Management does not insert a value into this column. Oracle Order Management Open Interface 2-143 .AGREEMENT_ID. For a Return line with a purchase order or sales order reference: Order Management inserts the AGREEMENT_ID from the referenced order line. MEMO_LINE_NAME MEMO_LINE_ID INVENTORY_ITEM_ ID Varchar2(50) NUMBER(15) NUMBER(15) Order Management does not insert a value into this column. Order Management inserts OE_ORDER_ HEADERS.CUST_PO_ NUMBER.

customer_trx_line_id of the commitment line. For Freight charges: Order Management inserts OE_CHARGE_LINES_V....20 ATTRIBUTE_ CATEGORY Varchar2(25) Varchar2(30) Get territory segments from ra_territories based on the territory_id.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–14 RA_INTERFACE_LINES Column Name REFERENCE_LINE_ ID Null? Type NUMBER(15) Description For a Sales order line: If the line has commitment then interface ra_customer_ trx_lines.. REFERENCE_LINE_ CONTEXT REFERENCE_LINE_ ATTRIBUTE1.15 TERRITORY_ID Varchar2(30) Varchar2(30) NUMBER(15) Order Management does not insert a value into this column. For a Return line: Order Management inserts OE_ORDER_LINES. Order Management does not insert a value into this column.ATTRIBUTE1-15. ATTRIBUTE1. ATTRIBUTE1-15.. For Freight charges: Order Management inserts OE_CHARGE_LINES_ V. 2-144 Oracle Order Management Suite APIs and Open Interfaces Manual .CONTEXT. If default territory = 'SALES' get territory_id from ra_salesrep_territories based on salesrep_id If default territory = 'BILL' get territory_id from ra_site_uses based on bill to organization If default territory = 'SHIP' get territory_id from ra_site_uses based on ship to organization TERRITORY_ SEGMENT1.CONTEXT.CREDIT_ INVOICE_LINE_ID. Territory_id is populated based on default territory in ar_system_parameters.... For Freight charges: Order Management does not insert a value into this column.15 Varchar2(150) For a Sales order or return line: Order Management inserts OE_ORDER_ LINES. For a Sales order or return line: Order Management inserts OE_ORDER_ LINES.

Order Management does not insert a value into this column.SHIPPING_QUANTITY_UOM.ATTRIBUTE1-15. Varchar2(30) NUMBER NUMBER(15) Varchar2(25) Varchar2(3) Oracle Order Management Open Interface 2-145 .Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–14 RA_INTERFACE_LINES Column Name HEADER_ ATTRIBUTE_ CATEGORY Null? Type Varchar2(30) Description For Sales order or return line: Order Management inserts OE_ORDER_ HEADERS. Order Management does not insert a value into this column. COMMENTS INTERNAL_NOTES INITIAL_ CUSTOMER_TRX_ID USSGL_ TRANSACTION_ CODE_CONTEXT USSGL_ TRANSACTION_ CODE ACCTD_AMOUNT CUSTOMER_BANK_ ACCOUNT_ID CUSTOMER_BANK_ ACCOUNT_NAME UOM_CODE Varchar2(240) Varchar2(240) NUMBER(15) Varchar2(30) Order Management does not insert a value into this column. For a Sales order or return line: Order Management inserts OE_ORDER_ LINES.CONTEXT. For Freight charges: Order Management does not insert a value into this column. Order Management does not insert a value into this column. Order Management does not insert a value into this column. Order Management does not insert a value into this column. For Freight charges: Order Management does not insert a value into this column.15 Varchar2(150) For a Sales order or return line: Order Management inserts OE_ORDER_LINES. Order Management does not insert a value into this column. For Freight charges: Order Management does not insert a value into this column. HEADER_ ATTRIBUTE1. UOM_NAME Varchar2(25) Order Management does not insert a value into this column.. Order Management does not insert a value into this column..

Order Management does not insert a value into this column. Order Management does not insert a value into this column. Order Management does not insert a value into this column. Order Management enters an identification number to identify the user who created the record. Order Management does not insert a value into this column. Order Management does not insert a value into this column. Order Management does not insert a value into this column. No Validation occurs CREATION_DATE LAST_UPDATED_BY Date NUMBER(15) Order Management enters the current system date when a record is created. Order Management does not insert a value into this column.TAX_EXEMPT_FLAG for order lines.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–14 RA_INTERFACE_LINES Column Name DOCUMENT_ NUMBER_ SEQUENCE_ID REASON_CODE_ NAME VAT_TAX_ID LOCATION_RATE_ ID REASON_CODE_ MEANING LAST_PERIOD_TO_ CREDIT PAYING_ CUSTOMER_ID PAYING_SITE_USE_ ID TAX_EXEMPT_FLAG Null? Type NUMBER(15) Description Order Management does not insert a value into this column. No Validation occurs Varchar2(30) NUMBER(15) NUMBER(15) Varchar2(80) NUMBER NUMBER(15) NUMBER(15) Varchar2(10) SALES_TAX_ID CREATED_BY NUMBER(15) NUMBER(15) 2-146 Oracle Order Management Suite APIs and Open Interfaces Manual . Order Management does not insert a value into this column. Order Management enters an identification number to identify the user who created or who most recently modified the record. Order Management inserts OE_ HEADERS.

Line transaction type Order Transaction type Profile OM: Invoice Transaction type Retrieve receivables transaction type from: For referenced return line: a. b. d. Order Management does not insert a value into this column. c. Order Management inserts OE_ORDER_ LINE.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–14 RA_INTERFACE_LINES Column Name LAST_UPDATE_ DATE Null? Type Date Description Order Management enters the current date when a record is updated. Profile OM: Credit memo Transaction Type For non-referenced return line: a.TAX_EXEMPT_REASON_ CODE for order lines. Varchar2(80) Varchar2(80) CUST_TRX_TYPE_ID Value is determined based upon the following hierarchy: For a Sales order line: a. Line transaction type Default return transaction type defined for the referenced order line. Oracle Order Management Open Interface 2-147 . Line transaction type Order transaction type only if order_category is RETURN. b. b. Standard Validation occurs LOCATION_ SEGMENT_ID TAX_EXEMPT_ REASON_CODE TAX_EXEMPT_ NUMBER TAX_EXEMPT_ REASON_CODE_ MEANING NUMBER(15) Varchar2(30) Order Management does not insert a value into this column. Order transaction type only if order_category is RETURN.TAX_EXEMPT_NUMBER for order lines. c. Order Management inserts OE_ORDER_ LINE.

.. Insert sales credits associated with the line. KIT or STANDARD and OPTION_FLAG is Y). Profile OM: Credit memo Transaction Type For freight charges: Freight charges value is the same as the order/return line that is interfacing the freight charge. if none exists. then. 2.. then. Insert sales credits associated with the model parent line. Insert sales credits associated with the order header. if none exists but the line is part of a configuration (ITEM_TYPE_CODE is CLASS. 3. RA_INTERFACE_SALESCREDITS Order Management inserts one row for each sales credit row according to the following hierarchy: 1.Integrating Oracle Order Management with Oracle Receivables for Invoicing c. 2-148 Oracle Order Management Suite APIs and Open Interfaces Manual ..

waybill1. : Order Management inserts SUBSTR (WSH_DELIVERY_LINE_STATUS_ V. Order Management inserts your value for the OM: Source Code profile option. or return line has been interfaced for invoice or credit.30 For a Non-shipped order line or a Return Line: Order Management inserts 0 (zero). a Return line. For a Shipped order line and for Freight Charges: Order Management inserts substr(wsh_new_deliveries. 1. 30).. For a Sales order or return line: Order Management inserts OE_ORDER_ LINES. Order Management inserts OE_ TRANSACTION_TYPES.LINE_ID. ORDER_NUMBER. freight charge. INTERFACE_LINE_ ATTRIBUTE6 Varchar2(30) Oracle Order Management Open Interface 2-149 . Order Management inserts OE_ORDER_ LINE.30 For a Non-shipped order line or a Return Line: Order Management inserts 0 (zero). INTERFACE_LINE_ ATTRIBUTE7 Varchar2(30) For a Shipped order line.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–15 RA_INTERFACE_SALESCREDITS Column INTERFACE_ SALESCREDIT_ID INTERFACE_LINE_ ID INTERFACE_LINE_ CONTEXT INTERFACE_LINE_ ATTRIBUTE1 INTERFACE_LINE_ ATTRIBUTE2 INTERFACE_LINE_ ATTRIBUTE3 Null? Type NUMBER(15) NUMBER(15) Varchar2(30) Varchar2(30) Varchar2(30) Varchar2(30) Description Order Management does not insert a value into this column. Order Management does not insert a value into this column.CHARGE_ID. INTERFACE_LINE_ ATTRIBUTE4 Varchar2(30) For a Shipped order line and for Freight Charges: Order Management inserts: substr(wsh_new_deliveries. or Freight charges: Order Management inserts 0 (zero).name1.NAME..WAYBILL. For Freight charges: OE_CHARGE_LINES_ V. INTERFACE_LINE_ ATTRIBUTE5 Varchar2(30) Order Management inserts the number of times the order.

Order Management inserts OE_SALES_ CREDIT.. Order Management inserts OE_ORDER_ LINES.SALES_CREDIT_ TYPE_ID. Order Management does not insert a value into this column. BILL_OF_LADING. Order Management does not insert a value into this column. oe_price_adjustments. Order Management inserts OE_SALES_ CREDIT. Otherwise.price_adjustment_ id for discount lines: profile (OM: Show Discount Details on Invoice must be Yes. 2-150 Oracle Order Management Suite APIs and Open Interfaces Manual . or Freight charges: Order Management inserts 0 (zero) INTERFACE_LINE_ ATTRIBUTE9 INTERFACE_LINE_ ATTRIBUTE10 INTERFACE_LINE_ ATTRIBUTE11 Varchar2(30) Order Management inserts the customer item number if one is defined. it inserts 0 (zero). Order Management does not insert a value into this column.CONTEXT. Varchar2(30) Varchar2(30) SALESREP_ID SALES_CREDIT_ TYPE_NAME SALES_CREDIT_ TYPE_ID SALES_CREDIT_ AMOUNT_SPLIT SALES_CREDIT_ PERCENT_SPLIT INTERFACE_STATUS REQUEST_ID ATTRIBUTE_ CATEGORY )NUMBER(15) Order Management inserts OE_SALES_ CREDIT. INTERFACE_LINE_ ATTRIBUTE12. Order Management does not insert a value into this column. NUMBER(15) NUMBER NUMBER Varchar(1) NUMBER(15) Varchar(30) Order Management inserts OE_SALES_ CREDIT.15 SALESREP_NUMBER Varchar2(30) Varchar2(30 Order Management does not insert a value into this column.PERCENT. For all other lines '0' is passed. SHIP_FROM_ORG_ID.Integrating Oracle Order Management with Oracle Receivables for Invoicing Table 2–15 RA_INTERFACE_SALESCREDITS Column INTERFACE_LINE_ ATTRIBUTE8 Null? Type Varchar2(30) Description For a Shipped order line: Order Management inserts WSH_ DEPARTURES..).. For a Return line. Order Management does not insert a value into this column.SALESREP_ID.

updates and deletes) may be performed on the Sales Order business object entities and their attributes. Oracle Order Management Process Order API The Sales Order has been modeled as a business object that Oracle Order Management owns.. The Sales Order business object comprises of several entities. in a consistent manner. attachments. Process Order API Features Operations on the Sales Order Object The Process Order API can be used to create.15. Header Pricing Attributes. Line Sales Credits. Header Sales Credits. Line Pricing Attributes. It must be understood that by using the Process Order API we not only avoid duplication of business logic in many functions but also move towards the distributed solution approach. The importance of using the Process Order API for all data manipulation to the Sales Order Business object cannot be over stressed. The Process Order Application Program Interface (API) is designed as the mechanism through which all data manipulation (inserts. can also be processed using the Sales Order API. Business logic in the API not only takes care of updates to the attributes but also makes calls to other functions depending on the changes to attribute values.Oracle Order Management Process Order API Table 2–15 RA_INTERFACE_SALESCREDITS Column ATTRIBUTE1.. certain other action requests such as applying holds. update or delete the following entities that the sales order business object consists of. Header Adjustment Associations.. Line Adjustment Attributes. booking etc. Lines. Header Adjustment Attributes. Table 2–16 Process Orders Entities and associated tables Entity Table Name Order Header Order Price Adjustments Order Sales Credits OE_ORDER_HEADERS_ALL OE_PRICE_ADJUSTMENTS OE_SALES_CREDITS Oracle Order Management Open Interface 2-151 . Line Adjustment Associations and Line Lot Serial Numbers. Besides these. namely. Line Price Adjustments.15 Null? Type Varchar(150) Description Order Management inserts OE_SALES_ CREDIT.ATTRIBUTE1. Header... Header Price Adjustments.

For e. When set to ‘Y ‘the process order API fetches the list price and applies adjustments and charges. Pricing an Order/Line Pricing in process order API can be controlled using flag calculate_price_flag on order line record. The identifier field takes preference and further processing is based on this field. For the value fields that could not be resolved.sold_to_org_id or send in the display name of the customer on the header value record. p_header_rec. then information messages are posted to the OM message stack for such attributes.sold_ to_org.Oracle Order Management Process Order API Table 2–16 Process Orders Entities and associated tables Entity Table Name Order Line Order Pricing Attributes Order Adjustment Attributes Order Adjustment Associations OE_ORDER_LINES_ALL OE_ORDER_PRICE_ATTRIBS OE_PRICE_ADJ_ATTRIBS OE_PRICE_ADJ_ATTRIBS Line Sales Credits Line Price Adjustments Line Pricing Attributes Line Adjustment Attributes Line Adjustment Associations Lot Serial Numbers OE_SALES_CREDITS OE_PRICE_ADJUSTMENTS OE_ORDER_PRICE_ATTRIBS OE_PRICE_ADJ_ATTRIBS OE_PRICE_ADJ_ASSOCS OE_LOT_SERIAL_NUMBERS Passing Parameters By Values Process Order API provides users the capability of passing the attributes on the order entities by their display values instead of their internal identifiers (IDs or codes). If both the value and the identifier fields are populated for the same attribute.g. the user can either pass in the customer ID on the header record. to specify the customer on the order. When set to N. error messages are posted to the OM message stack and none of the records are processed any further. The values are internally resolved into the identifiers for all the entity records passed to process order. p_header_val_rec. the process order API would fetch 2-152 Oracle Order Management Suite APIs and Open Interfaces Manual .

You do not need to send in the schedule action if reserved_quantity is passed. Scheduling/Reservations Process order API can be used to perform scheduling actions on order lines. reserve and unreserve. Column Return_Context can have the following values to determine the reference type: s Sales Order Customer PO Invoice Serial Number s s s Oracle Order Management Open Interface 2-153 . This holds true only if the lines are not part of any set. you can also provide a line type of the type Return on the order line record. To create a return line. The schedule_action_code field provided on the order line record (line_rec_type) can be used to provide the action which needs to be performed on the order line. Scheduling actions include: schedule. return_attribute1-2).Oracle Order Management Process Order API a list price if the list price is not passed and no adjustments would be applied. Additionally. you can pass in the return flexfields (return_context. That mainly includes freight charges. you can just set the profile option OM: AutoSchedule to Yes and all standard lines will be automatically scheduled as they are created. Process Order API will also automatically schedule or re-schedule the lines if the schedule_ship_date or schedule_arrival_date field is passed or updated respectively. all the modifiers which are associated with phases having override freeze flag set to Y are applied. you can either pass in the line category of RETURN on the order line record and the line type would default to the inbound line type of the order type. Alternatively. unschedule. Alternatively. Reservations can also be performed by passing the reserved_quantity on the order line record. When set to P. if you want to specify a reference for the return line. Return Lines Process order can be used to create and update return lines also.

The caller can also send in an explicit action request to apply attachments. Attachments If the profile option OM: Apply Automatic Attachments is set to Yes and if attachment rules are applicable. Return_Attribute2 can have the following values depending on the reference type: 1... if there is a hold source defined for the customer ABC. Please refer to the section Action Requests for more details. Sales Order s return_Attribute1: Header ID return_Attribute2: Line ID s 2. Customer PO s return_Attribute1: Header ID return_Attribute2: Line ID s 3.g. Note: Attachments are NOT automatically deleted or re-applied if the order or line is updated. attachments are automatically applied to the order header or order lines when they are created via the process order API. Serial Number s return_Attribute1: Inventory Item ID return_Attribute2: Serial Number s Holds/Releases The existing hold sources are evaluated and if they are applicable. holds are applied and released automatically on the orders or order lines when created/updated via the process order API. For e.Oracle Order Management Process Order API Return_Attribute1. Invoice s return_Attribute1: Invoice Header ID return_Attribute2: Invoice Line ID s 4. all orders for that customer are placed on hold as they are entered. 2-154 Oracle Order Management Suite APIs and Open Interfaces Manual .

one to reduce the quantity on the existing line record with the action of SPLIT and another to create the new line with the remaining quantity and a reference to the line that it was split from.split_action_code := ‘SPLIT’ line_tbl(1). User can add a line into a new set by passing set name (ship_set/arrival_ set/fullfillment_set) on the line record or user can use set id (ship_set_id/arrival_ set_id/fulfillment_set_id) to add to an existing set. if user wants to split a line with original quantity 10 into 6 and 4 he must populate the table in the following manner. Tax Calculation Process order will check whether the transaction type on the order line is taxable or whether user has specified that tax should be calculated (set the tax exempt flag to Required).split_action_code := ‘SPLIT’ line_tbl(2).ordered_quantity := 6 line_tbl(1).ordered_quantity := 4 line_tbl(2). Cancellation Process order can be used to cancel orders and order lines. The calculated tax is always an estimated value and is internally stored as a price adjustment. User has to supply change reason and optionally change comments on the line record. line_tbl(1). For e.split_by := ‘USER’ line_tbl(2).operation = oe_globals.g. In the first update call to process order user cannot update any other attributes other than ordered quantity. Oracle Order Management Open Interface 2-155 .g_opr_create line_tbl(2). Splits Process order can be used to split an existing order line into shipments. arrival sets or fulfillment sets.line_id User can also optionally pass in the change reason and change comments on the original line record that is being updated.Oracle Order Management Process Order API Sets Process order can be used to add or delete order lines from ship sets.split_by := ‘USER’ line_tbl(1).operation = oe_globals. User can perform splits by calling process order with both the line records.g_opr_update line_tbl(2). Cancellation on the line is performed by reducing the ordered quantity on the line record.split_from_line_id := line_tbl(1). User should update the cancelled flag to Y on the header record if user intends to cancel the entire order.

M2 has O2 and O3 as two options defined for it. cascade quantity changes from model lines to all options lines if a set identifying attribute is changed on one line of the set. These are followed by processing of requests in their arrival order.g. When the order or line is priced. Process Order will go by the following order when processing the line entity. Users can also specify the freight and special charges to be applied by setting up the price adjustment records appropriately. the change will be automatically applied to all lines on the set. Cascading Process Order will automatically cascade changes to other dependent entities. it would look like this. Such price adjustments should have the list_line_type_code parameter set to CHARGE. For e. Processing Sequence is very important when considering automatic cascading. 2-156 Oracle Order Management Suite APIs and Open Interfaces Manual . all standard lines and model lines are processed. These do not affect the unit selling price and are also stored as price adjustments. Graphically represented. First. these charges get applied on the order or line. The importance of declaring the processing sequence may be depicted by the following example.Oracle Order Management Process Order API Freight and Special Charges Freight and special charges can be setup in pricing as modifiers. Consider that a model M1 has O1 and M2 as two of its options.

thereby updating Option3 to 8 and Option4 to 40. options after that etc. If requests are processed in the order that they were received. If processing sequence of requests is based on item type (models first. Request 2: Update the quantity of Model2 to 4.). That would then result in quantity cascading. So we end up with: Model2 = 4. Option4 = 40. classes next. Next Model2 would be updated to 4 (assuming again that ratio of Model1 to Model2 is valid). the following would be the sequence in which the requests would be processed: Oracle Order Management Open Interface 2-157 .Oracle Order Management Process Order API Model M1(1) Option 1(1) Model 2(2) Option 3 (4) Option4 (8) Figure 2–1 Simplified graphical representation of an ATO configuration Let us assume that the following requests are received by Process Order API: Request 1: Update the quantity of Option4 to 20. the following would occur: Option 4 would be updated to 20 assuming that the new ratio between Model2 and Option4 (1:10) falls within a valid range. Option3 = 8.

If the ID of the order or line for which this request needs to get executed is not known as it is being created in the same call. So we would end up with: Model2 = 4. applying/releasing holds. the requests would be processed in the order that they are received. with quantity of Model2 to be updated to 4. 2-158 Oracle Order Management Suite APIs and Open Interfaces Manual . As stated earlier.. process order API will process Standard Lines and top level Model lines first. Book the order This request is used to book the order. Next quantity of Option4 would be updated to 20 (assuming ratios fall in the right range). Option3 = 8 and Option4 = 20. The above example highlights the differences with processing lines (termed in the example as requests) in the sequential arrival order versus processing based on item types. For e. a request record should be passed in the action request table (p_action_request_tbl) to process order and the parameters of the request record can provide additional information needed to carry out that action. the ENTITY_INDEX field on the request record indicates the index for the entity record in the entity table passed to Following are the action requests currently supported and the parameters on the request record that are used in processing the request. For lines in the same category. Action Requests Process order API can also process some other actions on the order object. The validation_level parameter determines whether validation of the parameters of the request record needs to be performed. For each action request.Oracle Order Management Process Order API Request 2 would be processed first. then option classes and option lines and service lines in the end. booking the order.g.

Table 2–18 Parameter request_type entity_code Description OE_GLOBALS.G_APPLY_HOLD OE_GLOBALS. Header ID of the order to be booked. p_line_tbl. Table 2–19 Parameter request_type entity_code entity_id Description OE_GLOBALS.G_ENTITY_LINE if rules are to be evaluated for the order line.G_ ENTITY_HEADER as booking is an order level action. entity_id Header ID if the entity is G_ENTITY_HEADER . ID of the order or line to be held Oracle Order Management Open Interface 2-159 . then the user does not need to provide this value.G_ENTITY_ORDER for order or OE_ GLOBALS. Line ID if the entity is G_ENTITY_LINE entity_index If entity is G_ENTITY_LINE and the line is being created in the same call to process order. Apply Automatic Attachments \ The attachment rules will be evaluated for the entity and if applicable.G_ENTITY_LINE for line. If the order is also being created in the same call to process order.G_ENTITY_HEADER if the rules are to be evaluated for the order header OE_GLOBALS.G_BOOK_ORDER This should be always set to OE_GLOBALS.Oracle Order Management Process Order API Table 2–17 Parameter request_type entity_code entity_id Description OE_GLOBALS. then send in the index position for this line in the table.G_APPLY_AUTOMATIC_ATCHMT OE_GLOBALS. Apply Hold Holds will be applied based on the parameters sent in on the request record. documents will be attached to the entity.

G_RELEASE_HOLD OE_GLOBALS. 2-160 Oracle Order Management Suite APIs and Open Interfaces Manual . entity_id param1 ID of the order or line to be released from hold Hold ID to specify the type of hold that is to be removed.G_ENTITY_LINE for line. param2 Release Hold Releases the holds associated with an order or line. Table 2–20 Parameter request_type entity_code Description OE_GLOBALS. C: Customer hold source S: Bill To or Ship To hold source I: Item hold source O: Order hold source W: Warehouse Hold Source param3 Hold entity ID C or S: for Org ID O: Header ID I: Inventory Item ID param4 date_param1 parm6-param20 Hold comment Hold Until Date Attribute1-15 of the descriptive flexfield associated with the hold source record.Oracle Order Management Process Order API Table 2–19 param1 Hold ID to identify the type of hold that should be applied. (HOLD_ID from OE_HOLD_DEFINITIONS ) Hold entity code for the hold source to be created.G_ENTITY_ORDER for order or OE_GLOBALS.

G_MATCH_AND_RESERVE OE_GLOBALS.G_ENTITY_LINE Line ID of the top model line of the ATO configuration Oracle Order Management Open Interface 2-161 .G_DELINK_CONFIG OE_GLOBALS.Oracle Order Management Process Order API Table 2–20 param2 Hold entity code on the hold source associated with the hold to be released C: Customer hold source S: Bill To or Ship To hold source I: Item hold source O: Order hold source W: Warehouse Hold Source param3 Hold entity ID: C or S: for Org ID O: Header ID I: Inventory Item ID param4 param5 Release Reason Code Release Comment Delink Config This request deletes the configuration item.G_ENTITY_LINE Line ID of the top model line of the ATO configuration Match and Reserve This request checks if an existing configuration item matches the configuration created by the user and if configuration item is available. Table 2–22 Parameter request_type entity_code entity_id Description OE_GLOBALS. it reserves it. Table 2–21 Parameter request_type entity_code entity_id Description OE_GLOBALS.

s Process_Order This is the main procedure used to create. it can accept one header record and a table of header adjustment. line adjustments. Processing the Sales Order business object Process order can only process entities belonging to one sales order in one i. 5. This procedure can also be used to perform other actions via the records or explicit action requests. Functional Overview Public Procedures Process Order API provides the following public procedures for operations and queries on the entities for the sales order object. Use the get_order procedure to retrieve the entity records and then call lock_order with the records to be locked. The entities are processed in the following sequence: 1. s Lock_Order Locks the entities of a sales order object. p_ line_tbl. in a single call. 2. then send in the index position for this line in the table. s s Get_Order This procedure queries and returns all records belonging to a single sales order object. lines. 4. line sales credit and line lot serial numbers records for processing. 3.Oracle Order Management Process Order API Table 2–22 entity_index If entity is G_ENTITY_LINE and the top model line is being created in the same call to process order.e. header sales credits. Please refer to the next section on the details of the processing. Process Header Record Process Header Adjustments Process Header Pricing Attributes Process Header Adjustment Attributes Process Header Adjustment Associations 2-162 Oracle Order Management Suite APIs and Open Interfaces Manual . update and delete the entities on the sales order.

then the contacts. then the fields will not be cleared and the user-specified value will be used instead. An error is raised at the end if at least one attribute failed validation and the record is not processed further. constraints are evaluated to check if the user is allowed to change the attribute.Oracle Order Management Process Order API 6. Process Line Pricing Attributes 11. Process Line Adjustment Attributes 12. 8. Process Line Adjustment Associations 13. Process Line Sales Credits 14.g. For e. Process Line Lot Serial Numbers 15. Clear Dependent Attributes If operation is UPDATE. ship to and bill to on the order should be re-defaulted NOTE: if the user is also trying to update the dependent fields in the same call to the process order API. Defaulting Oracle Order Management Open Interface 2-163 . if the customer on the order is being updated. An error is raised if there was at least one attribute that failed security check and the record is not processed further. Attribute Validation All the attributes that are passed in by the caller on the entity record are validated. Process Header Sales Credits Check Entity context to make sure all lines belong to one header Process Lines Process Line Adjustments 10. then the fields dependent on the updated fields are cleared (or set to MISSING values). 7. This is done so that the dependent fields are re-defaulted. then for all the attributes that have changed between the old and the new record. 9. Perform Cross Entity Logic for Sales Order business object The procedure process_order performs the following actions for each entity on the order object: Attribute Level Security Check If operation on the record is UPDATE or CREATE. Errors are posted to the OM message stack for all attributes that are invalid.

raise an error and quit. For e. NOTE: if user has specified the values of these dependent attributes in the same call to process order. clear the dependent attributes (set to MISSING values). If default value is valid. Check security if new default value is different from old value and if there is a valid constraint. inventory item is a required field on the order line entity. ship to location is required. verify that the ship to is valid for the customer. all the number fields on the entity records are initialized to the value FND_API. ii) Check for Conditionally Required Attributes. Validate that all the required attributes have been specified on the entity and even if one required attribute is missing.g. for a booked line. retain the values on the initialized record are defined as MISSING attributes. Validate that all attributes that are required based on the status of the entity have been specified and if at least one is not specified. Record Validation There are three main validation steps: i) Check for Required Attributes. If new default value is NOT valid. then an error is raised and abort processing of this record. then the user-specified values will take preference and will not be cleared. Validate all those attributes that are dependent on the value of another attribute. then set the attribute to NULL. then raise an error and quit. 2-164 Oracle Order Management Suite APIs and Open Interfaces Manual .g. ship set may have defaulted onto the line and there is a constraint against inserting a line into a ship set where all lines in the ship set have been invoiced. Re-default all the MISSING attributes (dependent attributes) till all attributes have a value. raise an error and quit.G_MISS_NUM and thus. For e. At the end of the validation.g. II) Cross-Attribute Validation. Validate the default value if not null.g. For e. if at least one attribute is not valid.Oracle Order Management Process Order API Defaulting occurs for each MISSING attribute. For e. Attributes that are not explicitly passed by the user and therefore. Entity Security Check Entity level security check (constraints that are not attribute-specific) is done once again before the entity record is posted to database as defaulting may have changed the values of some attributes for e. all number fields with this value are MISSING attributes.g.

For e. cross entity logic is performed for the business object as a whole In addition to the above a check is made to validate entity context for the line to ensure all lines belong to same header. Database Write Write the changes to the database Cross Record Logic After all the records have been processed for one entity. validate that the total percent adds up to 100. automatic application of holds etc. after all records are processed for the entity order sales credit.Oracle Order Management Process Order API Any constraints that may have been setup for DELETE operation on this entity are also evaluated here. R Exit with error status Record Validation error Entity Security Check Database Write Process Next Record Record Processed Successfully error All records processed error Oracle Order Management Open Interface 2-165 . other cross record logic like validations.g. Cross Entity Logic After all the entities have been processed. is done. Start Processing Record if operation if operation DELETE CREATE or UPDATE Attribute Security Check error Attribute Validation if operation if operation CREATE UPDATE Clear Dependent Attributes Set the error status on the record Defaulting errorollback all changes.

An error is returned if the version numbers are incompatible X Requests that the API initialize the message list on your behalf. The OUT parameters have to be assigned when calling the API and are therefore marked as Required fields. set up and activate the following parameters: s Version number Initialize message list Initialize the IN record parameters to be interfaced to missing values Setup the parameters on the records to be interfaced s s s Parameter Descriptions The following chart describes all parameters used by the public API OE_ORDER_ PUB.Oracle Order Management Process Order API Cross Record Logicerror All entities processed Process Action Requests Exit with Success Status Setting Up the Process_Order Procedure Before using the API.G_ FALSE IN Varchar2 X Requests that the API send back the values on your behalf. All of the inbound and outbound parameters are listed.PROCESS_ORDER. Additional information on these parameters follows. 2-166 Oracle Order Management Suite APIs and Open Interfaces Manual . p_init_ msg_list p_return_ values IN Varchar2 FND_ API. Table 2–23 Parameter p_api_ version_ number Usage IN Type Required Optional Description Default NUMBER X Used to compare the incoming API call's version number with the current version number.G_ FALSE FND_ API.

indicates whether the request was processed successfully or no Success: FND_API.G_RET_ STS_SUCCESS Error: FND_API. then this contains the actual message X p_header_ rec IN PL/SQL Record Use this parameter to send in operations on the order header entity G_MISS_ HEADER _REC Oracle Order Management Open Interface 2-167 .GET. If the x_msg_count is equal to 1. If the x_msg_count is greater than 1.G_RET_ STS_ERROR Unexpected Error: FND_ API.G_RET_STS_UNEXP_ ERROR x_msg_ count OUT NUMBER X Indicates number of error messages API has encountered. then the list of messages must be retrieved using the call OE_ MSG_ PUB. This api can be called with the following parameter values: p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_ msg_index_out where 1_message and 1_ msg_index_out should be local variables of types Varchar2(2000 and Number respectively x_msg_ data OUT Varchar2 X Displays error message text.Oracle Order Management Process Order API Table 2–23 x_return_ status OUT Varchar2 X Returns the status.

Use this parameter to send in display values for the fields on the old record for the order header entity. Use this parameter to send in operations on the order pricing Attributes entities Use this parameter to send in the old records for the order pricing Attributes entities G_MISS_ HEADER _REC G_MISS_ HEADER _VAL_ REC G_MISS_ HEADER _VAL_ REC G_MISS_ HEADER _ADJ_ TBL G_MISS_ HEADER _ADJ_TB G_MISS_ HEADER _ADJ_ VAL_TBL G_MISS_ HEADER _ADJ_ VAL_TBL G_MISS_ HEADER _PRICE_ ATT_TBL G_MISS_ HEADER _PRICE_ ATT_TBL IN X p_old_ header_ val_rec IN PL/SQL Record X p_header_ adj_tbl IN PL/SQL Table X p_old_ header_ adj_tbl p_header_ adj_val_tbl IN PL/SQL Table X IN PL/SQL Table X p_old_ header_ adj_val_tbl IN PL/SQL Table X p_header_ price_att_ tbl p_old_ header_ price_att_ tbl IN PL/SQL Table X IN PL/SQL Table X 2-168 Oracle Order Management Suite APIs and Open Interfaces Manual . Use this parameter to send in operations on the order price adjustment entities Use this parameter to send in the old records for the order price adjustment entities.Oracle Order Management Process Order API Table 2–23 p_old_ header_rec p_header_ val_rec IN PL/SQL Record PL/SQL Record X Use this parameter to send in the old record for the order header entity. Use this parameter to send in the display values for fields on the order price adjustment entities Use this parameter to send in display values for the fields on the old records for the order price adjustment entities. Use this parameter to send in the display values for fields on the order header entity.

Oracle Order Management Open Interface 2-169 . G_MISS_ HEADER _ADJ_ ATT_TBL G_MISS_ HEADER _ADJ_ ATT_TBL G_MISS_ HEADER _ADJ_ ASSOC_ TBL G_MISS_ HEADER _ADJ_ ASSOC_ TBL G_MISS_ HEADER _ SCREDIT _TBL G_MISS_ HEADER _ SCREDIT _TBL G_MISS_ HEADER _ SCREDIT _VAL_ TBL p_old_ header_ adj_att_tbl p_header_ adj_assoc_ tbl IN PL/SQL Table X IN PL/SQL Table X p_old_ header_ adj_assoc_ tbl IN PL/SQL Table X p_header_ scredit_tbl IN PL/SQL Table X p_old_ header_ scredit_tbl IN PL/SQL Table X Use this parameter to send in the old record for the order sales credits. Use this parameter to send in the old records for the order Adjustment Associations entities. Use this parameter to send in the old records for the order Adjustment Attributes entities. Use this parameter to send in operations on the order sales credits. Use this parameter to send in operations on the order Adjustment Associations entities.Oracle Order Management Process Order API Table 2–23 p_header_ adj_att_tbl IN PL/SQL Table X Use this parameter to send in operations on the order Adjustment Attributes entities. p_header_ scredit_ val_tbl IN PL/SQL Table X Use this parameter to send in the display values for fields on the order sales credits.

G_MISS_ HEADER _ SCREDIT _VAL_ TBL G_MISS_ LINE_ TBL G_MISS_ LINE_ TBL G_MISS_ LINE_ VAL_TBL G_MISS_ LINE_ VAL_TBL G_MISS_ LINE_ ADJ_TBL G_MISS_ LINE_ ADJ_TBL G_MISS_ LINE_ ADJ_ VAL_TBL G_MISS_ LINE_ ADJ_ VAL_TBL p_line_tbl IN PL/SQL Table PL/SQL Table PL/SQL Table X p_old_ line_tbl IN X p_line_val_ IN tbl X p_old_ line_val_ tbl IN PL/SQL Table X p_line_adj_ IN tbl PL/SQL Table X p_old_ line_adj_ tbl IN PL/SQL Table X p_line_adj_ IN val_tbl PL/SQL Table X p_old_ line_adj_ val_tbl IN PL/SQL Table X 2-170 Oracle Order Management Suite APIs and Open Interfaces Manual . Use this parameter to send in operations on the order lines. Use this parameter to send in display values for the fields on the old records for order lines. Use this parameter to send in the old records for the line price adjustment entities. Use this parameter to send in operations on the line price adjustment entities. Use this parameter to send in display values for the fields on the old records for the line price adjustment entities. Use this parameter to send in the display values for fields on the order lines. Use this parameter to send in the old records for the order lines.Oracle Order Management Process Order API Table 2–23 p_old_ header_ scredit_ val_tbl IN PL/SQL Table X Use this parameter to send in display values for the fields on the old record for order sales credits. Use this parameter to send in the display values for fields on the line price adjustment entities.

G_MISS_ LINE_ PRICE_ ATT_TBL G_MISS_ LINE_ PRICE_ ATT_TBL G_MISS_ LINE_ ADJ_ ATT_TBL G_MISS_ LINE_ ADJ_ ATT_TBL p_old_ line_adj_ tbl IN PL/SQL Table X p_line_adj_ IN val_tbl PL/SQL Table X p_old_ line_adj_ val_tbl p_line_ price_att_ tbl p_old_ line_price_ att_tbl IN PL/SQL Table X IN PL/SQL Table PL/SQL Table PL/SQL Table PL/SQL Table PL/SQL Table X IN X p_line_adj_ IN att_tbl p_old_ line_adj_ att_tbl IN X X p_line_adj_ IN assoc_tbl X Use this parameter to send in operations on the Line Adjustment Associations entities. Use this parameter to send in the old records for the Line Adjustment Attributes entities. Use this parameter to send in the old records for the Line Adjustment Associations entities. G_MISS_ LINE_ ADJ_ ASSOC_ TBL G_MISS_ LINE_ ADJ_ ASSOC_ TBL p_old_ line_adj_ assoc_tbl IN PL/SQL Table X Oracle Order Management Open Interface 2-171 . Use this parameter to send in operations on the Line Adjustment Attributes entities. Use this parameter to send in the old records for the Line pricing Attributes entities.Oracle Order Management Process Order API Table 2–23 p_line_adj_ IN tbl PL/SQL Table X Use this parameter to send in operations on the Line pricing Attributes entities.

Use this parameter to send in display values for the fields on the old record for lot serials. Use this parameter to send in the display values for fields on the lot serials. Use this parameter to send in the old record for the line sales credits. Use this to send in requests to process other actions on the order G_MISS_ LINE_ SCREDIT _TBL G_MISS_ LINE_ SCREDIT _TBL G_MISS_ LINE_ SCREDIT _VAL_ TBL G_MISS_ LINE_ SCREDIT _VAL_ TBL G_MISS_ LOT_ SERIAL_ TBL G_MISS_ LOT_ SERIAL_ TBL G_MISS_ LOT_ SERIAL_ VAL_TBL G_MISS_ LOT_ SERIAL_ VAL_TBL G_MISS_ REQUEST _TBL p_old_ line_ scredit_tbl p_line_ scredit_ val_tbl IN PL/SQL Table X IN PL/SQL Table X p_old_ line_ scredit_ val_tbl IN PL/SQL Table X p_lot_ serial_tbl IN PL/SQL Table X p_old_lot_ serial_tbl IN PL/SQL Table X p_lot_ serial_val_ tbl p_old_lot_ serial_val_ tbl p_action_ request_tbl IN PL/SQL Table X IN PL/SQL Table X IN PL/SQL Table X 2-172 Oracle Order Management Suite APIs and Open Interfaces Manual . Use this parameter to send in the display values for fields on the line sales credits Use this parameter to send in display values for the fields on the old record for line sales credits. Use this parameter to send in the old record for the lot serials. Use this parameter to send in operations on the lot serials.Oracle Order Management Process Order API Table 2–23 p_line_ scredit_tbl IN PL/SQL Table X Use this parameter to send in operations on the line sales credits.

G_TRUE Returns the records for the processed price adjustments Returns the values for the processed header price adjustments if p_ return_values was set to FND_API. Returns the values for the processed order header record for the sales order if p_return_ values was set to FND_ API. x_line_tbl OUT PL/SQL Table X Oracle Order Management Open Interface 2-173 .G_TRUE Returns the records for the processed header pricing attributes Returns the records for the processed header adjustment attributes Returns the records for the processed header adjustment associations Returns the records for the processed header adjustment associations x_header_ adj_tbl x_header_ adj_val_tbl OUT PL/SQL Table PL/SQL Table X OUT X x_header_ price_att_ tbl x_header_ adj_att_tbl x_header_ adj_assoc_ tbl x_header_ scredit_tbl x_header_ scredit_ val_tbl OUT PL/SQL Table PL/SQL Table PL/SQL Table PL/SQL Table PL/SQL Table X OUT X OUT X OUT X OUT X Returns the values for the processed header sales credits if p_return_ values was set to FND_ API.Oracle Order Management Process Order API Table 2–23 x_header_ rec x_header_ val_rec OUT OUT PL/SQL Table PL/SQL Table X X Returns the processed order header record.G_TRUE Returns the processed order lines.

Oracle Order Management Process Order API Table 2–23 x_line_val_ OUT tbl PL/SQL Table X Returns the values for the processed order lines if p_return_values was set to FND_API.G_ TRUE Returns the records for the processed line adjustment attributes Returns the records for the processed line adjustment associations Returns the records for the processed line adjustment associations Returns the processed sales credits.G_TRUE 2-174 Oracle Order Management Suite APIs and Open Interfaces Manual .G_TRUE Returns the processed line price adjustments for the sales order Returns the values for the processed line price adjustments for the sales order if p_return_values was set to FND_API. x_line_adj_ tbl x_line_adj_ val_tbl OUT PL/SQL Table PL/SQL Table X OUT X x_line_ price_att_ tbl x_line_adj_ att_tbl x_line_adj_ assoc_tbl x_line_ scredit_tbl x_line_ scredit_ val_tbl OUT PL/SQL Table PL/SQL Table PL/SQL Table PL/SQL Table PL/SQL Table X OUT X OUT X OUT OUT X X Returns the values for the processed sales credits for the sales order if p_return_values was set to FND_API.

Oracle Order Management Process Order API Table 2–23 x_lot_ serial_tbl x_lot_ serial_val_ tbl x_action_ request_tbl OUT OUT PL/SQL Table PL/SQL Table X X Returns the processed lot serials. set up and activate the following parameters: s Version number Initialize message list Pass the header ID of the order to be queried s s Parameter Descriptions The following chart describes all parameters used by the public API OE_ORDER_ PUB. All of the inbound and outbound parameters are listed.GET_ORDER Parameter p_api_ version_ number Usage IN Type Required Optional Description Default NUMBER X Used to compare the incoming API call's version number with the current version number.GET_ORDER. Table 2–24 OE_ORDER_PUB. FND_ API. An error is returned if the version numbers are incompatible.G_ FALSE Oracle Order Management Open Interface 2-175 . Returns the values for the processed lot serials if p_return_values was set to FND_API. X p_init_ msg_list IN Varchar2 Requests that the API initialize the message list on your behalf.G_TRUE Returns the status for each of the action requests that were passed to process order. OUT PL/SQL Table X Setting Up the Get_Order Procedure Before using the API. Additional information on these parameters follows.

2-176 Oracle Order Management Suite APIs and Open Interfaces Manual .G_RET_STS_ ERROR Unexpected Error: FND_ API.G_RET_ STS_SUCCESS Error: FND_API. Returns the status.Oracle Order Management Process Order API Table 2–24 OE_ORDER_PUB. then the list of messages must be retrieved using the call OE_MSG_ PUB.G_ FALSE x_return_ status OUT Varchar2 X x_msg_ count OUT NUMBER X Indicates number of error messages API has encountered.GET_ORDER p_return_ values p_commit IN Varchar2 X Requests that the API send FND_ back the values on your API. indicates whether the request was processed successfully or not. This api can be called with the following parameter values: p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_ index_out where 1_message and 1_msg_ index_out should be local variables of types Varchar2(2000) and Number respectively.G_ behalf. FALSE Requests that the API update information for you after it completes its function.GET. Valid values include: Success: FND_API. If the x_msg_count is greater than 1.G_RET_STS_UNEXP_ ERROR IN Varchar2 X FND_ API.

X X p_header_ id IN NUMBER X FND_ API. If the x_msg_count is equal to 1. Returns the values for the queried order header record for the sales order if p_return_values was set to FND_API.G_TRUE Returns the queried header price adjustments for the sales order. Returns the values for the queried header price adjustments for the sales order if p_return_values was set to FND_API.Oracle Order Management Process Order API Table 2–24 OE_ORDER_PUB. Parameter to identify the sales order that is to be queried.G_ TRUE OUT X x_header_ adj_tbl x_header_ adj_val_tbl OUT PL/SQL Table PL/SQL Table X OUT X x_header_ price_att_ tbl x_header_ adj_att_tbl x_header_ adj_assoc_ tbl OUT PL/SQL Table PL/SQL Table PL/SQL Table X OUT OUT X X Oracle Order Management Open Interface 2-177 .GET_ORDER x_msg_data OUT Varchar2 Displays error message text. then this contains the actual message.G_ MISS_ NUM p_header x_header_ rec x_header_ val_rec IN OUT Varchar2 PL/SQL Table PL/SQL Table Returns the queried order header record for the sales order.

Oracle Order Management Process Order API Table 2–24 OE_ORDER_PUB. 2-178 Oracle Order Management Suite APIs and Open Interfaces Manual .GET_ORDER x_header_ scredit_tbl OUT PL/SQL Table PL/SQL Table X Returns the queried header sales credits for the sales order. Returns the values for the queried order lines for the sales order if p_return_ values was set to FND_ API. Returns the values for the queried header sales credits for the sales order if p_return_values was set to FND_API.G_TRUE Returns the queried order lines for the sales order.G_TRUE Returns the queried line price adjustments for the sales order Returns the values for the queried line price adjustments for the sales order if p_return_values was set to FND_API.G_ TRUE x_header_ OUT scredit_val_ tbl X x_line_tbl OUT PL/SQL Table PL/SQL Table X X x_line_val_ OUT tbl x_line_adj_ tbl x_line_adj_ val_tbl OUT PL/SQL Table PL/SQL Table X OUT X x_line_ price_att_ tbl x_line_adj_ att_tbl OUT PL/SQL Table PL/SQL Table PL/SQL Table PL/SQL Table X OUT X X OUT x_line_ adj_assoc_ tbl x_line_ scredit_tbl OUT X Returns the queried line sales credits for the sales order.

s s s Parameter Descriptions The following chart describes all parameters used by the public API OE_ORDER_ PUB. All of the inbound and outbound parameters are listed.G_TRUE Returns the queried lot serials for the sales order. Set the operation parameter to OE_GLOBALS. set up and activate the following parameters: s Version number Initialize message list Query all the entities for the sales order using the Get_Order procedure. Oracle Order Management Open Interface 2-179 .G_TRUE x_lot_ serial_tbl x_lot_ serial_val_ tbl OUT OUT PL/SQL Table PL/SQL Table X X Setting Up the Lock_Order Procedure Before using the API. The OUT parameters have to be assigned when calling the API and are therefore marked as Required fields.Oracle Order Management Process Order API Table 2–24 OE_ORDER_PUB. Returns the values for the queried lot serials for the sales order if p_return_ values was set to FND_ API.G_OPR_LOCK only on the entity records to be locked in this call. Additional information on these parameters follows.GET_ORDER x_line_ OUT scredit_val_ tbl PL/SQL Table X Returns the values for the queried line sales credits for the sales order if p_ return_values was set to FND_API.LOCK_ORDER.

G_ RET_STS_UNEXP_ERROR IN Varchar2 X FND_ API.G_RET_STS_ ERROR Unexpected Error: FND_API. Valid values include: Success: FND_API.G_RET_ STS_SUCCESS Error: FND_API.Oracle Order Management Process Order API Table 2–25 OE_ORDER_PUB. indicates whether the request was processed successfully or not. Returns the status. An error is returned if the version numbers are incompatible. FALSE Requests that the API send back the values on your behalf. X p_init_ msg_list p_return_ values x_return_ status IN Varchar2 Requests that the API FND_ initialize the message list on API.G_ your behalf.G_ FALSE OUT Varchar2 X 2-180 Oracle Order Management Suite APIs and Open Interfaces Manual .LOCK_ORDER Parameter p_api_ version_ number Usage IN Type Required Optional Description Default NUMBER X Used to compare the incoming API call's version number with the current version number.

G_MISS_ HEADER_ REC G_MISS_ HEADER_ VAL_REC G_MISS_ HEADER_ ADJ_TBL G_MISS_ HEADER_ ADJ_ VAL_TBL IN X p_header_ adj_tbl p_header_ adj_val_tbl IN PL/SQL Table PL/SQL Table X IN X Oracle Order Management Open Interface 2-181 . x_msg_data OUT Varchar2 X Displays error message text. Use this parameter to send in the display values for fields on the order price adjustment entities.LOCK_ORDER x_msg_ count OUT NUMBER X Indicates number of error messages API has encountered.Oracle Order Management Process Order API Table 2–25 OE_ORDER_PUB. then this contains the actual message. then the list of messages must be retrieved using the call OE_MSG_ PUB. Use this parameter to send in the display values for fields on the order header entity. This api can be called with the following parameter values: p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_ index_out where 1_message and 1_msg_ index_out should be local variables of types Varchar2(2000) and Number respectively. If the x_msg_count is equal to 1. Use this parameter to send in operations on the order price adjustment entities. X p_header_ rec p_header_ val_rec IN PL/SQL Record PL/SQL Record Use this parameter to send in operations on the order header entity.GET. If the x_msg_count is greater than 1.

LOCK_ORDER p_header_ price_att_ tbl p_header_ adj_att_tbl IN PL/SQL Table X Use this parameter to send in operations on the order pricing Attributes entities.Oracle Order Management Process Order API Table 2–25 OE_ORDER_PUB. Use this parameter to send in the display values for fields on the order lines. Use this parameter to send in the display values for fields on the line price adjustment entities. Use this parameter to send in operations on the order Adjustment Attributes entities. Use this parameter to send in operations on the order Adjustment Associations entities. Use this parameter to send in operations on the order lines. Use this parameter to send in the display values for fields on the order sales credits. Use this parameter to send in operations on the order sales credits. Use this parameter to send in operations on the line price adjustment entities. G_MISS_ HEADER_ PRICE_ ATT_TBL G_MISS_ HEADER_ ADJ_ATT_ TBL G_MISS_ HEADER_ ADJ_ ASSOC_ TBL G_MISS_ HEADER_ SCREDIT_ TBL G_MISS_ HEADER_ SCREDIT_ VAL_TBL G_MISS_ LINE_TBL G_MISS_ LINE_ VAL_TBL G_MISS_ LINE_ ADJ_TBL G_MISS_ LINE_ ADJ_ VAL_TBL IN PL/SQL Table X p_header_ adj_assoc_ tbl IN PL/SQL Table X p_header_ scredit_tbl IN PL/SQL Table X p_header_ IN scredit_val_ tbl p_line_tbl IN PL/SQL Table X PL/SQL Table PL/SQL Table PL/SQL Table PL/SQL Table X p_line_val_ IN tbl p_line_adj_ IN tbl p_line_adj_ IN val_tbl X X X 2-182 Oracle Order Management Suite APIs and Open Interfaces Manual .

Use this parameter to send in operations on the Line Adjustment Attributes entities.G_TRUE G_MISS_ LINE_ PRICE_ ATT_TBL G_MISS_ LINE_ ADJ_ATT_ TBL G_MISS_ LINE_ ADJ_ ASSOC_ TBL G_MISS_ LINE_ SCREDIT_ TBL G_MISS_ LINE_ SCREDIT_ VAL_TBL G_MISS_ LOT_ SERIAL_ TBL G_MISS_ LOT_ SERIAL_ VAL_TBL p_line_adj_ IN val_tbl PL/SQL Table X p_line_adj_ IN assoc_tbl PL/SQL Table X p_line_ scredit_tbl IN PL/SQL Table X p_line_ IN scredit_val_ tbl p_lot_ serial_tbl IN PL/SQL Table X PL/SQL Table X p_lot_lot_ serial_val_ tbl x_header_ rec x_header_ val_rec IN PL/SQL Table X OUT OUT PL/SQL Table PL/SQL Table X X Oracle Order Management Open Interface 2-183 . Use this parameter to send in operations on the line sales credits. Use this parameter to send in operations on the lot serials. Use this parameter to send in the display values for fields on the line sales credits. Returns the processed order header record. Returns the values for the processed order header record for the sales order if p_return_values was set to FND_API. Use this parameter to send in operations on the Line Adjustment Associations entities.Oracle Order Management Process Order API Table 2–25 OE_ORDER_PUB.LOCK_ORDER p_line_adj_ IN tbl PL/SQL Table X Use this parameter to send in operations on the Line pricing Attributes entities. Use this parameter to send in the display values for fields on the lot serials.

G_TRUE Returns the records for the processed header pricing attributes Returns the records for the processed header adjustment attributes Returns the records for the processed header adjustment associations Returns the records for the processed header adjustment associations Returns the values for the processed header sales credits if p_return_values was set to FND_API.G_TRUE Returns the processed line price adjustments for the sales order x_header_ price_att_ tbl x_header_ adj_att_tbl x_header_ adj_assoc_ tbl x_header_ scredit_tbl OUT PL/SQL Table PL/SQL Table PL/SQL Table PL/SQL Table PL/SQL Table X OUT X OUT X OUT X x_header_ OUT scredit_val_ tbl X x_line_tbl OUT PL/SQL Table PL/SQL Table X X x_line_val_ OUT tbl x_line_adj_ tbl OUT PL/SQL Table X 2-184 Oracle Order Management Suite APIs and Open Interfaces Manual .Oracle Order Management Process Order API Table 2–25 OE_ORDER_PUB.G_ TRUE Returns the processed order lines.LOCK_ORDER x_header_ adj_tbl x_header_ adj_val_tbl OUT OUT PL/SQL Table PL/SQL Table X X Returns the records for the processed price adjustments Returns the values for the processed header price adjustments if p_return_ values was set to FND_ API. Returns the values for the processed order lines if p_ return_values was set to FND_API.

Returns the values for the processed lot serials if p_ return_values was set to FND_API. callers cannot provide values for certain columns via the public process order API. X OUT X X x_line_ OUT scredit_val_ tbl Returns the values for the processed sales credits for the sales order if p_return_ values was set to FND_ API. the following information has been documented: Oracle Order Management Open Interface 2-185 .LOCK_ORDER x_line_adj_ val_tbl OUT PL/SQL Table X Returns the values for the processed line price adjustments for the sales order if p_return_values was set to FND_API. If user provides values for these fields. For each column (if the record type is not a value record type. However.Oracle Order Management Process Order API Table 2–25 OE_ORDER_PUB.G_TRUE x_lot_ serial_tbl x_lot_ serial_val_ tbl OUT OUT PL/SQL Table PL/SQL Table X X PL/SQL Record Structures All the columns on the underlying order management tables are available on the record types that can be passed to the process order API.G_TRUE Returns the processed lot serials.G_ TRUE Returns the records for the processed line adjustment attributes x_line_ price_att_ tbl x_line_adj_ att_tbl x_line_adj_ assoc_tbl x_line_ scredit_tbl OUT PL/SQL Table PL/SQL Table PL/SQL Table PL/SQL Table PL/SQL Table X OUT OUT X X Returns the records for the processed line adjustment associations Returns the processed sales credits. val_rec_type). Such columns are marked as Derived columns as these are derived internally and updated by the API. it could result in data corruption.

If the identifier field is not passed when required. s s s s The value record structures have all fields that can be optionally passed instead of the identifier. C if conditionally required Required at Booking: X if required at booking. Header_Rec_Type For column descriptions. These record and table structures are defined in the specifications of the process order API. users cannot update these fields. please refer to the Order Management TRM for the table OE_ORDER_HEADERS_ALL. OE_ORDER_PUB.Oracle Order Management Process Order API s Datatype: data type for this field Required: X if required at entry. Derived: For internal use. C if required at booking based on some other conditions. Optional: X if users can either provide values for these fields or could be defaulted. 2-186 Oracle Order Management Suite APIs and Open Interfaces Manual . the value field can be passed instead and the value will be resolved into the identifier.

. attribute15 booked_flag cancelled_flag context conversion_rate VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) NUMBER C ..if order type requires Required Required at Booking Derived Optional X X X conversion_rate_date DATE X conversion_type_code VARCHAR2(30) X customer_preference_ set_code created_by creation_date cust_po_number deliver_to_contact_id deliver_to_org_id demand_class_code earliest_schedule_limit expiration_date fob_point_code VARCHAR2(30) NUMBER DATE VARCHAR2(50) NUMBER NUMBER VARCHAR2(30) NUMBER DATE VARCHAR2(30) X X C .if conversion type is User C .Oracle Order Management Process Order API Table 2–26 OE_ORDER_HEADERS_ALL.if order type requires X X X X X X X X Oracle Order Management Open Interface 2-187 .if order currency not same as SOB currency X X X X Datatype NUMBER NUMBER VARCHAR2(240) C .if conversion type is User C .. Parameter accounting_rule_id agreement_id attribute1.

....Oracle Order Management Process Order API Table 2–26 OE_ORDER_HEADERS_ALL.for UPDATE & DELETE operations X VARCHAR2(30) VARCHAR2(240) X X X VARCHAR2(30) VARCHAR2(30) VARCHAR2(240) X X X invoice_to_contact_id invoice_to_org_id invoicing_rule_id last_updated_by last_update_date last_update_login latest_schedule_limit open_flag order_category_code ordered_date order_date_type_code order_number NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER VARCHAR2(1) VARCHAR2(30) DATE VARCHAR2(30) NUMBER C .. tp_attribute15 header_id NUMBER C .for manual order types X X X X X X X X X X X X X order_source_id order_type_id org_id orig_sys_document_ref NUMBER NUMBER NUMBER VARCHAR2(50) X X X X 2-188 Oracle Order Management Suite APIs and Open Interfaces Manual . global_attibute20 global_attribute_category VARCHAR2(30) tp_context tp_attribute1. freight_carrier_code freight_terms_code global_attribute1.

for return lines X X X C . not return lines X X X X X X sold_from_org_id sold_to_contact_id sold_to_org_id source_document_id source_document_type_ id NUMBER NUMBER NUMBER NUMBER NUMBER Oracle Order Management Open Interface 2-189 . partial_shipments_ allowed payment_term_id VARCHAR2(1) NUMBER C .Oracle Order Management Process Order API Table 2–26 OE_ORDER_HEADERS_ALL.for order lines. not return lines X X X X price_list_id pricing_date program_application_id program_id program_update_date request_date request_id return_reason_code salesrep_id sales_channel_code shipment_priority_code shipping_method_code ship_from_org_id ship_tolerance_above ship_tolerance_below ship_to_contact_id ship_to_org_id NUMBER DATE NUMBER NUMBER DATE DATE NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) NUMBER NUMBER NUMBER NUMBER NUMBER X X X X X X X X X X X X X C .for order lines.

Oracle Order Management Process Order API Table 2–26 OE_ORDER_HEADERS_ALL.if tax exempt flag is Exempt X X X X tax_exempt_reason_code VARCHAR2(30) tax_point_code transactional_curr_code version_number return_status db_flag operation first_ack_code first_ack_date last_ack_code last_ack_date change_reason VARCHAR2(30) VARCHAR2(3) NUMBER VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) VARCHAR2(30) DATE VARCHAR2(30) DATE VARCHAR2(30) C -if constraints setup requires reason X X X X X X X X X for future use X change_comments change_sequence change_request_code ready_flag status_flag force_apply_flag drop_ship_flag customer_payment_ term_id payment_type_code VARCHAR2(2000) VARCHAR2(50) VARCHAR2(30) VARCHAR2(1) VARCHAR2(1) VARCHAR2(1) VARCHAR2(1) NUMBER VARCHAR2(30) X X X X X X X X X 2-190 Oracle Order Management Suite APIs and Open Interfaces Manual . tax_exempt_flag tax_exempt_number VARCHAR2(30) VARCHAR2(50) C .

Header_Val_Rec_Type Table 2–27 Header_Val_Rec_Type Parameter accounting_rule Oracle Order Management Open Interface 2-191 .if payment type Credit Card X X X X X X X X check_number credit_card_code VARCHAR2(50) VARCHAR2(80) credit_card_holder_name VARCHAR2(80) credit_card_number VARCHAR2(80) credit_card_expiration_ date credit_card_approval_ code credit_card_approval_ date shipping_instructions packing_instructions flow_status_code booked_date marketing_source_code_ id DATE VARCHAR2(80) DATE VARCHAR2(2000) VARCHAR2(2000) VARCHAR2(30) DATE NUMBER TYPE Header_Tbl_Type IS TABLE OF Header_Rec_Type INDEX BY BINARY_INTEGER.Oracle Order Management Process Order API Table 2–26 OE_ORDER_HEADERS_ALL.if payment type other than Credit Card C . payment_amount NUMBER C .if payment type Credit Card C .if payment type is Check X C .if payment type is Credit Card C .

Oracle Order Management Process Order API Table 2–27 Header_Val_Rec_Type agreement conversion_type deliver_to_address1 deliver_to_address2 deliver_to_address3 deliver_to_address4 deliver_to_contact deliver_to_location deliver_to_org demand_class fob_point freight_terms invoice_to_address1 invoice_to_address2 invoice_to_address3 invoice_to_address4 invoice_to_contact invoice_to_location invoice_to_org invoicing_rule order_source order_type payment_term price_list return_reason salesrep shipment_priority ship_from_address1 2-192 Oracle Order Management Suite APIs and Open Interfaces Manual .

Oracle Order Management Process Order API Table 2–27 Header_Val_Rec_Type ship_from_address2 ship_from_address3 ship_from_address4 ship_from_location ship_from_org ship_to_address1 ship_to_address2 ship_to_address3 ship_to_address4 ship_to_contact ship_to_location ship_to_org sold_to_contact sold_to_org sold_from_org tax_exempt tax_exempt_reason tax_point customer_payment_term payment_type credit_card status freight_carrier shipping_method order_date_type customer_number sales_channel Oracle Order Management Open Interface 2-193 .

Header_Adj_Rec_Type For column descriptions.Oracle Order Management Process Order API TYPE Header_Val_Tbl_Type IS TABLE OF Header_Val_Rec_Type INDEX BY BINARY_INTEGER. please refer to the Order Management TRM for the table OE_PRICE_ADJUSTMENTS Table 2–28 OE_PRICE_ADJUSTMENTS Parameter attribute1 attribute15 automatic_flag context created_by creation_date discount_id discount_line_id header_id last_updated_by last_update_date last_update_login percent price_adjustment_id Datatype VARCHAR2(240) VARCHAR2(1) VARCHAR2(30) NUMBER DATE NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER C -for update and delete X X X X X X X X X X X X X X X X X X qp_list_lines X Required Derived Optional program_application_ NUMBER id program_id NUMBER program_update_date DATE request_id return_status db_flag operation NUMBER VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) 2-194 Oracle Order Management Suite APIs and Open Interfaces Manual .

not required only for tax records C .not required only for tax records X X X X X X X X X X list_line_id NUMBER list_line_type_code VARCHAR2(30) modifier_mechanism_ VARCHAR2(30) type_code modified_from modified_to updated_flag update_allowed applied_flag change_reason_code change_reason_text operand operand_per_pqty arithmetic_operator cost_id tax_code tax_exempt_flag tax_exempt_number tax_exempt_reason_ code parent_adjustment_id NUMBER NUMBER VARCHAR2(1) VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) VARCHAR2(2000) NUMBER NUMBER VARCHAR2(30) NUMBER VARCHAR2(30) VARCHAR2(1) VARCHAR2(80) VARCHAR2(30) NUMBER X -for update and delete X X X X X X Oracle Order Management Open Interface 2-195 .Oracle Order Management Process Order API Table 2–28 OE_PRICE_ADJUSTMENTS line_index orig_sys_discount_ref change_request_code status_flag list_header_id NUMBER VARCHAR2(50) VARCHAR2(30) VARCHAR2(1) NUMBER C .

Oracle Order Management Process Order API Table 2–28 OE_PRICE_ADJUSTMENTS invoiced_flag estimated_flag inc_in_sales_ performance split_action_code adjusted_amount adjusted_amount_ per_pqty pricing_phase_id charge_type_code charge_subtype_code list_line_no source_system_code benefit_qty benefit_uom_code print_on_invoice_flag expiration_date rebate_transaction_ type_code rebate_transaction_ reference rebate_payment_ system_code redeemed_date redeemed_flag accrual_flag range_break_quantity accrual_conversion_ rate pricing_group_ sequence VARCHAR2(1) VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) NUMBER NUMBER NUMBER VARCHAR2(30) VARCHAR2(30) VARCHAR2(240) VARCHAR2(30) NUMBER VARCHAR2(3) VARCHAR2(1) DATE VARCHAR2(30) VARCHAR2(80) VARCHAR2(30) DATE VARCHAR2(1) VARCHAR2(1) NUMBER NUMBER NUMBER X X X X X X X X X X X X X X X X X X X X X X X X 2-196 Oracle Order Management Suite APIs and Open Interfaces Manual .

Header_Adj_Val_Rec_Type Table 2–29 Header_Adj_Val_Rec_Type Parameter discount list_name TYPE Header_Adj_Val_Tbl_Type IS TABLE OF Header_Adj_Val_Rec_Type INDEX BY BINARY_INTEGER. Header_Price_Att_Rec_Type For column descriptions..Oracle Order Management Process Order API Table 2–28 OE_PRICE_ADJUSTMENTS modifier_level_code price_break_type_ code substitution_attribute proration_type_code credit_or_charge_flag include_on_returns_ flag ac_attribute1. ac_attribute15 ac_context VARCHAR2(150) X VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(1) VARCHAR2(1) VARCHAR2(240) X X X X X X X TYPE Header_Adj_Tbl_Type IS TABLE OF Header_Adj_Rec_Type INDEX BY BINARY_INTEGER.. please refer to the Order Management TRM for the table OE_ORDER_PRICE_ATTRIBS Table 2–30 OE_ORDER_PRICE_ATTRIBS Parameter Datatype Required Derived Optional Oracle Order Management Open Interface 2-197 .

.. attribute15 Override_Flag return_status db_flag operation NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER DATE NUMBER VARCHAR2(60) X VARCHAR2(30) X VARCHAR2(24 0) VARCHAR2(30) VARCHAR2(24 0) VARCHAR2(1) VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) X X X X X X X -for update and delete X X X X X X X X X X X X TYPE Header_Price_Att_Tbl_Type is TABLE of Header_Price_Att_rec_Type INDEX by BINARY_INTEGER Header_Adj_Att_Rec_Type For column descriptions... please refer to the Order Management TRM for the table OE_PRICE_ADJ_ATTRIBS 2-198 Oracle Order Management Suite APIs and Open Interfaces Manual . pricing_attribute100 context attribute1.Oracle Order Management Process Order API Table 2–30 OE_ORDER_PRICE_ATTRIBS order_price_attrib_id header_id creation_date created_by last_update_date last_updated_by last_update_login program_application_id program_id program_update_date request_id flex_title pricing_context pricing_attribute1.

Oracle Order Management Process Order API Table 2–31 OE_PRICE_ADJ_ATTRIBS Parameter price_adj_attrib_id price_adjustment_id cdj_index Datatype NUMBER NUMBER NUMBER Required C -for update and delete C . Oracle Order Management Open Interface 2-199 .if adj_index not passed C .if price_ adjustment_id not passed X X X X X X X X X X X X X X X X X Derived Optional flex_title pricing_context pricing_attribute creation_date created_by last_update_date last_updated_by last_update_login program_application_id program_id program_update_date request_id pricing_attr_value_from pricing_attr_value_to comparison_operator return_status db_flag operation VARCHAR2(60) VARCHAR2(30) VARCHAR2(30) DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER DATE NUMBER VARCHAR2(240) VARCHAR2(240) VARCHAR2(30) VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) TYPE Header_Adj_Att_Rec_Type is TABLE of Header_Adj_Att_rec_Type INDEX by BINARY_INTEGER.

Oracle Order Management Process Order API Type Header_Adj_Assoc_Rec_Type is RECORD For column descriptions.if adj_index not passed C .if price_ adjustment_id not passed X X X X X X X X X X X X X X Required C .for update and delete Derived Optional rltd_Price_Adj_Id Rltd_Adj_Index creation_date created_by last_update_date last_updated_by last_update_login NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER program_application_id NUMBER program_id program_update_date request_id return_status db_flag operation NUMBER DATE NUMBER VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) TYPE Header_Adj_Assoc_Tbl_Type is TABLE of Header_Adj_Assoc_rec_Type INDEX by BINARY_INTEGER. 2-200 Oracle Order Management Suite APIs and Open Interfaces Manual . please refer to the Order Management TRM for the table OE_PRICE_ADJ_ATTRIBS Table 2–32 OE_PRICE_ADJ_ATTRIBS Parameter price_adj_assoc_id line_id Line_Index price_adjustment_id Adj_index Datatype NUMBER NUMBER NUMBER NUMBER NUMBER C .

.Oracle Order Management Process Order API TYPE Header_Scredit_Rec_Type IS RECORD For column descriptions. attribute15 context created_by creation_date dw_update_advice_ flag header_id last_updated_by last_update_date last_update_login percent salesrep_id sales_credit_type_id sales_credit_id wh_update_date return_status db_flag operation orig_sys_credit_ref change_request_code status_flag VARCHAR2(30) NUMBER DATE VARCHAR2(1) NUMBER NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) VARCHAR2(50) VARCHAR2(30) VARCHAR2(1) X X X X X X X X X X X X X X X X X X X Datatype VARCHAR2(240) Required Derived Optional X TYPE Header_Scredit_Tbl_Type IS TABLE OF Header_Scredit_Rec_Type INDEX BY BINARY_INTEGER.. Oracle Order Management Open Interface 2-201 . please refer to the Order Management TRM for the table OE_SALES_CREDITS Table 2–33 OE_SALES_CREDITS Parameter attribute1.

please refer to the Order Management TRM for the table OE_ORDER_LINES_ALL Table 2–34 OE_ORDER_LINES_ALL Parameter accounting_rule_id actual_arrival_date actual_shipment_date agreement_id arrival_set_id ato_line_id attribute1 . sales_credit_type).attribute15 authorized_to_ship_flag auto_selected_quantity booked_flag cancelled_flag cancelled_quantity cancelled_quantity2 commitment_id component_code component_number component_sequence_id config_header_id config_rev_nbr Datatype NUMBER DATE DATE NUMBER NUMBER NUMBER VARCHAR2(240) VARCHAR2(1) NUMBER VARCHAR2(1) VARCHAR2(1) NUMBER NUMBER NUMBER VARCHAR2(1000) NUMBER NUMBER NUMBER NUMBER X X X X X X X X X X X X X X X X X X Required Required at Booking Derived Optional X 2-202 Oracle Order Management Suite APIs and Open Interfaces Manual .Oracle Order Management Process Order API TYPE Header_Scredit_Val_Rec_Type IS RECORD (salesrep. Line_Rec_Type For column descriptions. TYPE Header_Scredit_Val_Tbl_Type IS TABLE OF Header_Scredit_Val_Rec_Type INDEX BY BINARY_INTEGER.

Oracle Order Management Process Order API Table 2–34 OE_ORDER_LINES_ALL config_display_sequence configuration_id context created_by creation_date credit_invoice_line_id customer_dock_code customer_job NUMBER NUMBER VARCHAR2(30) NUMBER DATE NUMBER VARCHAR2(50) VARCHAR2(50) X X X X X X X X X X X X X X X X X C .depends on the item X X X X X X X X X customer_production_line VARCHAR2(50) customer_trx_line_id cust_model_serial_ number cust_po_number NUMBER VARCHAR2(50) VARCHAR2(50) cust_production_seq_num VARCHAR2(50) delivery_lead_time deliver_to_contact_id deliver_to_org_id demand_bucket_type_ code demand_class_code dep_plan_required_flag earliest_acceptable_date end_item_unit_number explosion_date fob_point_code freight_carrier_code freight_terms_code fulfilled_quantity NUMBER NUMBER NUMBER VARCHAR2(30) VARCHAR2(30) VARCHAR2(1) DATE VARCHAR2(30) DATE VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) NUMBER Oracle Order Management Open Interface 2-203 .

industry_attribute30 industry_context tp_context tp_attribute1. global_attribute20 global_attribute_category header_id industry_attribute1...Oracle Order Management Process Order API Table 2–34 OE_ORDER_LINES_ALL fulfilled_quantity2 global_attribute1.. tp_attribute15 intermed_ship_to_org_id intermed_ship_to_ contact_id inventory_item_id invoice_interface_status_ code invoice_to_contact_id invoice_to_org_id invoicing_rule_id ordered_item item_revision item_type_code last_updated_by last_update_date last_update_login latest_acceptable_date line_category_code NUMBER NUMBER NUMBER VARCHAR2(30) NUMBER NUMBER NUMBER VARCHAR2(2000) VARCHAR2(3) VARCHAR2(30) NUMBER DATE NUMBER DATE VARCHAR2(30) X X X X X X X C: for Generic Items X X X X X X X X X X VARCHAR2(30) NUMBER VARCHAR2(240) VARCHAR2(30) VARCHAR2(30) VARCHAR2(240) X X X X X X NUMBER VARCHAR2(240) X X 2-204 Oracle Order Management Suite APIs and Open Interfaces Manual ....

for order lines.for UPDATE & DELETE operations X X X X X X X X X X X X X X X X X X X X X C.Oracle Order Management Process Order API Table 2–34 OE_ORDER_LINES_ALL line_id NUMBER C . not return lines X X X X X line_number line_type_id link_to_line_ref link_to_line_id link_to_line_index model_group_number mfg_component_ sequence_id open_flag option_flag option_number ordered_quantity ordered_quantity2 order_quantity_uom ordered_quantity_uom2 org_id orig_sys_document_ref orig_sys_line_ref over_ship_reason_code over_ship_resolved_flag payment_term_id NUMBER NUMBER VARCHAR2(50) NUMBER NUMBER NUMBER NUMBER VARCHAR2(1) VARCHAR2(1) NUMBER NUMBER NUMBER VARCHAR2(3) VARCHAR2(3) NUMBER VARCHAR2(50) VARCHAR2(50) VARCHAR2(30) VARCHAR2(1) NUMBER planning_priority preferred_grade price_list_id NUMBER VARCHAR2(4) NUMBER Oracle Order Management Open Interface 2-205 .

. pricing_attribute10 pricing_context pricing_date pricing_quantity pricing_quantity_uom program_application_id program_id program_update_date project_id promise_date re_source_flag reference_customer_trx_ line_id reference_header_id reference_line_id reference_type request_date request_id reserved_quantity return_attribute1.for return lines only X X X X X VARCHAR2(240) DATE NUMBER VARCHAR2(3) NUMBER NUMBER DATE NUMBER DATE VARCHAR2(1) NUMBER NUMBER NUMBER VARCHAR2(30) DATE NUMBER NUMBER VARCHAR2(240) X X X X X X X X X X X X X X X X X X VARCHAR2(240) X 2-206 Oracle Order Management Suite APIs and Open Interfaces Manual .. return_attribute15 return_context return_reason_code rla_schedule_type_code salesrep_id schedule_arrival_date schedule_ship_date VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) NUMBER DATE DATE C ..Oracle Order Management Process Order API Table 2–34 OE_ORDER_LINES_ALL pricing_attribute1..

for return lines X X X X X X X X X X X X X X X X X X X X sold_to_org_id sold_from_org_id sort_order source_document_id source_document_line_id NUMBER NUMBER VARCHAR2(240) NUMBER NUMBER source_document_type_id NUMBER Oracle Order Management Open Interface 2-207 . not return lines X X X X X X C .Oracle Order Management Process Order API Table 2–34 OE_ORDER_LINES_ALL schedule_action_code schedule_status_code shipment_number shipment_priority_code shipped_quantity shipped_quantity2 shipping_interfaced_flag shipping_method_code shipping_quantity shipping_quantity2 shipping_quantity_uom shipping_quantity_uom2 ship_from_org_id ship_model_complete_ flag ship_set_id fulfillment_set_id ship_tolerance_above ship_tolerance_below ship_to_contact_id ship_to_org_id VARCHAR2(30) VARCHAR2(30) NUMBER VARCHAR2(30) NUMBER NUMBER VARCHAR2(1) VARCHAR2(30) NUMBER NUMBER VARCHAR2(3) VARCHAR2(3) NUMBER VARCHAR2(30) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER C .for order lines.

depends on the project X X X X X X X X for future use X X 2-208 Oracle Order Management Suite APIs and Open Interfaces Manual .Oracle Order Management Process Order API Table 2–34 OE_ORDER_LINES_ALL source_type_code split_from_line_id task_id tax_code tax_date tax_exempt_flag tax_exempt_number tax_exempt_reason_code tax_point_code tax_rate tax_value top_model_line_ref top_model_line_id top_model_line_index unit_list_price unit_list_price_per_pqty unit_selling_price unit_selling_price_per_ pqty veh_cus_item_cum_key_ id visible_demand_flag return_status db_flag operation first_ack_code first_ack_date VARCHAR2(30) NUMBER NUMBER VARCHAR2(50) DATE VARCHAR2(30) VARCHAR2(50) VARCHAR2(30) VARCHAR2(30) NUMBER NUMBER VARCHAR2(50) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(1) VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) VARCHAR2(30) DATE X X X X X X X X X X X X X X X X X X C -if tax status is Exempt C .

Oracle Order Management Process Order API Table 2–34 OE_ORDER_LINES_ALL last_ack_code last_ack_date change_reason change_comments arrival_set ship_set fulfillment_set order_source_id orig_sys_shipment_ref change_sequence change_request_code status_flag drop_ship_flag customer_line_number customer_shipment_ number customer_item_net_price VARCHAR2(30) DATE VARCHAR2(30) VARCHAR2(2000) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) NUMBER VARCHAR2(50) VARCHAR2(50) VARCHAR2(30) VARCHAR2(1) VARCHAR2(1) VARCHAR2(50) VARCHAR2(50) NUMBER X X X X X X X C: for Customer Items C: for customer and generic items X X X X X X X X X X X customer_payment_term_ NUMBER id ordered_item_id item_identifier_type NUMBER VARCHAR2(25) shipping_instructions packing_instructions calculate_price_flag invoiced_quantity service_txn_reason_code service_txn_comments VARCHAR2(2000) VARCHAR2(2000) VARCHAR2(1) NUMBER VARCHAR2(30) VARCHAR2(2000) X X X X X X Oracle Order Management Open Interface 2-209 .

for service reference type of Order X C .Oracle Order Management Process Order API Table 2–34 OE_ORDER_LINES_ALL service_duration service_period service_start_date service_end_date service_coterminate_flag unit_list_percent unit_selling_percent unit_percent_base_price service_number service_reference_type_ code service_reference_line_id NUMBER VARCHAR2(3) DATE DATE VARCHAR2(1) NUMBER NUMBER NUMBER NUMBER VARCHAR2(30) NUMBER C .for service lines C .for service lines X X X X X C .for service lines C .for service lines X X X X X X X service_reference_system_ NUMBER id service_ref_order_number NUMBER service_ref_line_number NUMBER X service_ref_shipment_ number service_ref_option_ number service_line_index Line_set_id split_by Split_Action_Code NUMBER NUMBER NUMBER NUMBER VARCHAR2(240) VARCHAR2(30) X X X X X X 2-210 Oracle Order Management Suite APIs and Open Interfaces Manual .for service lines C .for service reference type of Order C .for service lines C .

Oracle Order Management Process Order API Table 2–34 OE_ORDER_LINES_ALL shippable_flag model_remnant_flag flow_status_code fulfilled_flag fulfillment_method_code revenue_amount marketing_source_code_ id VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) VARCHAR2(1) VARCHAR2(30) NUMBER NUMBER X X X X X X X fulfillment_date semi_processed_flag DATE BOOLEAN X X TYPE Line_Tbl_Type IS TABLE OF Line_Rec_Type Index BY BINARY_INTEGER. Line_Val_Rec_Type Table 2–35 Line_Val_Rec_Type Parameter accounting_rule agreement commitment deliver_to_address1 deliver_to_address2 deliver_to_address3 deliver_to_address4 deliver_to_contact deliver_to_location deliver_to_org demand_class Oracle Order Management Open Interface 2-211 .

Oracle Order Management Process Order API Table 2–35 Line_Val_Rec_Type demand_bucket_type fob_point freight_terms inventory_item invoice_to_address1 invoice_to_address2 invoice_to_address3 invoice_to_address4 invoice_to_contact invoice_to_location invoice_to_org invoicing_rule item_type line_type over_ship_reason payment_term price_list project return_reason rla_schedule_type salesrep shipment_priority ship_from_address1 ship_from_address2 ship_from_address3 ship_from_address4 ship_from_location ship_from_org 2-212 Oracle Order Management Suite APIs and Open Interfaces Manual .

Oracle Order Management Process Order API Table 2–35 Line_Val_Rec_Type ship_to_address1 ship_to_address2 ship_to_address3 ship_to_address4 ship_to_contact ship_to_location ship_to_org source_type intermed_ship_to_address1 intermed_ship_to_address2 intermed_ship_to_address3 intermed_ship_to_address4 intermed_ship_to_contact intermed_ship_to_location intermed_ship_to_org sold_to_org sold_from_org task tax_exempt tax_exempt_reason tax_point veh_cus_item_cum_key visible_demand customer_payment_term ref_order_number ref_line_number ref_shipment_number ref_option_number Oracle Order Management Open Interface 2-213 .

. attribute15 automatic_flag context created_by creation_date discount_id discount_line_id header_id last_updated_by last_update_date last_update_login line_id VARCHAR2(1) VARCHAR2(30) NUMBER DATE NUMBER NUMBER NUMBER NUMBER DATE NUMBER X X X X X X X X X X X Datatype VARCHAR2(240) Required Derived Optional 2-214 Oracle Order Management Suite APIs and Open Interfaces Manual ..Oracle Order Management Process Order API Table 2–35 Line_Val_Rec_Type ref_invoice_number ref_invoice_line_number credit_invoice_number tax_group status freight_carrier shipping_method TYPE Line_Val_Tbl_Type IS TABLE OF Line_Val_Rec_Type INDEX BY BINARY_INTEGER. please refer to the Order Management TRM for the table OE_PRICE_ADJUSTMENTS Table 2–36 OE_PRICE_ADJUSTMENTS Parameter attribute1.. TYPE Line_Adj_Rec_Type IS RECORD For column descriptions.

Oracle Order Management Process Order API Table 2–36 OE_PRICE_ADJUSTMENTS percent price_adjustment_id program_application_id program_id program_update_date request_id return_status db_flag operation line_index orig_sys_discount_ref change_request_code status_flag list_header_id list_line_id list_line_type_code modifier_mechanism_ type_code modified_from modified_to updated_flag update_allowed applied_flag change_reason_code change_reason_text operand operand_per_pqty NUMBER NUMBER NUMBER NUMBER DATE NUMBER VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) NUMBER VARCHAR2(50) VARCHAR2(30) VARCHAR2(1) NUMBER NUMBER VARCHAR2(30) VARCHAR2(30) NUMBER NUMBER VARCHAR2(1) VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) VARCHAR2(2000) NUMBER NUMBER X X X X X C .not required only for tax records X X X X X X X X X X X C -for update and delete X X X X X X Oracle Order Management Open Interface 2-215 .not required only for tax records C .

Oracle Order Management Process Order API Table 2–36 OE_PRICE_ADJUSTMENTS arithmetic_operator cost_id tax_code tax_exempt_flag tax_exempt_number VARCHAR2(30) NUMBER VARCHAR2(30) VARCHAR2(1) VARCHAR2(80) X X tax_exempt_reason_code VARCHAR2(30) parent_adjustment_id invoiced_flag estimated_flag inc_in_sales_ performance split_action_code adjusted_amount adjusted_amount_per_ pqty pricing_phase_id charge_type_code charge_subtype_code list_line_no source_system_code benefit_qty benefit_uom_code print_on_invoice_flag expiration_date NUMBER VARCHAR2(1) VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) NUMBER NUMBER NUMBER VARCHAR2(30) VARCHAR2(30) VARCHAR2(240) VARCHAR2(30) NUMBER VARCHAR2(3) VARCHAR2(1) DATE X X X X X X X X X X X X X X -for update and delete X X X X rebate_transaction_type_ VARCHAR2(30) code rebate_transaction_ reference VARCHAR2(80) rebate_payment_system_ VARCHAR2(30) code 2-216 Oracle Order Management Suite APIs and Open Interfaces Manual .

. please refer to the Order Management TRM for the table OE_ORDER_PRICE_ATTRIBS Oracle Order Management Open Interface 2-217 .Oracle Order Management Process Order API Table 2–36 OE_PRICE_ADJUSTMENTS redeemed_date redeemed_flag accrual_flag range_break_quantity accrual_conversion_rate pricing_group_sequence modifier_level_code price_break_type_code substitution_attribute proration_type_code credit_or_charge_flag include_on_returns_flag ac_attribute1. TYPE Line_Adj_Val_Rec_Type IS RECORD (discount List_name) TYPE Line_Adj_Val_Tbl_Type IS TABLE OF Line_Adj_Val_Rec_Type INDEX BY BINARY_INTEGER.. Line_Price_Att_Rec_Type For column descriptions. ac_attribute15 ac_context VARCHAR2(150) X DATE VARCHAR2(1) VARCHAR2(1) NUMBER NUMBER NUMBER VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(1) VARCHAR2(1) VARCHAR2(240) X X X X X X X X X X X X X TYPE Line_Adj_Tbl_Type IS TABLE OF Line_Adj_Rec_Type INDEX BY BINARY_INTEGER.

..Oracle Order Management Process Order API Table 2–37 OE_ORDER_PRICE_ATTRIBS Parameter order_price_attrib_id header_id line_id line_index creation_date created_by last_update_date last_updated_by last_update_login program_application_id program_id program_update_date request_id flex_title pricing_context pricing_attribute1... pricing_attribute100 context attribute1. attribute15 Override_Flag return_status db_flag operation VARCHAR2(1) VARCHAR2(1) VARCHAR2(1) X X X VARCHAR2(30) VARCHAR2(240) Datatype NUMBER NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER DATE NUMBER VARCHAR2(60) VARCHAR2(30) VARCHAR2(240) X X X X X X X X X Required Derived Optional X TYPE Line_Price_Att_Tbl_Type is TABLE of Line_Price_Att_rec_Type INDEX by BINARY_INTEGER 2-218 Oracle Order Management Suite APIs and Open Interfaces Manual .

Oracle Order Management Process Order API Line_Adj_Att_Rec_Type For column descriptions.if price_ adjustment_id not passed X X X X X X X X X X X X X X X X X X Derived Optional flex_title pricing_context pricing_attribute creation_date created_by last_update_date last_updated_by last_update_login program_application_id program_id program_update_date request_id pricing_attr_value_from pricing_attr_value_to comparison_operator return_status db_flag operation VARCHAR2(60) VARCHAR2(30) VARCHAR2(30) DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER DATE NUMBER VARCHAR2(240) VARCHAR2(240) VARCHAR2(30) VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) Oracle Order Management Open Interface 2-219 .if adj_index not passed C . please refer to the Order Management TRM for the table OE_PRICE_ADJ_ATTRIBS Table 2–38 OE_PRICE_ADJ_ATTRIBS Parameter price_adj_attrib_id price_adjustment_id Adj_index Datatype NUMBER NUMBER NUMBER Required C -for update and delete C .

please refer to the Order Management TRM for the table OE_PRICE_ADJ_ASSOCS Table 2–39 Parameter price_adj_assoc_id line_id Line_Index price_adjustment_id Adj_index Datatype NUMBER NUMBER NUMBER NUMBER NUMBER Required C .if adj_index not passed C .for update and delete C .if price_ adjustment_id not passed X X X X X X X X X X X Derived Optional rltd_Price_Adj_Id Rltd_Adj_Index creation_date created_by last_update_date last_updated_by last_update_login NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER program_application_id NUMBER program_id program_update_date request_id NUMBER DATE NUMBER 2-220 Oracle Order Management Suite APIs and Open Interfaces Manual .if line_id not passed C .Oracle Order Management Process Order API TYPE Line_Adj_Att_Tbl_Type is TABLE of Line_Adj_Att_rec_Type INDEX by BINARY_INTEGER Line_Adj_Assoc_Rec_Type For column descriptions.if line_index not passed C .

.Oracle Order Management Process Order API Table 2–39 return_status db_flag operation VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) X X X TYPE Line_Adj_Assoc_Tbl_Type is TABLE of Line_Adj_Assoc_rec_Type INDEX by BINARY_INTEGER.. TYPE Line_Scredit_Rec_Type IS RECORD For column descriptions. please refer to the Order Management TRM for the table OE_SALES_CREDITS Table 2–40 OE_SALES_CREDITS Parameter attribute1. attribute15 context created_by creation_date dw_update_advice_ flag header_id last_updated_by last_update_date last_update_login line_id percent salesrep_id sales_credit_type_id sales_credit_id wh_update_date VARCHAR2(30) NUMBER DATE VARCHAR2(1) NUMBER NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE X X X X X X X X X X X X X X Datatype VARCHAR2(240) Required Derived Optional X Oracle Order Management Open Interface 2-221 ..

.. sales_credit_type ). TYPE Line_Scredit_Val_Tbl_Type IS TABLE OF Line_Scredit_Val_Rec_Type INDEX BY BINARY_INTEGER.Oracle Order Management Process Order API Table 2–40 OE_SALES_CREDITS return_status db_flag operation line_index orig_sys_credit_ref change_request_code status_flag VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) NUMBER VARCHAR2(50) VARCHAR2(30) VARCHAR2(1) X X X X X X X TYPE Line_Scredit_Tbl_Type IS TABLE OF Line_Scredit_Rec_Type INDEX BY BINARY_INTEGER. attribute15 context created_by creation_date from_serial_number last_updated_by VARCHAR2(30) NUMBER DATE VARCHAR2(30) NUMBER C . please refer to the Order Management TRM for the table OE_LOT_SERIAL_NUMBERS Table 2–41 OE_LOT_SERIAL_NUMBERS Parameter attribute1. Lot_Serial_Rec_Type For column descriptions.Line_Scredit value record type TYPE Line_Scredit_Val_Rec_Type IS RECORD ( salesrep . -.if lot number not passed X X X X X Datatype VARCHAR2(240) Required Derived Optional X 2-222 Oracle Order Management Suite APIs and Open Interfaces Manual ..

Oracle Order Management Open Interface 2-223 .if line index not passed C .Oracle Order Management Process Order API Table 2–41 OE_LOT_SERIAL_NUMBERS last_update_date last_update_login line_id lot_number DATE NUMBER NUMBER VARCHAR2(30) C .if lot number not passed X X X C .if lot serial information not available C . TYPE Lot_Serial_Val_Tbl_Type IS TABLE OF Lot_Serial_Val_Rec_Type INDEX BY BINARY_INTEGER.for update and delete operation X C .if line id not passed X X X X X X X X lot_serial_id quantity to_serial_number return_status db_flag operation line_index orig_sys_lotserial_ref NUMBER NUMBER VARCHAR2(30) VARCHAR2(1) VARCHAR2(1) VARCHAR2(30) NUMBER VARCHAR2(50) X X X change_request_code VARCHAR2(30) status_flag line_set_id VARCHAR2(1) NUMBER TYPE Lot_Serial_Tbl_Type IS TABLE OF Lot_Serial_Rec_Type INDEX BY BINARY_INTEGER. TYPE Lot_Serial_Val_Rec_Type IS RECORD (line lot_serial).

G_OPR_CREATE. the line ID is retrieved and based on the line_index. Since models and standard lines are processed before the options. Line adjustments. the model line’s ID is stored on the option lines.Oracle Order Management Process Order API Usage Process Order is a complex API and a number of operations on a single order object and its entities can be performed via this API. the line_index field on the child entity records indicates the index for the parent entity record in the lines table. this line ID can then be populated before the option lines are processed. Again. CREATE operation For creating new order entities. This section is intended to help a user of the process order API in identifying the required parameters for some common operations and to give an understanding of the business flow behind each of these operations. Similarly for config items. the line ID for the model line will not be available. After the line is processed. process order will interpret it as insertion of NULL into those attributes column and will NOT get default values for those attributes. NOTE: If you pass in NULL values for some attributes. the ID of the parent line is unknown. when inserting models and options in a configuration together. the correct line_ID is populated on the child entity record. The config_line_index field on the option lines can be used to indicate the index for this model line in the lines table. Pass in the known attributes on these records and Process Order will default the other missing attributes. the entity records and entity tables passed to Process_Order should have the operation OE_GLOBALS. When inserting the parent line and the child entities of this line together. The following steps are executed for each entity within process order: s Check security Attribute level validation Entity level validation Posted to the database Cross Record Logic s s s s Example 1 C Creating a new order with 2 lines and 1 line adjustment and the adjustment belongs to the sec- 2-224 Oracle Order Management Suite APIs and Open Interfaces Manual . In this case. line sales credits and line lot serial numbers belong to an order line and the ID of this parent line is stored on these records.

Initialize record to missing l_line_adj_tbl(1) := OE_ORDER_PUB..CALL TO PROCESS ORDER OE_Order_PUB. l_line_tbl(2). l_line_tbl(1). Oracle Order Management Open Interface 2-225 . -.SECOND LINE RECORD -..G_MISS_LINE_REC. l_line_adj_tbl(1). -.G_OPR_CREATE.inventory_item_id := 311. -. l_line_tbl(1)....operation := OE_GLOBALS.Indicator that this adjustment belongs to the second line l_line_adj_tbl(1).discount_id := 1.FIRST LINE RECORD -. .operation := OE_GLOBALS.Other attributes l_header_rec.G_MISS_LINE_REC. -. -.ordered_quantity := 2.Line attributes l_line_tbl(1).operation := OE_GLOBALS..G_MISS_HEADER_REC.ordered_quantity := 1. -. l_header_rec.operation := OE_GLOBALS..Null attribute: no defaulting for freight terms l_header_rec.Initialize record to missing l_header_rec := OE_ORDER_PUB. l_line_adj_tbl(1).Attributes for the line adjustment l_line_adj_tbl(1)..freight_term_code = NULL. l_line_tbl(2).SETTING UP THE HEADER RECORD -.line_index := 2.LINE ADJUSTMENT RECORD -.G_MISS_LINE_ADJ_REC. -..g.Oracle Order Management Process Order API ond line..percent := 5.Initialize record to missing l_line_tbl(1) := OE_ORDER_PUB. -. Order Type and Customer) l_header_rec.Initialize record to missing l_line_tbl(2) := OE_ORDER_PUB..G_OPR_CREATE. -. -.Indicates to process order that a new header is being created l_header_rec.Line attributes l_line_tbl(2)inventory_item_id := 312.Required attributes (e.Process_Order( . -. -....G_OPR_CREATE.G_OPR_CREATE.order_type_id := 1000.price_list_id := 10.. -.sold_to_org_id := 100.

get(p_msg_index => l_index... -.. 2-226 Oracle Order Management Suite APIs and Open Interfaces Manual ..... x_return_status=> l_return_status x_msg_count=> l_msg_count x_msg_data=> l_msg_data).... -. p_encoded => ‘F’). -.Check the return status if x_return_status = FND_API....Passing just the entity records that are a part of this order p_header_rec => l_header_rec p_line_tbl=> l_line_tbl p_line_adj_tbl=> l_line_adj_tbl -..G_RET_STS_SUCCESS then success..OUT variables x_header_rec=> l_header_rec x_header_scredit_tbl=> l_header_scr_tbl x_header_adj_tbl=> l_header_adj_tbl x_line_tbl=> l_line_tbl x_line_scredit_tbl=> l_line_scredit_tbl x_line_adj_tbl=> l_line_adj_tbl . end loop.Oracle Order Management Process Order API .. end if...l_msg_count loop l_msg_data := oe_msg_pub.. end if. else failure.Retrieve messages if l_msg_count > 0 then for l_index in 1.....

. l_line_tbl(1). if it was also passed to process order else there will be an error in the processing of this line).G_OPR_CREATE.g. another entity record can also be created as long as they belong to the same order object. Oracle Order Management Open Interface 2-227 . need to be passed and others can be set to missing.Passing just the entity records that are being created p_line_tbl=> l_line_tbl -..G_OPR_UPDATE.operation := OE_GLOBALS. l_line_tbl(1). p_header_rec. the primary key of this entity and the primary key of the parent entity. if any.Indicator that a new line is being created l_line_tbl(1). the operations on the entity record being updated should be OE_GLOBALS.Oracle Order Management Process Order API Example 2 Inserting a new line into an existing order... UPDATE operation Update of any attributes on the entities of the order object should always go through the process order API. For e.. NOTE: If you pass in NULL values for some attributes.Process_Order(. if any.Primary key of the parent entity (If not passed.. process any other entity) belonging to different orders in one process order call -. process order will update existing value of those attributes.NEW LINE RECORD l_line_tbl(1) := OE_ORDER_PUB. Only the attributes that are being updated. with NULL. Process Order will query these missing attributes from the database.OUT variables . For updates. this will be retrieved from the parent record.ordered_quantity := 1. -. In a call where one entity record is being updated....inventory_item_id := 311. -. Warning: You cannot insert new lines (or.header_id := 1000. Process Order can process entities belonging to one order object in one call.CALL TO PROCESS ORDER OE_ORDER_PUB. -.G_MISS_LINE_REC. a line can be updated (G_ OPR_UPDATE) and another line inserted (G_OPR_CREATE) in the same process order call if both lines have the same header_id.Attributes for the new line l_line_tbl(1).. -.)... -.

e. Only the primary key of the entity being deleted needs to be passed.. -. -.Process_Order(. the order line l_line_tbl(1)..G_MISS_LINE_REC. l_line_tbl(1).g.. header adjustments are deleted.Indicates to process order that this is an update operation l_line_tbl(1).line_id := 1000..ordered_quantity := 2.. -.Oracle Order Management Process Order API The following processing steps are executed for each entity record that is updated: s Check security for update of the changed attributes Validation of updated attributes Clearing of (or set to missing) attributes dependent on the updated attributes Defaulting of missing attributes Entity level validation Entity security check Posted to the database Cross Record Logic s s s s s s s Example 3 Updating the bill to organization and order quantity on an order line.G_OPR_DELETE. -. header sales credits...Changed attributes l_line_tbl(1) := OE_ORDER_PUB. Deleting 2-228 Oracle Order Management Suite APIs and Open Interfaces Manual ..... DELETE operation For deletes.. to delete an order. -.). only the header record with the header ID needs to be passed to process order and all the child entities i.G_OPR_UPDATE.Primary key of the entity i.LINE RECORD WITH THE CHANGES -..invoice_to_org_id := 322. the operations on the entity records being deleted should be OE_ GLOBALS. lines.operation := OE_GLOBALS. l_line_tbl(1). Deletes are cascaded down to the child entities for e.OUT variables .e.CALL TO PROCESS ORDER OE_ORDER_PUB..Entity records p_line_tbl=> l_line_tbl -.

CALL TO PROCESS ORDER OE_ORDER_PUB.. -. the header l_header_rec := OE_ORDER_PUB.. Also... -. Note: Child entities will always be deleted if parent entity passes security check.Oracle Order Management Process Order API the lines results in the deletion of line adjustments.G_OPR_DELETE.Entity records p_header_rec=> l_header_rec -... There will not be a separate security check for child entities Entity level validation for deletes... -.Process_Order(. -.. Oracle Order Management Open Interface 2-229 . Action Request Process order can also process other action requests on the order or line as has been documented already.... holds and attachments. it would delete delayed requests logged by or against this entity and its child entities.Only the record for the parent entity needs to be passed. Since the whole order is being deleted....operation := OE_GLOBALS.e... This will also delete child entities. Deletes would also result in the deletion of any holds and attachments associated with the deleted entity and its child entities.. Cross Record Logic s s s Example 5 Deleting an order..Primary key of this order i. Delete posted to the database. line sales credits and line lot serial numbers as well. only the header record needs to be passed.).Indicate to process order that the order is to be deleted l_header_rec. The following processing steps are executed for each entity record that is deleted: s Entity security check.OUT variables .G_MISS_LINE_REC.. -... The workflow status information for this entity is also purged.

param2 = ‘I’..inserting request record into the action request table l_action_request_tbl := l_request_rec..entity := OE_GLOBALS..CALL TO PROCESS ORDER OE_Order_PVT.).. -..Id of the item (hold_entity_id) l_request_rec..entity_id := 100....indicator that it is an item hold (hold_entity_code) l_request_rec.param1 := 4. -.action request table p_action_request_tbl=> l_action_request_tbl. -..request record parameters -.name of the action request l_request_rec. See Also Oracle Applications Message Reference Manual Oracle Order Management User’s Guide 2-230 Oracle Order Management Suite APIs and Open Interfaces Manual . -.. -.... -.Indicates that it is a line level action l_request_rec. -.defective product hold (hold_id) l_request_rec.ACTION REQUEST RECORD -.param3 := 3214. -.Oracle Order Management Process Order API Example 6 Apply a hold to an order line due to a defective item.request_name := OE_GLOBALS.....G_APPLY_HOLD.OUT variables ..G_ENTITY_LINE...primary key of the line on which the hold is to be applied l_request_rec. -. -.Process_Order(.

3 Oracle Pricing Open Interfaces This chapter contains information about the following Oracle Pricing open interfaces and application program interfaces: n Formula Calculation Application Program Interface on page 3-2 Formula Calculation Application Program Interface on page 3-6 Copy Price List Application Program Interface on page 3-8 Adjust Price List Application Program Interface on page 3-13 Business Object for Pricing Formulas Application Program Interface on page 3-16 Price Request Application Program Interface on page 3-29 Business Object for Modifier Setup Application Program Interface on page 3-49 Qualifiers Application Program Interface on page 3-83 Attribute Mapping Application Program Interface on page 3-98 Price List Setup Application Program Interface on page 1-2 n n n n n n n n n Oracle Pricing Open Interfaces 3-1 .

n n n n n API available only to procedures within this package—Component_Value: A function to evaluate each component of a formula. Functional Overview The Formula Calculation package QP_FORMULA_PRICE_CALC_PVT contains the following APIs and record type definitions: n APIs and type definitions exposed to all procedures within and outside of this package n req_line_attrs req_line_attrs_tbl Get_Custom_Price: A customizible function. All of the inbound and outbound parameters are listed. Calculate: The pricing engine function that evaluates a formula and calculates its result. Formula Calculation API Features The Formula Calculation package consists of entities to calculate the value of a formula. Parse_Formula: A utility function that the pricing engine uses to parse a formula before it replaces the step numbers with the actual components. Additional information on these parameters may follow. REQ_LINE_ATTRS_REC Parameter line_index attribute_type Usage Type Number Varchar2 Required Derived Optional 3-2 Oracle Order Management Suite APIs and Open Interfaces Manual . Setting Up the Formula Calculation API Parameter Descriptions The following chart describes all parameters used by the public Formula Calculation.Formula Calculation Application Program Interface Formula Calculation Application Program Interface This section explains how to use the Formula Calculation API and how it functions in Oracle Pricing. The Calculate function calls it.

Formula Calculation Application Program Interface Parameter context attribute value Usage Type Varchar2 Varchar2 Varchar2 Required Derived Optional REQ_LINE_ATTRS_TBL Parameter rec_line_attrs_rec Usage Type Record Required Derived Optional GET_CUSTOM_PRICE Parameter p_price_formula_id p_list_price p_price_effective_date p_req_line_attrs_tbl Usage In In In In Return Type Number Number Date Table Number Required Derived Optional PARSE_FORMULA Parameter p_formula x_return_status Usage In Out Type Varchar2 Varchar2 Required Derived Optional CALCULATE Parameter p_price_formula_id p_list_price p_price_effective_date p_req_line_attrs_tbl x_return_status Usage In In In In Out Type Number Number Date Table Varchar2 Required Derived Optional Oracle Pricing Open Interfaces 3-3 .

see your Oracle Pricing Technical Reference Manual for details. the API will return error status to the calling module. Other Validation None Error Handling If any validation fails.Formula Calculation Application Program Interface Parameter Usage Return Type Number Required Derived Optional COMPONENT_VALUE Parameter p_price_formula_id p_step_number p_list_price p_price_effective_date p_req_line_attrs_tbl x_return_status Usage In In In In In Out Return Type Number Number Number Date Table Varchar2 Number Required Derived Optional Validation of Formula Calculation API Standard Validation Oracle Pricing validates all required columns in the Formula calculation API. For specific information on the data implied by these columns. Condition Success Failure PROCESS_STATIS 5 4 ERROR_MESSAGE null actual error message 3-4 Oracle Order Management Suite APIs and Open Interfaces Manual . The Formula Calculation API processes the rows and reports the following values for every record.

Formula Calculation Application Program Interface See Also Oracle Pricing Technical Reference Manual Oracle Pricing Open Interfaces 3-5 .

All of the inbound and outbound parameters are listed. Update Formula Prices API Features The Update Formula Prices package consists of entities to update formula prices. Functional Overview The Update Formula Prices package QP_UPDATE_FORMULAPRICE_PVT contains APIs and type definitions exposed to all procedures within and outside of this package—Update_ Formula_Price: This procedure is a concurrent program executable and updates the list price of price list lines that have a formula attached and marked for static calculation. Setting Up the Update Formula Prices API Parameter Descriptions The following chart describes all parameters used by the public Update Formula Prices. Additional information on these parameters may follow. UPDATE_FORMULA_PRICE Parameter err_buf ret_code p_update_flagged_items p_retrieve_all_flag p_price_formula_id Usage Out Out In In In Type Varchar2 Number Varchar2 Varchar2 Number Required Derived Optional 3-6 Oracle Order Management Suite APIs and Open Interfaces Manual .Update Formula Prices Application Program Interface Update Formula Prices Application Program Interface This section explains how to use the Update Formula Prices API and how it functions in Oracle Pricing.

The Update Formula Prices API processes the rows and reports the following values for every record. the API will return error status to the calling module. Condition Success Failure PROCESS_STATIS 5 4 ERROR_MESSAGE null actual error message See Also Oracle Pricing Technical Reference Manual Oracle Pricing Open Interfaces 3-7 .Update Formula Prices Application Program Interface Validation of Update Formula Prices API Standard Validation Oracle Pricing validates all required columns in the Update Formula Prices API. Other Validation None Error Handling If any validation fails. For specific information on the data implied by these columns. see your Oracle Pricing Technical Reference Manual for details.

Copy_Discounts: Utility procedure to copy discounts attached to the price list being copied. n n n API available only to procedures within this package n Price_Break_Line: A utility function that determines if a price list line is a price break line. The Copy_Price_List procedure calls it. The Copy_Price_List procedure calls it. price breaks.Copy Price List Application Program Interface Copy Price List Application Program Interface This section explains how to use the Copy Price List API and how it functions in Oracle Pricing. related modifiers. n n n 3-8 Oracle Order Management Suite APIs and Open Interfaces Manual . and discounts. The Copy_Price_List procedure calls it. mapping_tbl Copy_Price_List: This procedure a concurrent program executable and copies price lists and their qualifiers. Get_New_Id: A utility function that retrieves the new list line ID that corresponds to an old list line ID from the mapping table. Copy Price List API Features The Copy Price List package consists of entities to copy price lists. The Copy_ Price_List procedure calls it. Functional Overview The package QP_COPY_PRICELIST_PVT contains the following APIs and record type definitions: n APIs and type definitions exposed to all procedures within and outside of this package n mapping_rec: A record type used for a mapping array between an old and new list line ID. Delete_Duplicate_Lines: A utility procedure that detects duplicate price list lines that might be created when the copy does not retain effective dates.

MAPPING_REC Parameter list_line_type_code old_list_line_id new_list_line_id Usage Type Varchar2 Number Number Required Derived Optional MAPPING_TBL Parameter mapping_rec Usage Type Record Required Derived Optional COPY_PRICE_LIST Parameter errbuf retcode p_from_list_header_id p_new_price_list_name p_description p_start_date_active p_end_date_active p_discount_flag p_segment1_lohi p_segment2_lohi p_segment3_lohi p_segment4_lohi Usage Out Out In In In In In In In In In In Type Varchar2 Number Number Varchar2 Varchar2 Date Date Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional Oracle Pricing Open Interfaces 3-9 . Additional information on these parameters may follow.Copy Price List Application Program Interface Setting Up the Copy Price List API Parameter Descriptions The following chart describes all parameters used by the public Copy Price List. All of the inbound and outbound parameters are listed.

Copy Price List Application Program Interface Parameter p_segment5_lohi p_segment6_lohi p_segment7_lohi p_segment8_lohi p_segment9_lohi p_segment10_lohi p_segment11_lohi p_segment12_lohi p_segment13_lohi p_segment14_lohi p_segment15_lohi p_segment16_lohi p_segment17_lohi p_segment18_lohi p_segment19_lohi p_segment20_lohi p_category_id p_rounding_factor p_effective_dates_flag Usage In In In In In In In In In In In In In In In In In In In Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Number Number Varchar2 Required Derived Optional PRICE_BREAK_LINE Parameter p_list_line_id Usage In Return Type Number Boolean Required Derived Optional GET_NEW_ID Parameter a_list_line_id Usage In Type Number Required Derived Optional 3-10 Oracle Order Management Suite APIs and Open Interfaces Manual .

For specific information on the data implied by these columns.Copy Price List Application Program Interface Parameter a_mapping_tbl Usage In Return Type Mapping_Tbl Number Required Derived Optional DELETE_DUPLICATE_LINES Parameter p_effective_dates-flag p_new_list_header_id Usage In In Type Varchar2 Number Required Derived Optional COPY_DISCOUNTS Parameter p_from_list_header_id p_new_list_header_id p_context p_attribute p_user_id p_conc_login_id p_conc_program_ application_id p_conc_program_id p_conc_request_id Usage In In In In In In In In In Type Number Number Varchar2 Varchar2 Number Number Number Number Number Required Derived Optional Validation of Copy Price List API Standard Validation Oracle Pricing validates all required columns in the Copy Price List API. Other Validation None Oracle Pricing Open Interfaces 3-11 . see your Oracle Pricing Technical Reference Manual for details.

Condition Success Failure PROCESS_STATIS 5 4 ERROR_MESSAGE null actual error message See Also Oracle Pricing Technical Reference Manual 3-12 Oracle Order Management Suite APIs and Open Interfaces Manual .Copy Price List Application Program Interface Error Handling If any validation fails. the API will return error status to the calling module. The Copy Price List API processes the rows and reports the following values for every record.

Adjust Price List API Features The Adjust Price List package consists of entities to adjust price lists. REQ_LINE_ATTRS_REC Parameter errbuf retcode p_list_header_id p_percent p_amount p_segment1_lohi p_segment2_lohi p_segment3_lohi p_segment4_lohi p_segment5_lohi p_segment6_lohi Usage Out Out In In In In In In In In In Type Varchar2 Number Number Number Number Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional Oracle Pricing Open Interfaces 3-13 . Setting Up the Adjust Price List API Parameter Descriptions The following chart describes all parameters used by the public Adjust Price List. Functional Overview The package QP_FORMULA_PRICE_CALC_PVT contains APIs and type definitions exposed to all procedures within and outside of this package—Adjust Price List: This procedure is a concurrent program executable and adjusts price lists. Additional information on these parameters may follow.Adjust Price List Application Program Interface Adjust Price List Application Program Interface This section explains how to use the Adjust Price List API and how it functions in Oracle Pricing. All of the inbound and outbound parameters are listed.

For specific information on the data implied by these columns. see your Oracle Pricing Technical Reference Manual for details.Adjust Price List Application Program Interface Parameter p_segment7_lohi p_segment8_lohi p_segment9_lohi p_segment10_lohi p_segment11_lohi p_segment12_lohi p_segment13_lohi p_segment14_lohi p_segment15_lohi p_segment16_lohi p_segment17_lohi p_segment18_lohi p_segment19_lohi p_segment20_lohi p_category_id p_status_code p_create_date p_rounding_factor Usage In In In In In In In In In In In In In In In In In In Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Number Varchar2 Date Number Required Derived Optional Validation of Adjust Price List API Standard Validation Oracle Pricing validates all required columns in the Adjust Price List API. Other Validation None 3-14 Oracle Order Management Suite APIs and Open Interfaces Manual .

Condition Success Failure PROCESS_STATIS 5 4 ERROR_MESSAGE null actual error message See Also Oracle Pricing Technical Reference Manual Oracle Pricing Open Interfaces 3-15 . the API will return error status to the calling module.Adjust Price List Application Program Interface Error Handling If any validation fails. The Adjust Price List API processes the rows and reports the following values for every record.

n n n n n n n n n n 3-16 Oracle Order Management Suite APIs and Open Interfaces Manual . Formula_Lines_Tbl_Type Formula_Lines_Val_Rec_Type: A record type used to store values corresponding to IDs in the Formula Lines record. Formula_Tbl_Type Formula_Val_Rec_Type: A record type used to store values corresponding to IDs in the formula record. QP_Price_formula_PUB. QP_Price_formula_PUB.Get_Price_Formula: Retrieves the price formula header and lines for a given formula. Formula_Val_Tbl_Type Formula_Lines_Rec_Type: A record type corresponding to the columns in the Formula Lines table (QP_PRICE_FORMULA_LINES). However. The package QP_Price_Formula_PUB contains the following public record type and table of records definitions: n Formula_Rec_Type: A record type corresponding to the columns in the Formula Headers view (QP_PRICE_FORMULAS_VL).Business Object for Pricing Formulas Application Program Interface Business Object for Pricing Formulas Application Program Interface This section explains how to use the Business Object for Pricing Formulas API and how it functions in Oracle Pricing. the modal Formula Factors window is based on the Modifiers public API QP_Modifiers_PUB.Lock_Price_Formula: Locks price formula header and price formula lines records prior to updates.Process_Modifiers. Formula_Lines_Val_Tbl_Type QP_Price_formula_PUB. Functional Overview The Formulas window is based on the following APIs.Process_Price_Formula: Performs the insert. Business Object for Pricing Formulas API Features The Business Object for Pricing Formulas package consists of entities to support the Formulas window. update. and delete of price formula header and price formula lines.

FORMULA_REC_TYPE Parameter attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 context created_by creation_date description end_date_active formula last_updated_by Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Number Date Varchar2 Date Varchar2 Number Required Derived Optional Oracle Pricing Open Interfaces 3-17 . Additional information on these parameters follows. All of the inbound and outbound parameters are listed.Business Object for Pricing Formulas Application Program Interface Setting Up the Business Object for Pricing Formulas API Parameter Descriptions The following chart describes all parameters used by the public X.

G_MISS_DATE formula Default Value: FND_API.G_MISS_DATE description Default Value: FND_API.G_MISS_NUM creation_date Default Value: FND_API.G_MISS_CHAR last_updated_by Default Value: FND_API.G_MISS_CHAR end_date_active Default Value: FND_API.Business Object for Pricing Formulas Application Program Interface Parameter last_update_date last_update_login name price_formula_id start_date_active return_status db_flag operation Usage Type Date Number Varchar2 Number Date Varchar2 Varchar2 Varchar2 Required Derived Optional attribute1-15 Default Value: FND_API.G_MISS_CHAR context Default Value: FND_API.G_MISS_NUM 3-18 Oracle Order Management Suite APIs and Open Interfaces Manual .G_MISS_CHAR created_by Default Value: FND_API.

G_MISS_CHAR operation Default Value: FND_API.G_MISS_NUM retun_status Default Value: FND_API.G_MISS_CHAR FORMULA_TBL_TYPE Parameter Formula_Rec_Type Usage Type Record Required Derived Optional FORMULA_VAL_REC_TYPE Parameter price_formula Usage Type Number Required Derived Optional Oracle Pricing Open Interfaces 3-19 .G_MISS_CHAR price_formula_id Default Value: FND_API.G_MISS_DATE step_number Default Value: FND_API.G_MISS_DATE last_update_login Default Value: FND_API.G_MISS_NUM start_date_active Default Value: FND_API.Business Object for Pricing Formulas Application Program Interface last_update_date Default Value: FND_API.G_MISS_CHAR db_flag Default Value: FND_API.G_MISS_NUM name Default Value: FND_API.

Business Object for Pricing Formulas Application Program Interface price formula Default Value: FND_API.G_MISS_CHAR FORMULA_VAL_TBL_TYPE Parameter Formula_Val_Rec_Type Usage Type Record Required Derived Optional FORMULA_LINES_REC_TYPE Parameter attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 context created_by creation_date end_date_active last_updated_by last_update_date Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Number Date Date Number Date Required Derived Optional 3-20 Oracle Order Management Suite APIs and Open Interfaces Manual .

G_MISS_NUM creation_date Default Value: FND_API.G_MISS_CHAR context Default Value: FND_API.G_MISS_CHAR created_by Default Value: FND_API.G_MISS_DATE end_date_active Default Value: FND_API.G_MISS_NUM Oracle Pricing Open Interfaces 3-21 .Business Object for Pricing Formulas Application Program Interface Parameter last_update_login numeric_constant price_formula_id price_formula_line_id formula_line_type_code price_list_line_id price_modifier_list_id pricing_attribute pricing_attribute_context start_date_active return_status db_flag operation Usage Type Number Number Number Number Varchar2 Number Number Varchar2 Varchar2 Date Varchar2 Varchar2 Varchar2 Required Derived Optional attribute1-15 Default Value: FND_API.G_MISS_DATE last_updated_by Default Value: FND_API.

G_MISS_NUM price_modifier_list_id Default Value: FND_API.G_MISS_NUM price_formula_line_id Default Value: FND_API.G_MISS_NUM price_formula_id Default Value: FND_API.G_MISS_CHAR price_list_line_id Default Value: FND_API.G_MISS_NUM pricing_attribute Default Value: FND_API.G_MISS_NUM 3-22 Oracle Order Management Suite APIs and Open Interfaces Manual .Business Object for Pricing Formulas Application Program Interface last_update_date Default Value: FND_API.G_MISS_NUM numeric_constant Default Value: FND_API.G_MISS_NUM formula_line_type_code Default Value: FND_API.G_MISS_DATE step_number Default Value: FND_API.G_MISS_DATE last_update_login Default Value: FND_API.G_MISS_CHAR pricing_attribute_context Default Value: FND_API.G_MISS_CHAR start_date_active Default Value: FND_API.

G_MISS_CHAR operation Default Value: FND_API.Business Object for Pricing Formulas Application Program Interface retun_status Default Value: FND_API.G_MISS_CHAR Oracle Pricing Open Interfaces 3-23 .G_MISS_CHAR FORMULA_LINES_TBL_TYPE Parameter Formula_Lines_Rec_Type Usage Type Record Required Derived Optional FORMULA_LINES_VAL_REC_TYPE Parameter price_formula price_formula_line price_formula_line_type price_list_line price_modifier_list Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional price_formula Default Value: FND_API.G_MISS_CHAR price_list_line Default Value: FND_API.G_MISS_CHAR db_flag Default Value: FND_API.G_MISS_CHAR price_formula_line Default Value: FND_API.G_MISS_CHAR price_formula_line_type Default Value: FND_API.

G_MISS_CHAR FORMULA_LINES_VAL_TBL_TYPE Parameter Formula_Lines_Val_Rec_ Type Usage Type Record Required Derived Optional QP_PRICE_FORMULA.PROCESS_PRICE_FORMULA Parameter p_api_version_number p_init_msg_list p_return_values p_commit x_return_status x_msg_count x_msg_data p_FORMULA_rec p_FORMULA_val_rec p_FORMULA_LINES_tbl p_FORMULA_LINES_ val_tbl x_FORMULA_rec x_FORMULA_val_rec x_FORMULA_LINES_tbl x_FORMULA_LINES_ val_tbl Usage In In In In Out Out Out In In In In Out Out Out Out Type Number Varchar2 Varchar2 Varchar2 Varchar2 Number Varchar2 Formula_Rec_ Type Formula_Val_ Rec_Type Formula_Lines_ Tbl_Type Formula_Lines_ Val_Tbl_Type Formula_Rec_ Type Formula_Val_ Rec_Type Formula_Lines_ Tbl_Type Formula_Lines_ Val_Tbl_Type Required Derived Optional 3-24 Oracle Order Management Suite APIs and Open Interfaces Manual .Business Object for Pricing Formulas Application Program Interface price_modifier_list Default Value: FND_API.

G_FALSE p_FORMULA_rec Default Value: G_MISS_FORMULA_REC p_FORMULA_val_rec Default Value: G_MISS_FORMULA_VAL_REC p_FORMULA_LINES_tbl Default Value: G_MISS_FORMULA_LINES_TBL p_FORMULA_LINES_val_tbl Default Value: G_MISS_FORMULA_LINES_VAL_TBL QP_PRICE_FORMULA.PROCESS_PRICE_FORMULA Parameter p_api_version_number p_init_msg_list p_return_values x_return_status x_msg_count x_msg_data p_FORMULA_rec p_FORMULA_val_rec p_FORMULA_LINES_tbl Usage In In In Out Out Out In In In Type Number Varchar2 Varchar2 Varchar2 Number Varchar2 Formula_Rec_ Type Formula_Val_ Rec_Type Formula_Lines_ Tbl_Type Required Derived Optional Oracle Pricing Open Interfaces 3-25 .G_FALSE p_return_values Default Value: FND_API.Business Object for Pricing Formulas Application Program Interface p_init_msg_list Default Value: FND_API.G_FALSE p_commit Default Value: FND_API.

G_FALSE p_return_values Default Value: FND_API.G_FALSE p_FORMULA_rec Default Value: G_MISS_FORMULA_REC p_FORMULA_val_rec Default Value: G_MISS_FORMULA_VAL_REC p_FORMULA_LINES_tbl Default Value: G_MISS_FORMULA_LINES_TBL p_FORMULA_LINES_val_tbl Default Value: G_MISS_FORMULA_LINES_VAL_TBL QP_PRICE_FORMULA.GET_PRICE_FORMULA Parameter p_api_version_number p_init_msg_list p_return_values Usage In In In Type Number Varchar2 Varchar2 Required Derived Optional 3-26 Oracle Order Management Suite APIs and Open Interfaces Manual .Business Object for Pricing Formulas Application Program Interface Parameter p_FORMULA_LINES_ val_tbl x_FORMULA_rec x_FORMULA_val_rec x_FORMULA_LINES_tbl x_FORMULA_LINES_ val_tbl Usage In Out Out Out Out Type Formula_Lines_ Val_Tbl_Type Formula_Rec_ Type Formula_Val_ Rec_Type Formula_Lines_ Tbl_Type Formula_Lines_ Val_Tbl_Type Required Derived Optional p_init_msg_list Default Value: FND_API.

G_FALSE p_price_formula_id Default Value: FND_API.G_MISS_NUM p_price_formula Default Value: FIND_API.G_FALSE p_return_values Default Value: FND_API.G_MISS_CHAR Validation of Business Object for Pricing Formulas API Standard Validation Oracle Pricing validates all required columns in the X API. For specific information on the data implied by these columns. Oracle Pricing Open Interfaces 3-27 .Business Object for Pricing Formulas Application Program Interface Parameter x_return_status x_msg_count x_msg_data p_price_formula_id p_price_formula x_FORMULA_rec x_FORMULA_val_rec x_FORMULA_LINES_tbl x_FORMULA_LINES_ val_tbl Usage Out Out Out In In Out Out Out Out Type Varchar2 Number Varchar2 Number Varchar2 Formula_Rec_ Type Formula_Val_ Rec_Type Formula_Lines_ Tbl_Type Formula_Lines_ Val_Tbl_Type Required Derived Optional p_init_msg_list Default Value: FND_API. see your Oracle Pricing Technical Reference Manual for details.

the API will return error status to the calling module.Business Object for Pricing Formulas Application Program Interface Other Validation None Error Handling If any validation fails. The X API processes the rows and reports the following values for every record. Condition Success Failure PROCESS_STATIS 5 4 ERROR_MESSAGE null actual error message See Also Oracle Pricing Technical Reference Manual 3-28 Oracle Order Management Suite APIs and Open Interfaces Manual .

Applies the eligible benefits to the pricing request. incompatibility.Price_Request) contains the following entities: Oracle Pricing Open Interfaces 3-29 . adjusted price.Price Request Application Program Interface Price Request Application Program Interface This section explains how to use the Price Request API and how it functions in Oracle Pricing. other benefits. Functional Overview The Price Request API (QP_PREQ_GRP. you may have frozen the price of one order line but. The Price Request Application Program Interface consists of two engines: n Search engine: Uses qualifiers and pricing attributes passed from the calling application to select the price list lines and the modifier list lines that may apply to the pricing request. For each pricing phase the search engine executes the following functions: n Selects eligible price list lines and modifier list lines using predefined pricing rules. pass all lines that need prices and that the pricing engine needs to consider as part of pricing request. and charges to a transaction. Resolve incompatibilities among eligible benefits. Since it is PL/SQL based. You can call one or both of the engines by setting the calculate flag on the control record. A pricing request consists of numerous price request lines which mirror the transaction lines of the calling application and may include a transaction header request line. Oracle Applications products request it for pricing calculations and you can request it from custom applications and legacy systems. To properly use the Price Request Application Program Interface. and extended price. the Pricing Request processes one pricing request per call. the search engine uses rules of eligibility. As part of this process. and precedence. For example. n n n Calculation engine: For each pricing request line and its associated pricing request line details. if you include it in the pricing request. Price Request API Features The Price Request Application Program Interface (API) is a public API that allows you to get a base price and to apply price adjustments. calculates the base price. the pricing engine may be able to use the quantity on that line to qualify the order to receive another discount based on quantities across multiple lines. exclusivity.

the serviceable item. Pricing attribute information helps the pricing engine to determine the price list lines and modifier list lines for which a pricing request is eligible. The calling application must load all pricing attributes into this record type that the pricing engine should use to determine if a pricing request line qualifies for a price or modifier. Qualifier information helps the pricing engine to determine the price list lines and modifier list lines for which a pricing request is eligible. LINE_DETAIL_REC_TYPE: A record that contains the details of the derivation of the base and adjusted prices. GENERATED_LINE: Indicates the lines—both request and detail that a pricing request line or pricing request detail line created. RELATED_LINES_REC_TYPE: A record that contains relationships between request lines and between request lines and request line details.Price Request Application Program Interface n PRICE_REQUEST CONTROL_RECORD_TYPE: Parameters which control the behavior of the pricing engine. QUAL_REC_TYPE: A record that contains qualifier information. The pricing engine needs to know this relationship when it must price service items based on a percent of the serviceable item price. The pricing engine may apply many pricing request line detail records to a pricing request. Each pricing request line detail provides details for a price list line or modifier list line. n n Setting Up the Price Request API Parameter Descriptions The following chart describes all parameters used by the public Price Request. 3-30 Oracle Order Management Suite APIs and Open Interfaces Manual . SERVICE_LINE: Relates an order line for a service item and its parent. Additional information on these parameters follows. All of the inbound and outbound parameters are listed. The pricing engine returns all qualifiers that determined eligibility on the request line detail record. LINE_ATTR_REC_TYPE: A record that contains pricing attributes. LINE_REC_TYPE: A record which contains the elements in the calling application that requires a base and adjusted price. Types of relationships are as follows: n n n n n n n PBH_LINE: Relates a price break header to modifier price break lines. It may equate to a transaction line or transaction header record in the calling application.

Price Request Application Program Interface PRICE_REQUEST Parameter p_line_tbl p_qual_tbl p_line_attr_tbl p_line_detail_tbl p_line_detail_qual_tbl Usage In In In In In Type LINE_TBL_ TYPE QUAL_TBL_ TYPE LINE_ATTR_ TBL_TYPE LINE_DETAIL_ TBL_TYPE LINE_DETAIL_ QUAL_TBL_ TYPE LINE_DETAIL_ ATTR_TBL_ TYPE RELATED_ LINES_TBL_ TYPE CONTROL_ RECORD_TYPE LINE_TBL_ TYPE QUAL_TBL_ TYPE LINE_ATTR_ TBL_TYPE LINE_DETAIL_ TBL_TYPE LINE_DETAIL_ QUAL_TBL_ TYPE LINE_DETAIL_ ATTR_TBL_ TYPE Required Derived Optional p_line_detail_attr_tbl In p_related_lines_tbl In p_control_rec x_line_tbl x_qual_tbl x_line_attr_tbl x_line_detail_tbl x_line_detail_qual_tbl In Out Out Out Out Out x_line_detail_attr_tbl Out Oracle Pricing Open Interfaces 3-31 .

ROUNDING_FLAG Indicates whether the calculation engine should round the list price and selling price based on the price list rounding factor or the pricing request line record rounding factor. When rounding. 3-32 Oracle Order Management Suite APIs and Open Interfaces Manual . Allowable values are: n N: Search engine C: Calculate engine Y: Both the calculate and search engines n n SIMULATION_FLAG A value of Yes indicates that the call to is a pricing simulation and that the pricing engine should not make permanent record changes and neither issue or redeem coupons. CALCULATE_FLAG Use to call the engines.Price Request Application Program Interface Parameter x_related_lines_tbl Usage Out Type RELATED_ LINES_TBL_ TYPE Varchar2 Varchar2 Required Derived Optional x_return_status x_return_status_text Out Out CONTROL_REC_TYPE Parameter PRICING_EVENT CALCULATE_FLAG SIMULATION_FLAG ROUNDING_FLAG Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Required X X X X Derived Optional PRICING_EVENT A point in the transaction life cycle of your transaction at which you wish to price it. The pricing event determines which phases the search engine processes according to the mapping in QP_EVENT_PHASES. the calculation engine rounds all intermediate subtotals for each pricing group sequence.

Price Request Application Program Interface LINE_REC_TYPE Parameter REQUEST_TYPE_CODE PRICING_EVENT LIST_LINE_LEVEL_ CODE LINE_INDEX LINE_ID LINE_TYPE_CODE PRICING_EFFECTIVE_ DATE ACTIVE_DATE_FIRST ACTIVE_DATE_FIRST_ TYPE ACTIVE_DATE_SECOND ACTIVE_DATE_ SECOND_TYPE LINE_QUANTITY LINE_UOM_CODE UOM_QUANTITY PRICED_QUANTITY PRICED_UOM_CODE CURRENCY_CODE LIST_PRICE PERCENT_PRICE ADJUSTED_UNIT_PRICE PARENT_PRICE PARENT_QUANTITY ROUNDING_FACTOR PARENT_UOM_CODE Usage Type Varchar2 Varchar2 Varchar2 Number Number Varchar2 Date Date Varchar2 Date Varchar2 Number Varchar2 Number Number Varchar2 Varchar2 Number Number Number Number Number Number Varchar2 X X X X X X X X X X X X X X X X X X X X X Required X X X Derived Optional Oracle Pricing Open Interfaces 3-33 .

PRICING_EVENT Not used.START_DATE_ACTIVE_FIRST and QP_LIST_LINES. LINE_ID Unique identifier of the request line in the calling application. The pricing engine compares this date against the first date range on the modifier list—QP_LIST_LINES. LINE_TYPE_CODE Type of line within the request.Price Request Application Program Interface Parameter PRICING_PHASE_ID PRICE_FLAG PROCESSED_CODE STATUS_CODE STATUS_TEXT Usage Type Number Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional X X X X X REQUEST_TYPE_CODE Identifies the transaction system making the pricing request. LINE_INDEX PL/SQL unique identifier for request line. ACTIVE_DATE_FIRST In addition to the pricing effective date. 3-34 Oracle Order Management Suite APIs and Open Interfaces Manual . LIST_LINE_LEVEL_CODE Not used.Allowable values are: n Order Line n PRICING_EFFECTIVE_DATE Date for which the pricing engine calculates the prices.END_DATE_ACTIVE_FIRST. you can specify two additional dates for the pricing engine to use to qualify pricing entities.

LINE_UOM_CODE Pricing request line unit of measure.START_DATE_ACTIVE_SECOND and QP_LIST_LINES. The pricing engine compares this date against the first date range on the modifier list—QP_LIST_LINES. PRICED_QUANTITY Quantity of pricing request line that pricing engine has priced. CURRENCY_CODE Currency in which the pricing engine priced. UOM_QUANTITY Unit of measure quantity. for example. ACTIVE_DATE_SECOND_TYPE The date type of ACTIVE_DATE_SECOND based on lookup type EFFECTIVE_DATE_ TYPES. LINE_UOM_CODE is Months and UOM_QUANTITY is 2.Price Request Application Program Interface ACTIVE_DATE_FIRST_TYPE The date type of ACTIVE_DATE_FIRST based on lookup type EFFECTIVE_DATE_ TYPES. Not used. ACTIVE_DATE_SECOND In addition to the pricing effective date. LINE_QUANTITY Pricing request line quantity. PRICED_UOM_CODE Unit of measure in which the pricing engine priced. in service pricing. you can specify two additional dates for the pricing engine to use to qualify pricing entities.END_DATE_ACTIVE_SECOND. LIST_PRICE Base price of the item. Oracle Pricing Open Interfaces 3-35 .

Price Request Application Program Interface PERCENT_PRICE Price calculated as a percentage of the price of another item. ADJUSTED_UNIT_PRICE Price per unit after the pricing engine applies discounts and surcharges. Consider the volume of the request line when processing LINEGROUP modifiers for other lines. PARENT_UOM_CODE (Out) When the pricing engine determines the price of an item from the price of another item. N (Freeze Price): Do not apply any prices or modifiers to the request line. P (Partial Price):. PARENT_PRICE (Out) When the pricing engine determines the price of an item from the price of another item. PRICING_PHASE_ID Not used. Apply prices and modifiers in phases whose freeze override flag is Y. n n PROCESSED_CODE Internal code which indicates the stage of engine processing when an error occurred. Allowable values. PARENT_QUANTITY (Out) When the pricing engine determines the price of an item from the price of another item. 3-36 Oracle Order Management Suite APIs and Open Interfaces Manual . the rounding factor that the pricing engine should use. the unit of measure of the related item. the price of the related item. the quantity of the related item. based on lookup type CALCULATE_PRICE_FLAG are: n Y (Calculate Price): Apply all prices and modifiers to the request line. ROUNDING_FACTOR If ROUNDING_FLAG = Y and the pricing event does not include the base price phase. PRICE_FLAG Indicates the degree to which the price is frozen.

Price Request Application Program Interface STATUS_CODE Returned status. LINE_DETAIL_REC_TYPE Parameter LINE_DETAIL_INDEX LINE_DETAIL_ID LINE_DETAIL_TYPE_ CODE LINE_INDEX LIST_HEADER_ID LIST_LINE_ID LIST_LINE_TYPE_CODE Usage Type Number Number Varchar2 Number Number Number Varchar2 X X X X X Required X X Derived Optional Oracle Pricing Open Interfaces 3-37 . Allowable values are: n N: New record created X: Unchanged U: Updated IPL: Invalid price list GSA: GSA violation FER: Error processing formula OER: Other error CALC: Error in calculation engine UOM: Failed to price using unit of measure INVALID_UOM: Invalid unit of measure DUPLICATE_PRICE_LIST: Duplicate price list INVALID_UOM_CONV: Unit of measure conversion not found INVALID_INCOMP: Could not resolve incompatibility INVALID_BEST_PRICE: Could not resolve best price n n n n n n n n n n n n n STATUS_TEXT Returned message.

Price Request Application Program Interface Parameter SUBSTITUTION_TYPE_ CODE SUBSTITUTION_FROM SUBSTITUTION_TO AUTOMATIC_FLAG OPERAND_ CALCULATION_CODE OPERAND_VALUE PRICING_GROUP_ SEQUENCE PRICE_BREAK_TYPE_ CODE CREATED_FROM_LIST_ TYPE_CODE PRICING_PHASE_ID LIST_PRICE LINE_QUANTITY ADUSTMENT_AMOUNT APPLIED_FLAG MODIFIER_LEVEL_ CODE STATUS_CODE STATUS_TEXT SUBSTITUTION_ ATTRIBUTE ACCRUAL_FLAG LIST_LINE_NO ESTIM_GL_VALUE ACCRUAL_ CONVERSION_RATE OVERRIDE_FLAG Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Number Number Varchar2 Varchar2 Number Number Number Number Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Number Number Varchar2 Required Derived Optional X X X X X X X X X X X X X X X X X X X X X X X 3-38 Oracle Order Management Suite APIs and Open Interfaces Manual .

Price Request Application Program Interface Parameter PRINT_ON_INVOICE_ FLAG INVENTORY_ITEM_ID ORGANIZATION_ID RELATED_ITEM_ID RELATIONSHIP_TYPE_ ID ESTIM_ACCRUAL_RATE EXPIRATION_DATE BENEFIT_PRICE_LIST_ LINE_ID RECURRING_FLAG BENEFIT_LIMIT CHARGE_TYPE_CODE CHARGE_SUBTYPE_ CODE INCLUDE_ON_ RETURNS_FLAG BENEFIT_QTY BENEFIT_UOM_CODE PRORATION_TYPE_ CODE SOURCE_SYSTEM_ CODE REBATE_ TRANSACTION_TYPE_ CODE SECONDARY_PRICE_ LIST_IND Usage Type Varchar2 Number Number Number Number Number Date Number Varchar2 Number Varchar2 Varchar2 Varchar2 Number Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional X X X X X X X X X X X X X X X X X X Varchar2 X LINE_DETAIL_INDEX PL/SQL unique identifier. Oracle Pricing Open Interfaces 3-39 .

LIST_LINE_TYPE_CODE Line type of the list line used to update the pricing line. SUBSTITUTION_TO Value for terms substitution attribute. LIST_HEADER_ID Identifier of the list header used to create or update the pricing line. Allowable values are: n Adjustment percent Adjustment amount n 3-40 Oracle Order Management Suite APIs and Open Interfaces Manual . SUBSTITUTION_FROM Not used. The engine derives the value from the list line. AUTOMATIC_FLAG Indicates if the pricing engine should automatically apply the request line detail to the request line. LINE_INDEX Identifier for parent request line. LINE_DETAIL_TYPE_CODE Type of detail line.Price Request Application Program Interface LINE_DETAIL_ID Unique identifier of request line detail in calling application. SUBSTITUTION_TYPE_CODE Not used. OPERAND_CALCULATION_CODE Type of operand. LIST_LINE_ID Identifier of the list line used to create or update the pricing line.

LIST_PRICE (Out) Unit price of the price break line. CREATED_FROM_LIST_TYPE_CODE List type used to create or update the pricing line. LINE_QUANTITY Quantity on the price break line. PRICE_BREAK_TYPE_CODE Type of price break based on lookup type PRICE_BREAK_TYPE_CODE.Price Request Application Program Interface OPERND_VALUE Value of pricing request detail line. 10 currency unit list price with 3% discount PRICING_GROUP_SEQUENCE Indicates the pricing bucket in which the pricing engine applied this list line. Populated if the pricing engine derived the value of the request line or request line detail from a price break. Populated if the pricing engine derived the value of the request line or request line detail from a price break. ADUSTMENT_AMOUNT Value of the request detail line. for example. APPLIED_FLAG The lists or list lines that this pricing event or a prior pricing event applied. Allowable values are n Yes: Applicable when the attribute context is a list or list line No: Applicable when the attribute context is a list or list line Null n n Oracle Pricing Open Interfaces 3-41 . PRICING_PHASE_ID (Out) The pricing phase which created the request line detail.

Price Request Application Program Interface MODIFIER_LEVEL_CODE The level at which the list line qualified for the transaction. OVERRIDE_FLAG (Out) Indicates if a user in the calling application can override the modifier value. LIST_LINE_NO (Out) Modifier number. SUBSTITUTION_ATTRIBUTE (Out) Modifier details. The attribute in the TERMS context that the pricing engine substituted. Based on lookup type MODIFIER_LEVEL_CODE. INVENTORY_ITEM_ID (Out) Inventory item identifier in an item relationship. 3-42 Oracle Order Management Suite APIs and Open Interfaces Manual . Used for Term Substitution-type modifiers. PRINT_ON_INVOICE_FLAG (Out) Not used. for example. Payment Terms. Used for list line type Item Upgrade. ACCRUAL_CONVERSION_RATE (Out) The rate to use when converting a non-monetary accrual to a monetary value. STATUS_CODE Returned status. ACCRUAL_FLAG (Out) Indicates whether the discount is an accrual. STATUS_TEXT Returned message. ESTIM_GL_VALUE (Out) The discount or surcharge value of the modifier. Used to estimate the discount cost for non-monetary modifiers.

RELATIONSHIP_TYPE_ID (Out) Relationship type identifier in an item relationship. BENEFIT_LIMIT (Out) Not used. Used for list line type Item Upgrade. RECURRING_FLAG (Out) Not used. Default Value: 100 EXPIRATION_DATE (Out) The expiration date of the accrual or coupon. RELATED_ITEM_ID (Out) Related inventory item identifier in an item relationship. Used for list line type Item Upgrade. BENEFIT_PRICE_LIST_LINE_ID (Out) The list price before promotional discount.Price Request Application Program Interface ORGANIZATION_ID (Out) Organization identifier in an item relationship. Used for list line type Item Upgrade. Liability is defined as: ACCRUAL OR COUPON VALUE * ESTIM_ ACCRUAL_RATE. Used for Promotional Goods-type modifiers when the pricing engine creates a new transaction line. CHARGE_SUBTYPE_CODE (Out) Indicates the type of charge based on lookup type CHARGE_TYPE_CODE. ESTIM_ACCRUAL_RATE Indicates the percentage at which to accrue or. CHARGE_TYPE_CODE (Out) Indicates the type of charge based on lookup type FREIGHT_CHARGES_TYPE. for a coupon. Used for Freight/Special Charge-type modifiers. Oracle Pricing Open Interfaces 3-43 . the expected rate of redemption of the coupon.

BENEFIT_QTY (Out) The accrual quantity for non-monetary accruals or. item unit of measure. QUAL_REC_TYPE Parameter LINE_INDEX QUALIFIER_CONTEXT QUALIFIER_ATTRIBUTE QUALIFIER_ATTR_ VALUE_FROM QUALIFIER_ATTR_ VALUE_TO COMPARISION_ OPERATOR_CODE VALIDATED_FLAG Usage Type Number Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 X X Required X X X X X Derived Optional 3-44 Oracle Order Management Suite APIs and Open Interfaces Manual . SOURCE_SYSTEM_CODE (Out) Source system which created the modifier based on lookup type SOURCE_SYSTEM. SECONDARY_PRICE_LIST_IND (Out) Indicates that the pricing used a secondary price list instead of the price list that the calling application requested. PRORATION_TYPE_CODE (Out) Not used.Price Request Application Program Interface INCLUDE_ON_RETURNS_FLAG (Out) Indicates whether the pricing engine should include the charge on a return transaction. Used for Freight/Special Charge-type modifiers. for promotional goods. or. for promotional goods. REBATE_TRANSACTION_TYPE_CODE (Out) Not used. item quantity. BENEFIT_UOM_CODE (Out) The accrual unit of measure for non-monetary accruals.

for example. QUALIFIER_ATTRIBUTE1: Customer Class. the pricing engine assumes that other qualifiers are valid. Customer Hierarchy. VALIDATED_FLAG Indicates that a price list or modifier list is valid for the pricing request. Applicable to price list and modifier list qualifiers. COMPARISION_OPERATOR_CODE The pricing engine creates qualifier attributes to indicate to the calling application which qualifier attribute caused it to give a benefit. QUALIFIER_CONTEXT Context for qualifier. QUALIFIER_ATTRIBUTE Qualifier attribute. STATUS_CODE Return status. Order Amount > 1000 currency units (> is the operator code). for example. QUALIFIER_ATTR_VALUE_FROM Value for qualifier attribute QUALIFIER_ATTR_VALUE_TO Return value for qualifier attribute. for example.Price Request Application Program Interface Parameter STATUS_CODE STATUS_TEXT Usage Type Varchar2 Varchar2 Required Derived Optional X X LINE_INDEX Unique identifier for request line or request line detail. Populated when the pricing engine returns details of a volume break. Oracle Pricing Open Interfaces 3-45 . STATUS_TEXT Return message.

STATUS_CODE Return status. 3-46 Oracle Order Management Suite APIs and Open Interfaces Manual . for example. PRICING_ATTR_VALUE_TO Return value for Pricing attribute. PRICING_ATTR_VALUE_FROM Value for product or pricing attribute. PRICING_CONTEXT Context for a product or pricing attribute. Product Hierarchy. the pricing engine assumes that other qualifiers are valid. Populated when the pricing engine returns details of a volume break. Applicable to price list and modifier list qualifiers. PRICING_ATTRIBUTE11: Customer Item ID. VALIDATED_FLAG Indicates that a price list or modifier list is valid for the pricing request. PRICING_ATTRIBUTE Product or pricing attribute.Price Request Application Program Interface LINE_ATTR_REC_TYPE Parameter LINE_INDEX PRICING_CONTEXT PRICING_ATTRIBUTE PRICING_ATTR_VALUE_ FROM PRICING_ATTR_VALUE_ TO VALIDATED_FLAG STATUS_CODE STATUS_TEXT Usage Type Number Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional X X X X X X X X LINE_INDEX Unique identifier for request line or request line detail. for example.

Price Request Application Program Interface

STATUS_TEXT Return message. RELATED_LINES_REC_TYPE
Parameter LINE_INDEX LINE_DETAIL_INDEX RELATIONSHIP_TYPE_ CODE RLTD_LINE_INDEX RLTD_LINE_DETAIL_ INDEX Usage Type Number Number Varchar2 Number Number Required Derived Optional X X X X X

LINE_INDEX PL/SQL unique identifier for request line. LINE_DETAIL_INDEX PL/SQL unique identifier for request detail line. RELATIONSHIP_TYPE_CODE Type of relationship between pricing lines. RLTD_LINE_INDEX PL/SQL identifier for related request line. RLTD_LINE_DETAIL_INDEX PL/SQL unique identifier for related request detail line.

Validation of Price Request API
Standard Validation
Oracle Pricing validates all required columns in the Price Request API. For specific information on the data implied by these columns, see your Oracle Pricing Technical Reference Manual for details.

Oracle Pricing Open Interfaces 3-47

Price Request Application Program Interface

Other Validation
None

Error Handling
If any validation fails, the API will return error status to the calling module. The Price Request API processes the rows and reports the following values for every record.
Condition Success Failure PROCESS_STATIS 5 4 ERROR_MESSAGE null actual error message

See Also
Oracle Pricing Technical Reference Manual

3-48

Oracle Order Management Suite APIs and Open Interfaces Manual

Business Object for Modifier Setup Application Program Interface

Business Object for Modifier Setup Application Program Interface
This section explains how to use the Business Object for Modifier Setup API and how it functions in Oracle Pricing.

Business Object for Modifier Setup API Features
The Business Object for Modifier Setup package consists of entities to set up modifiers.

Functional Overview
The package QP_Modifiers_PUB.Process Modifiers contains the following public record type and table of records entities:
n

Process_Modifiers: QP_Modifiers_PUB.Process_Modifiers is a Public API. It takes two record types and six table types as input parameters. Use this API to insert, update and delete modifiers. Use it to set up a modifier list header for a given p_MODIFIER_ LIST_rec record structure. You can:
n

Set up multiple modifier lines by giving multiple modifier definitions in the p_ MODIFIERS_tbl table structure. Attach multiple qualifiers either at the header level (modifier list) or at the line level (modifier) by giving multiple qualifiers in the p_QUALIFIERS_tbl table structure. Attach multiple pricing attributes to modifier lines by giving the pricing attributes in the p_PRICING_ATTR_tbl table structure.

n

n

n

Modifier_List_Rec_Type: Corresponds to the columns in the modifier header tables QP_LIST_HEADERS_B and QP_LIST_HEADERS_TL. Modifier_List_Tbl_Type Modifier_List_Val_Rec_Type: Corresponds to the columns in the modifier header table QP_LIST_HEADERS_B. Modifier_List_Val_Tbl_Type Modifiers_Rec_Type: Corresponds to the columns in the modifier and related modifiers tables QP_LIST_LINES and QP_RLTD_MODIFIERS. Modifiers_Tbl_Type

n

n

n

n

n

Oracle Pricing Open Interfaces 3-49

Business Object for Modifier Setup Application Program Interface

n

Modifiers_Val_Rec_Type: Corresponds to the columns in the modifier table QP_LIST_ LINES. Modifiers_Val_Tbl_Type Qualifiers_Rec_Type: Corresponds to the columns in the qualifier table QP_ QUALIFIERS. Qualifiers_Tbl_Type Qualifiers_Val_Rec_Type: Corresponds to the columns in the qualifier table QP_ QUALIFIERS. Qualifiers_Val_Tbl_Type Pricing_Attr_Rec_Type: Corresponds to the columns in the pricing attributes table QP_ PRICING_ATTRIBUTES. Pricing_Attr_Tbl_Type Pricing_Attr_Val_Rec_Type: Corresponds to the columns in the pricing attributes table QP_PRICING_ATTRIBUTES. Pricing_Attr_Val_Tbl_Type

n

n

n

n

n

n

n

n

n

Setting Up the Business Object for Modifier Setup API
Parameter Descriptions
The following chart describes all parameters used by the public Business Object for Modifier Setup. All of the inbound and outbound parameters are listed. Additional information on these parameters may follow. PROCESS_MODIFIERS
Parameter p_api_version_number p_init_msg_list p_return_values p_commit x_return_status x_msg_count x_msg_data Usage In In In In Out Out Out Type Number Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional

3-50

Oracle Order Management Suite APIs and Open Interfaces Manual

Business Object for Modifier Setup Application Program Interface

Parameter p_MODIFIER_LIST_rec p_MODIFIER_LIST_val_ rec p_MODIFIERS_tbl p_MODIFIERS_val_tbl p_QUALIFIERS_tbl p_QUALIFIERS_val_tbl p_PRICING_ATTR_tbl p_PRICING_ATTR_val_tbl x_MODIFIER_LIST_rec x_MODIFIER_LIST_val_ rec x_MODIFIERS_tbl x_MODIFIERS_val_tbl x_QUALIFIERS_tbl x_QUALIFIERS_val_tbl x_PRICING_ATTR_tbl x_PRICING_ATTR_val_tbl

Usage In In In In In In In In Out Out Out Out Out Out Out Out

Type Modifier_List_ Rec_Type Modifier_List_ Val_Rec_Type Modifiers_Tbl_ Type Modifiers_Val_ Tbl_Type Qualifiers_Tbl_ Type Qualifiers_Val_ Tbl_Type Pricing_Attr_ Tbl_Type Pricing_Attr_Val_ Tbl_Type Modifier_List_ Rec_Type Modifier_List_ Val_Rec_Type Modifiers_Tbl_ Type Modifiers_Val_ Tbl_Type Qualifiers_Tbl_ Type Qualifiers_Val_ Tbl_Type Pricing_Attr_ Tbl_Type Pricing_Attr_Val_ Tbl_Type

Required

Derived

Optional

p_init_sg_list Default Value: FND_API.G_FALSE

Oracle Pricing Open Interfaces 3-51

Business Object for Modifier Setup Application Program Interface

p_return_values Default Value: FND_API.G_FALSE p_commit Default Value: FND_API.G_FALSE p_MODIFIER_LIST_rec Default Value: G_MISS_MODIFIER_LIST_REC p_MODIFIER_LIST_val_rec Default Value: G_MISS_MODIFIER_LIST_VAL_REC p_MODIFIERS_tbl Default Value: G_MISS_MODIFIERS_TBL p_MODIFIERS_val_tbl Default Value: G_MISS_MODIFIERS_VAL_TBL p_QUALIFIERS_tbl Default Value: G_MISS_QUALIFIERS_TBL p_QUALIFIERS_val_tbl Default Value: G_MISS_QUALIFIERS_VAL_TBL p_PRICING_ATTR_tbl Default Value: G_MISS_PRICING_ATTR_TBL p_PRICING_ATTR_val_tbl Default Value: G_MISS_PRICING_ATTR_VAL_TBL

3-52

Oracle Order Management Suite APIs and Open Interfaces Manual

Business Object for Modifier Setup Application Program Interface

MODIFIER_LIST_REC_TYPE
Parameter attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 automatic_flag comments context created_by creation_date currency_code discount_lines_flag end_date_active freight_terms_code gsa_indicator last_updated_by last_update_date Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Number Date Varchar2 Varchar2 Date Varchar2 Varchar2 Number Date Required Derived Optional

Oracle Pricing Open Interfaces 3-53

Business Object for Modifier Setup Application Program Interface

Parameter last_update_login list_header_id list_type_code program_application_id program_id program_update_date prorate_flag request_id rounding_factor ship_method_code start_date_active terms_id source_system_code active_flag parent_list_header_id start_date_active_first end_date_active_first active_date_first_type start_date_active_second end_date_active_second active_date_second_type ask_for_flag return_status db_flag operation name description

Usage

Type Number Number Varchar2 Number Number Date Varchar2 Number Number Varchar2 Date Number Varchar2 Varchar2 Number Date Date Varchar2 Date Date Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2

Required

Derived

Optional

3-54

Oracle Order Management Suite APIs and Open Interfaces Manual

Business Object for Modifier Setup Application Program Interface

attribute1-15 Default Value: FND_API.G_MISS_CHAR automatic_flag Default Value: FND_API.G_MISS_CHAR comments Default Value: FND_API.G_MISS_CHAR context Default Value: FND_API.G_MISS_CHAR created_by Default Value: FND_API.G_MISS_NUM creation_date Default Value: FND_API.G_MISS_DATE currency_code Default Value: FND_API.G_MISS_CHAR discount_lines_flag Default Value: FND_API.G_MISS_CHAR end_date_active Default Value: FND_API.G_MISS_DATE freight_terms_code Default Value: FND_API.G_MISS_CHAR gsa_indicator Default Value: FND_API.G_MISS_CHAR last_updated_by Default Value: FND_API.G_MISS_NUM

Oracle Pricing Open Interfaces 3-55

Business Object for Modifier Setup Application Program Interface

last_update_date Default Value: FND_API.G_MISS_DATE last_update_login Default Value: FND_API.G_MISS_NUM list_header_id Default Value: FND_API.G_MISS_NUM list_type_code Default Value: FND_API.G_MISS_CHAR program_application_id Default Value: FND_API.G_MISS_NUM program_id Default Value: FND_API.G_MISS_NUM program_update_date Default Value: FND_API.G_MISS_DATE prorate_flag Default Value: FND_API.G_MISS_CHAR request_id Default Value: FND_API.G_MISS_NUM rounding_factor Default Value: FND_API.G_MISS_NUM ship_method_code Default Value: FND_API.G_MISS_CHAR start_date_active Default Value: FND_API.G_MISS_DATE

3-56

Oracle Order Management Suite APIs and Open Interfaces Manual

G_MISS_DATE active_date_first_type Default Value: FND_API.G_MISS_CHAR active_flag Default Value: FND_API.G_MISS_CHAR parent_list_header_id Default Value: FND_API.G_MISS_DATE end_date_active_second Default Value: FND_API.G_MISS_CHAR start_date_active_second Default Value: FND_API.G_MISS_CHAR Oracle Pricing Open Interfaces 3-57 .Business Object for Modifier Setup Application Program Interface terms_id Default Value: FND_API.G_MISS_NUM start_date_active_first Default Value: FND_API.G_MISS_CHAR return_status Default Value: FND_API.G_MISS_CHAR ask_for_flag Default Value: FND_API.G_MISS_DATE end_date_active_first Default Value: FND_API.G_MISS_DATE active_date_second_type Default Value: FND_API.G_MISS_NUM source_system_code Default Value: FND_API.

G_MISS_CHAR name Default Value: FND_API.G_MISS_CHAR currency Default Value: FND_API.G_MISS_CHAR MODIFIER_LIST_TBL_TYPE Parameter Modifier_List_Rec_Type Usage Type Record Required Derived Optional MODIFIER_LIST_VAL_REC_TYPE Parameter automatic currency discount_lines freight_terms list_header list_type prorate ship_method terms Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional automatic Default Value: FND_API.Business Object for Modifier Setup Application Program Interface db_flag Default Value: FND_API.G_MISS_CHAR description Default Value: FND_API.G_MISS_CHAR operation Default Value: FND_API.G_MISS_CHAR 3-58 Oracle Order Management Suite APIs and Open Interfaces Manual .

G_MISS_CHAR ship_method Default Value: FND_API.G_MISS_CHAR freight_terms Default Value: FND_API.G_MISS_CHAR list_type Default Value: FND_API.G_MISS_CHAR prorate Default Value: FND_API.G_MISS_CHAR list_header Default Value: FND_API.G_MISS_CHAR terms Default Value: FND_API.Business Object for Modifier Setup Application Program Interface discount_lines Default Value: FND_API.G_MISS_CHAR MODIFIER_LIST_VAL_TBL_TYPE Parameter Modifier_List_Val_Rec_ Type Usage Type Record Required Derived Optional MODIFIERS_REC_TYPE Parameter arithmetic_operator attribute1 attribute2 attribute3 attribute4 attribute5 Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional Oracle Pricing Open Interfaces 3-59 .

Business Object for Modifier Setup Application Program Interface Parameter attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 automatic_flag comments context created_by creation_date effective_period_uom end_date_active estim_accrual_rate generate_using_formula_id inventory_item_id last_updated_by last_update_date last_update_login list_header_id list_line_id list_line_type_code list_price modifier_level_code Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Number Date Varchar2 Date Number Number Number Number Date Number Number Number Varchar2 Number Varchar2 Required Derived Optional 3-60 Oracle Order Management Suite APIs and Open Interfaces Manual .

Business Object for Modifier Setup Application Program Interface Parameter number_effective_periods operand organization_id override_flag percent_price price_break_type_code price_by_formula_id primary_uom_flag print_on_invoice_flag program_application_id program_id program_update_date rebate_trxn_type_code related_item_id relationship_type_id reprice_flag request_id revision revision_date revision_reason_code start_date_active substitution_attribute substitution_context substitution_value accrual_flag pricing_group_sequence incompatibility_grp_code list_line_no Usage Type Number Number Number Varchar2 Number Varchar2 Number Varchar2 Varchar2 Number Number Date Varchar2 Number Number Varchar2 Number Varchar2 Date Varchar2 Date Varchar2 Varchar2 Varchar2 Varchar2 Number Varchar2 Varchar2 Required Derived Optional Oracle Pricing Open Interfaces 3-61 .

Business Object for Modifier Setup Application Program Interface Parameter from_rltd_modifier_id to_rltd_modifier_id rltd_modifier_grp_no rltd_modifier_grp_type pricing_phase_id product_precedence expiration_period_start_ date number_expiration_periods expiration_period_uom expiration_date estim_gl_value benefit_price_list_line_id benefit_limit charge_type_code charge_subtype_code benefit_qty benefit_uom_code accrual_conversion_rate proration_type_code return_status db_flag operation Usage Type Number Number Number Varchar2 Number Number Date Number Varchar2 Date Number Number Number Varchar2 Varchar2 Number Varchar2 Number Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional arithmetic_operator Default Value: FND_API.G_MISS_CHAR 3-62 Oracle Order Management Suite APIs and Open Interfaces Manual .G_MISS_CHAR attribute1-15 Default Value: FND_API.

G_MISS_CHAR created_by Default Value: FND_API.G_MISS_CHAR context Default Value: FND_API.G_MISS_CHAR comments Default Value: FND_API.G_MISS_DATE estim_accrual_rate Default Value: FND_API.G_MISS_NUM last_update_date Default Value: FND_API.G_MISS_DATE effective_period_uom Default Value: FND_API.G_MISS_NUM inventory_item_id Default Value: FND_API.G_MISS_NUM generate_using_formula_id Default Value: FND_API.G_MISS_DATE Oracle Pricing Open Interfaces 3-63 .G_MISS_CHAR end_date_active Default Value: FND_API.G_MISS_NUM creation_date Default Value: FND_API.Business Object for Modifier Setup Application Program Interface automatic_flag Default Value: FND_API.G_MISS_NUM last_updated_by Default Value: FND_API.

G_MISS_NUM price_break_type_code Default Value: FND_API.G_MISS_NUM list_header_id Default Value: FND_API.Business Object for Modifier Setup Application Program Interface last_update_login Default Value: FND_API.G_MISS_CHAR number_effective_periods Default Value: FND_API.G_MISS_NUM override_flag Default Value: FND_API.G_MISS_CHAR percent_price Default Value: FND_API.G_MISS_NUM operand Default Value: FND_API.G_MISS_NUM list_line_type_code Default Value: FND_API.G_MISS_NUM organization_id Default Value: FND_API.G_MISS_NUM modifier_level_code Default Value: FND_API.G_MISS_CHAR list_price Default Value: FND_API.G_MISS_CHAR 3-64 Oracle Order Management Suite APIs and Open Interfaces Manual .G_MISS_NUM list_line_id Default Value: FND_API.

G_MISS_CHAR request_id Default Value: FND_API.G_MISS_CHAR related_item_id Default Value: FND_API.G_MISS_NUM relationship_type_id Default Value: FND_API.G_MISS_NUM program_update_date Default Value: FND_API.G_MISS_CHAR program_application_id Default Value: FND_API.G_MISS_NUM reprice_flag Default Value: FND_API.G_MISS_DATE rebate_trxn_type_code Default Value: FND_API.G_MISS_NUM revision Default Value: FND_API.G_MISS_CHAR Oracle Pricing Open Interfaces 3-65 .G_MISS_NUM program_id Default Value: FND_API.Business Object for Modifier Setup Application Program Interface price_by_formula_id Default Value: FND_API.G_MISS_CHAR print_on_invoice_flag Default Value: FND_API.G_MISS_NUM primary_uom_flag Default Value: FND_API.

G_MISS_CHAR substitution_value Default Value: FND_API.G_MISS_CHAR substitution_context Default Value: FND_API.G_MISS_NUM incompatibility_grp_code Default Value: FND_API.G_MISS_CHAR from_rltd_modifier_id Default Value: FND_API.G_MISS_NUM 3-66 Oracle Order Management Suite APIs and Open Interfaces Manual .Business Object for Modifier Setup Application Program Interface revision_date Default Value: FND_API.G_MISS_DATE revision_reason_code Default Value: FND_API.G_MISS_CHAR start_date_active Default Value: FND_API.G_MISS_CHAR list_line_no Default Value: FND_API.G_MISS_CHAR accrual_flag Default Value: FND_API.G_MISS_DATE substitution_attribute Default Value: FND_API.G_MISS_CHAR pricing_group_sequence Default Value: FND_API.G_MISS_NUM to_rltd_modifier_id Default Value: FND_API.

G_MISS_NUM benefit_price_list_line_id Default Value: FND_API.G_MISS_NUM charge_type_code Default Value: FND_API.G_MISS_NUM benefit_limit Default Value: FND_API.G_MISS_NUM rltd_modifier_grp_type Default Value: FND_API.Business Object for Modifier Setup Application Program Interface rltd_modifier_grp_no Default Value: FND_API.G_MISS_CHAR pricing_phase_id Default Value: FND_API.G_MISS_NUM product_precedence Default Value: FND_API.G_MISS_CHAR Oracle Pricing Open Interfaces 3-67 .G_MISS_NUM expiration_period_start_date Default Value: FND_API.G_MISS_NUM expiration_period_uom Default Value: FND_API.G_MISS_DATE number_expiration_periods Default Value: FND_API.G_MISS_DATE estim_gl_value Default Value: FND_API.G_MISS_CHAR expiration_date Default Value: FND_API.

G_MISS_CHAR operation Default Value: FND_API.G_MISS_CHAR db_flag Default Value: FND_API.G_MISS_CHAR MODIFIERS_TBL_TYPE Parameter Modifiers_Rec_Type Usage Type Record Required Derived Optional MODIFIERS_VAL_REC_TYPE Parameter accrual_type accrual_uom automatic generate_using_formula Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional 3-68 Oracle Order Management Suite APIs and Open Interfaces Manual .G_MISS_NUM proration_type_code Default Value: FND_API.G_MISS_CHAR accrual_conversion_rate Default Value: FND_API.Business Object for Modifier Setup Application Program Interface charge_subtype_code Default Value: FND_API.G_MISS_CHAR benefit_qty Default Value: FND_API.G_MISS_NUM benefit_uom_code Default Value: FND_API.G_MISS_CHAR return_status Default Value: FND_API.

G_MISS_CHAR accrual_uom Default Value: FND_API.G_MISS_CHAR automatic Default Value: FND_API.G_MISS_CHAR Oracle Pricing Open Interfaces 3-69 .Business Object for Modifier Setup Application Program Interface Parameter gl_class inventory_item list_header list_line list_line_type list_price_uom modifier_level organization override price_break_type price_by_formula primary_uom print_on_invoice rebate_subtype rebate_transaction_type related_item relationship_type reprice revision_reason Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional accrual_type Default Value: FND_API.

G_MISS_CHAR gl_class Default Value: FND_API.G_MISS_CHAR override Default Value: FND_API.G_MISS_CHAR list_line Default Value: FND_API.Business Object for Modifier Setup Application Program Interface generate_using_formula Default Value: FND_API.G_MISS_CHAR list_price_uom Default Value: FND_API.G_MISS_CHAR price_break_type Default Value: FND_API.G_MISS_CHAR list_line_type Default Value: FND_API.G_MISS_CHAR list_header Default Value: FND_API.G_MISS_CHAR modifier_level Default Value: FND_API.G_MISS_CHAR inventory_item Default Value: FND_API.G_MISS_CHAR 3-70 Oracle Order Management Suite APIs and Open Interfaces Manual .G_MISS_CHAR organization Default Value: FND_API.G_MISS_CHAR price_by_formula Default Value: FND_API.

G_MISS_CHAR related_item Default Value: FND_API.G_MISS_CHAR relationship_type Default Value: FND_API.G_MISS_CHAR revision_reason Default Value: FND_API.G_MISS_CHAR rebate_subtype Default Value: FND_API.G_MISS_CHAR print_on_invoice Default Value: FND_API.G_MISS_CHAR MODIFIERS_VAL_TBL_TYPE Parameter Modifiers_Val_Rec_Type Usage Type Record Required Derived Optional QUALIFIERS_REC_TYPE Parameter attribute1 attribute2 attribute3 attribute4 Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional Oracle Pricing Open Interfaces 3-71 .G_MISS_CHAR reprice Default Value: FND_API.G_MISS_CHAR rebate_transaction_type Default Value: FND_API.Business Object for Modifier Setup Application Program Interface primary_uom Default Value: FND_API.

Business Object for Modifier Setup Application Program Interface Parameter attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 comparison_operator_code context created_by created_from_rule_id creation_date end_date_active excluder_flag last_updated_by last_update_date last_update_login list_header_id list_line_id program_application_id program_id program_update_date qualifier_attribute qualifier_attr_value Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Number Number Date Date Varchar2 Number Date Number Number Number Number Number Date Varchar2 Varchar2 Required Derived Optional 3-72 Oracle Order Management Suite APIs and Open Interfaces Manual .

G_MISS_CHAR context Default Value: FND_API.G_MISS_CHAR created_by Default Value: FND_API.G_MISS_NUM creation_date Default Value: FND_API.G_MISS_NUM created_from_rule_id Default Value: FND_API.G_MISS_DATE excluder_flag Default Value: FND_API.Business Object for Modifier Setup Application Program Interface Parameter qualifier_context qualifier_grouping_no qualifier_id qualifier_rule_id request_id start_date_active return_status db_flag operation Usage Type Varchar2 Number Number Number Number Date Varchar2 Varchar2 Varchar2 Required Derived Optional attribute1-15 Default Value: FND_API.G_MISS_CHAR Oracle Pricing Open Interfaces 3-73 .G_MISS_DATE end_date_active Default Value: FND_API.G_MISS_CHAR comparison_operator_code Default Value: FND_API.

G_MISS_NUM list_header_id Default Value: FND_API.G_MISS_NUM program_application_id Default Value: FND_API.G_MISS_NUM last_update_date Default Value: FND_API.G_MISS_NUM list_line_id Default Value: FND_API.G_MISS_CHAR qualifier_grouping_no Default Value: FND_API.Business Object for Modifier Setup Application Program Interface last_updated_by Default Value: FND_API.G_MISS_DATE qualifier_attribute Default Value: FND_API.G_MISS_NUM program_update_date Default Value: FND_API.G_MISS_DATE last_update_login Default Value: FND_API.G_MISS_NUM 3-74 Oracle Order Management Suite APIs and Open Interfaces Manual .G_MISS_NUM program_id Default Value: FND_API.G_MISS_CHAR qualifier_context Default Value: FND_API.G_MISS_CHAR qualifier_attr_value Default Value: FND_API.

G_MISS_CHAR db_flag Default Value: FND_API.G_MISS_NUM qualifier_rule_id Default Value: FND_API.G_MISS_DATE return_status Default Value: FND_API.G_MISS_NUM request_id Default Value: FND_API.G_MISS_CHAR QUALIFIERS_TBL_TYPE Parameter Qualifiers_Rec_Type Usage Type Record Required Derived Optional QUALIFIERS_VAL_REC_TYPE Parameter comparison_operator created_from_rule excluder list_header list_line qualifier Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional Oracle Pricing Open Interfaces 3-75 .G_MISS_NUM start_date_active Default Value: FND_API.Business Object for Modifier Setup Application Program Interface qualifier_id Default Value: FND_API.G_MISS_CHAR operation Default Value: FND_API.

Business Object for Modifier Setup Application Program Interface Parameter qualifier_rule Usage Type Varchar2 Required Derived Optional comparison_operator Default Value: FND_API.G_MISS_CHAR created_from_rule Default Value: FND_API.G_MISS_CHAR list_header Default Value: FND_API.G_MISS_CHAR QUALIFIERS_VAL_TBL_TYPE Parameter Qualifiers_Val_Rec_Type Usage Type Record Required Derived Optional PRICING_ATTR_REC_TYPE Parameter accumulate_flag attribute1 attribute2 Usage Type Varchar2 Varchar2 Varchar2 Required Derived Optional 3-76 Oracle Order Management Suite APIs and Open Interfaces Manual .G_MISS_CHAR list_line Default Value: FND_API.G_MISS_CHAR excluder Default Value: FND_API.G_MISS_CHAR qualifier_rule Default Value: FND_API.G_MISS_CHAR qualifier Default Value: FND_API.

Business Object for Modifier Setup Application Program Interface Parameter attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 attribute_grouping_no context created_by creation_date excluder_flag last_updated_by last_update_date last_update_login list_line_id pricing_attribute pricing_attribute_context pricing_attribute_id pricing_attr_value_from pricing_attr_value_to product_attribute Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Number Varchar2 Number Date Varchar2 Number Date Number Number Varchar2 Varchar2 Number Varchar2 Varchar2 Varchar2 Required Derived Optional Oracle Pricing Open Interfaces 3-77 .

G_MISS_CHAR attribute1-15 Default Value: FND_API.G_MISS_NUM creation_date Default Value: FND_API.G_MISS_DATE 3-78 Oracle Order Management Suite APIs and Open Interfaces Manual .Business Object for Modifier Setup Application Program Interface Parameter product_attribute_context product_attr_value product_uom_code program_application_id program_id program_update_date product_attribute_datatype pricing_attribute_datatype comparison_operator_code request_id return_status db_flag operation MODIFIERS_index Usage Type Varchar2 Varchar2 Varchar2 Number Number Date Varchar2 Varchar2 Varchar2 Number Varchar2 Varchar2 Varchar2 Number Required Derived Optional accumulate_flag Default Value: FND_API.G_MISS_NUM context Default Value: FND_API.G_MISS_CHAR attribute_grouping_no Default Value: FND_API.G_MISS_CHAR created_by Default Value: FND_API.

G_MISS_CHAR Oracle Pricing Open Interfaces 3-79 .G_MISS_CHAR pricing_attr_value_to Default Value: FND_API.G_MISS_DATE last_update_login Default Value: FND_API.G_MISS_NUM last_update_date Default Value: FND_API.G_MISS_CHAR product_attribute_context Default Value: FND_API.G_MISS_NUM pricing_attr_value_from Default Value: FND_API.G_MISS_CHAR last_updated_by Default Value: FND_API.G_MISS_NUM list_line_id Default Value: FND_API.G_MISS_NUM pricing_attribute Default Value: FND_API.Business Object for Modifier Setup Application Program Interface excluder_flag Default Value: FND_API.G_MISS_CHAR pricing_attribute_id Default Value: FND_API.G_MISS_CHAR product_attribute Default Value: FND_API.G_MISS_CHAR pricing_attribute_context Default Value: FND_API.

Business Object for Modifier Setup Application Program Interface product_attr_value Default Value: FND_API.G_MISS_CHAR request_id Default Value: FND_API.G_MISS_CHAR db_flag Default Value: FND_API.G_MISS_NUM program_update_date Default Value: FND_API.G_MISS_CHAR comparison_operator_code Default Value: FND_API.G_MISS_CHAR program_application_id Default Value: FND_API.G_MISS_CHAR operation Default Value: FND_API.G_MISS_CHAR product_uom_code Default Value: FND_API.G_MISS_CHAR 3-80 Oracle Order Management Suite APIs and Open Interfaces Manual .G_MISS_NUM return_status Default Value: FND_API.G_MISS_DATE product_attribute_datatype Default Value: FND_API.G_MISS_NUM program_id Default Value: FND_API.G_MISS_CHAR pricing_attribute_datatype Default Value: FND_API.

G_MISS_CHAR product_uom Default Value: FND_API.G_MISS_NUM PRICING_ATTR_TBL_TYPE Parameter Pricing_Attr_Rec_Type Usage Type Record Required Derived Optional PRICING_ATTR_VAL_REC_TYPE Parameter accumulate excluder list_line pricing_attribute product_uom Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional accumulate Default Value: FND_API.G_MISS_CHAR pricing_attribute Default Value: FND_API.G_MISS_CHAR Oracle Pricing Open Interfaces 3-81 .G_MISS_CHAR list_line Default Value: FND_API.G_MISS_CHAR excluder Default Value: FND_API.Business Object for Modifier Setup Application Program Interface MODIFIERS_index Default Value: FND_API.

For specific information on the data implied by these columns. Other Validation None Error Handling If any validation fails. see your Oracle Pricing Technical Reference Manual for details. The Business Object for Modifier Setup API processes the rows and reports the following values for every record. the API will return error status to the calling module. Condition Success Failure PROCESS_STATIS 5 4 ERROR_MESSAGE null actual error message See Also Oracle Pricing Technical Reference Manual 3-82 Oracle Order Management Suite APIs and Open Interfaces Manual .Business Object for Modifier Setup Application Program Interface PRICING_ATTR_VAL_TBL_TYPE Parameter Pricing_Attr_Val_Rec_ Type Usage Type Record Required Derived Optional Validation of Business Object for Modifier Setup API Standard Validation Oracle Pricing validates all required columns in the Business Object for Modifier Setup API.

Copy_Qualifier_Rules: Creates a new qualifier rule with the name in p_to_qualifier_ rule. n n n n n n n n n n n Oracle Pricing Open Interfaces 3-83 . Returns qualifier rule ID for the new qualifier rule.Qualifiers Application Program Interface Qualifiers Application Program Interface This section explains how to use the Qualifiers API and how it functions in Oracle Pricing. Get_Qualifier_Rules: Retrieves the qualifier rule and qualifiers for a given qualifier rule ID or qualifier rule name. and deletes pricing qualifier rules and pricing qualifiers belonging to those rules. Qualifiers API Features The Qualifiers package consists of entities to set up qualifiers. Lock_Qualifier_Rules: Locks table rows. Also. Functional Overview The Qualifiers package QP_QUALIFIERS_RULES_PUB contains the following APIs and record type definitions: n Qualifier_Rules_Rec_Type Qualifier_Rules_Tbl_Type Qualifier_Rules_Val_Rec_Type Qualifier_Rules_Val_Tbl_Type Qualifiers_Rec_Type Qualifiers_Tbl_Type Qualifiers_Val_Rec_Type Qualifiers_Val_Tbl_Type Process_Qualifier_Rules: Creates. updates. copies the qualifiers belonging to the qualifier rule specified by the qualifier rule in p_qualifier_rule or the qualifier rule ID in p_qualifier_rule_id into a new qualifier rule.

Qualifiers Application Program Interface Setting Up the Qualifiers API Parameter Descriptions The following chart describes all parameters used by the public Qualifiers. QUALIFIER_RULES_REC_TYPE Parameter attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 context created_by creation_date description last_updated_by last_update_date Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Number Date Varchar2 Number Date Required Derived Optional 3-84 Oracle Order Management Suite APIs and Open Interfaces Manual . Additional information on these parameters may follow. All of the inbound and outbound parameters are listed.

Qualifiers Application Program Interface Parameter last_update_login name program_application_id program_id program_update_date qualifier_rule_id request_id return_status db_flag operation Usage Type Number Varchar2 Number Number Date Number Number Varchar2 Varchar2 Varchar2 Required Derived Optional attribute1-15 Default Value: FND_API.G_MISS_NUM creation_date Default Value: FND_API.G_MISS_DATE Oracle Pricing Open Interfaces 3-85 .G_MISS_CHAR created_by Default Value: FND_API.G_MISS_NUM last_update_date Default Value: FND_API.G_MISS_CHAR last_updated_by Default Value: FND_API.G_MISS_DATE description Default Value: FND_API.G_MISS_CHAR context Default Value: FND_API.

G_MISS_NUM program_update_date Default Value: FND_API.G_MISS_DATE qualifier_rule_id Default Value: FND_API.G_MISS_CHAR operation Default Value: FND_API.Qualifiers Application Program Interface last_update_login Default Value: FND_API.G_MISS_CHAR QUALIFIER_RULES_TBL_TYPE Parameter Qualifier_Rules_Rec_Type Usage Type Record Required Derived Optional 3-86 Oracle Order Management Suite APIs and Open Interfaces Manual .G_MISS_CHAR db_flag Default Value: FND_API.G_MISS_CHAR program_application_id Default Value: FND_API.G_MISS_NUM name Default Value: FND_API.G_MISS_NUM program_id Default Value: FND_API.G_MISS_NUM request_id Default Value: FND_API.G_MISS_NUM return_status Default Value: FND_API.

Qualifiers Application Program Interface QUALIFIER_RULES_VAL_REC_TYPE Parameter qualifier_rule Usage Type Varchar2 Required Derived Optional qualifier_rule Default Value: FND_API.G_MISS_CHAR QUALIFIER_RULES_VAL_TBL_TYPE Parameter Qualifier_Rules_Val_Rec_ Type Usage Type Record Required Derived Optional QUALIFIERS_REC_TYPE Parameter attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 comparison_operator_code Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional Oracle Pricing Open Interfaces 3-87 .

Qualifiers Application Program Interface Parameter context created_by created_from_rule_id creation_date end_date_active excluder_flag last_updated_by last_update_date last_update_login list_header_id list_line_id program_application_id program_id program_update_date qualifier_attribute qualifier_attr_value qualifier_attr_value_to qualifier_context qualifier_datatype qualifier_grouping_no qualifier_id qualifier_precedence qualifier_rule_id request_id start_date_active return_status db_flag operation Usage Type Varchar2 Number Number Date Date Varchar2 Number Date Number Number Number Number Number Date Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Number Number Number Number Number Date Varchar2 Varchar2 Varchar2 Required Derived Optional 3-88 Oracle Order Management Suite APIs and Open Interfaces Manual .

G_MISS_DATE excluder_flag Default Value: FND_API.G_MISS_CHAR last_updated_by Default Value: FND_API.G_MISS_NUM last_update_date Default Value: FND_API.G_MISS_NUM creation_date Default Value: FND_API.G_MISS_DATE last_update_login Default Value: FND_API.G_MISS_CHAR created_by Default Value: FND_API.G_MISS_CHAR context Default Value: FND_API.Qualifiers Application Program Interface attribute1-15 Default Value: FND_API.G_MISS_NUM Oracle Pricing Open Interfaces 3-89 .G_MISS_CHAR comparison_operator_code Default Value: FND_API.G_MISS_NUM list_header_id Default Value: FND_API.G_MISS_NUM created_from_rule_id Default Value: FND_API.G_MISS_DATE end_date_active Default Value: FND_API.

G_MISS_NUM program_application_id Default Value: FND_API.G_MISS_CHAR qualifier_attr_value_to Default Value: FND_API.G_MISS_DATE qualifier_attribute Default Value: FND_API.G_MISS_NUM qualifier_id Default Value: FND_API.G_MISS_CHAR qualifier_datatype Default Value: FND_API.G_MISS_CHAR qualifier_context Default Value: FND_API.G_MISS_NUM program_update_date Default Value: FND_API.G_MISS_CHAR qualifier_grouping_no Default Value: FND_API.G_MISS_CHAR qualifier_attr_value Default Value: FND_API.G_MISS_NUM qualifier_precedence Default Value: FND_API.Qualifiers Application Program Interface list_line_id Default Value: FND_API.G_MISS_NUM program_id Default Value: FND_API.G_MISS_NUM 3-90 Oracle Order Management Suite APIs and Open Interfaces Manual .

G_MISS_CHAR list_header Default Value: FND_API.Qualifiers Application Program Interface qualifier_rule_id Default Value: FND_API.G_MISS_CHAR operation Default Value: FND_API.G_MISS_CHAR QUALIFIERS_TBL_TYPE Parameter Qualifiers_Rec_Type Usage Type Record Required Derived Optional QUALIFIER_VAL_REC_TYPE Parameter created_from_rule list_header list_line qualifier_rule Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional created_from_rule Default Value: FND_API.G_MISS_CHAR Oracle Pricing Open Interfaces 3-91 .G_MISS_DATE return_status Default Value: FND_API.G_MISS_NUM request_id Default Value: FND_API.G_MISS_CHAR db_flag Default Value: FND_API.G_MISS_NUM start_date_active Default Value: FND_API.

G_MISS_CHAR qualifier_rule Default Value: FND_API.Qualifiers Application Program Interface list_line Default Value: FND_API.G_MISS_CHAR QUALIFIERS_VAL_TBL_TYPE Parameter Qualifiers_Val_Rec_Type Usage Type Record Required Derived Optional PROCESS_QUALIFIER_RULES Parameter p_api_version_number p_init_msg_list p_return_values p_commit x_return_status x_msg_count x_msg_data p_QUALIFIER_RULES_ rec p_QUALIFIER_RULES_ val_rec p_QUALIFIERS_tbl p_QUALIFIERS_val_tbl x_QUALIFIER_RULES_ rec x_QUALIFIER_RULES_ val_rec x_QUALIFIERS_tbl Usage In In In In Out Out Out In In In In Out Out Out Type Number Varchar2 Varchar2 Varchar2 Varchar2 Number Varchar2 Qualifier_Rules_ Rec_Type Qualifier_Rules_ Val_Rec_Type Qualifiers_Tbl_ Type Qualifiers_Val_ Tbl_Type Qualifier_Rules_ Rec_Type Qualifier_Rules_ Val_Rec_Type Qualifiers_Tbl_ Type Required Derived Optional 3-92 Oracle Order Management Suite APIs and Open Interfaces Manual .

G_FALSE p_return_values Default Value: FND_API.G_OPR_DELETE QP_GLOBALS.G_OPR_CREATE QP_GLOBALS.operation are: n QP_GLOBALS.G_FALSE p_commit Default Value: FND_API. Allowable values of P_QUALIFIER_RULES_rec.G_OPR_NONE n n n n Default Value: G_MISS_QUALIFIER_RULES_REC p_QUALIFIER_RULES_val_rec Default Value: G_MISS_QUALIFIER_RULES_VAL_REC p_QUALIFIERS_tbl Default Value: G_MISS_QUALIFIERS_TBL p_QUALIFIERS_val_tbl Default Value: G_MISS_QUALIFIERS_VAL_TBL Oracle Pricing Open Interfaces 3-93 .G_OPR_UPDATE QP_GLOBALS.operation states the operation that the process should perform.Qualifiers Application Program Interface Parameter x_QUALIFIERS_val_tbl Usage Out Type Qualifiers_Val_ Tbl_Type Required Derived Optional p_init_msg_list Default Value: FND_API.G_FALSE p_QUALIFIER_RULES_rec In this procedure. P_QUALIFIER_RULES_rec.G_OPR_LOCK QP_GLOBALS.

Qualifiers Application Program Interface LOCK_QUALIFIER_RULES Parameter p_api_version_number p_init_msg_list p_return_values x_return_status x_msg_count x_msg_data p_QUALIFIER_RULES_ rec p_QUALIFIER_RULES_ val_rec p_QUALIFIERS_tbl p_QUALIFIERS_val_tbl x_QUALIFIER_RULES_ rec x_QUALIFIER_RULES_ val_rec x_QUALIFIERS_tbl x_QUALIFIERS_val_tbl Usage In In In Out Out Out In In In In Out Out Out Out Type Number Varchar2 Varchar2 Varchar2 Number Varchar2 Qualifier_Rules_ Rec_Type Qualifier_Rules_ Val_Rec_Type Qualifiers_Tbl_ Type Qualifiers_Val_ Tbl_Type Qualifier_Rules_ Rec_Type Qualifier_Rules_ Val_Rec_Type Qualifiers_Tbl_ Type Qualifiers_Val_ Tbl_Type Required Derived Optional p_init_msg_list Default Value: FND_API.G_FALSE p_return_values Default Value: FND_API.G_FALSE p_QUALIFIER_RULES_rec Default Value: G_MISS_QUALIFIER_RULES_REC 3-94 Oracle Order Management Suite APIs and Open Interfaces Manual .

Qualifiers Application Program Interface p_QUALIFIER_RULES_val_rec Default Value: G_MISS_QUALIFIER_RULES_VAL_REC p_QUALIFIERS_tbl Default Value: G_MISS_QUALIFIERS_TBL p_QUALIFIERS_val_tbl Default Value: G_MISS_QUALIFIERS_VAL_TBL GET_QUALIFIER_RULES Parameter p_api_version_number p_init_msg_list p_return_values x_return_status x_msg_count x_msg_data p_qualifier_rule_id p_qualifier_rule x_QUALIFIER_RULES_ rec x_QUALIFIER_RULES_ val_rec x_QUALIFIERS_tbl x_QUALIFIERS_val_tbl Usage In In In Out Out Out In In Out Out Out Out Type Number Varchar2 Varchar2 Varchar2 Number Varchar2 Number Varchar2 Qualifier_Rules_ Rec_Type Qualifier_Rules_ Val_Rec_Type Qualifiers_Tbl_ Type Qualifiers_Val_ Tbl_Type Required Derived Optional p_init_msg_list Default Value: FND_API.G_FALSE Oracle Pricing Open Interfaces 3-95 .G_FALSE p_return_values Default Value: FND_API.

G_FALSE p_return_values Default Value: FND_API.G_MISS_NUM p_qualifier_rule Default Value: FND_API.G_MISS_NUM 3-96 Oracle Order Management Suite APIs and Open Interfaces Manual .Qualifiers Application Program Interface p_qualifier_rule_id Default Value: FND_API.G_FALSE p_commit Default Value: FND_API.G_MISS_CHAR COPY_QUALIFIER_RULES Parameter p_api_version_number p_init_msg_list p_return_values p_commit x_return_status x_msg_count x_msg_data p_qualifier_rule_id p_qualifier_rule p_to_qualifier_rule p_to_description x_qualifier_rule_id Usage In In In In Out Out Out In In In In Out Type Number Varchar2 Varchar2 Varchar2 Varchar2 Number Varchar2 Number Varchar2 Varchar2 Varchar2 Number Required Derived Optional p_init_msg_list Default Value: FND_API.G_FALSE p_qualifier_rule_id Default Value: FND_API.

G_MISS_CHAR Validation of Qualifiers API Standard Validation Oracle Pricing validates all required columns in the Qualifiers API. Condition Success Failure PROCESS_STATIS 5 4 ERROR_MESSAGE null actual error message See Also Oracle Pricing Technical Reference Manual Oracle Pricing Open Interfaces 3-97 . Other Validation None Error Handling If any validation fails. the API will return error status to the calling module. see your Oracle Pricing Technical Reference Manual for details.Qualifiers Application Program Interface p_qualifier_rule Default Value: FND_API. The Qualifiers API processes the rows and reports the following values for every record.G_MISS_CHAR p_to_description Default Value: FND_API. For specific information on the data implied by these columns.

The output of the API is a PL/SQL table with each record having the context name. Functional Overview The package QP_ATTR_MAPPING_PUB contains the following APIs and record type definitions: n Build_Contexts: Binds values to the attributes of the qualifier and pricing dimensions for pricing requests. The calling application must populate the global records that referenced in the sourcing rules. The pricing engine uses the output to build the pricing request structure.Attribute Mapping Application Program Interface Attribute Mapping Application Program Interface This section explains how to use the X API and how it functions in Oracle Pricing. n n n n n n n Setting Up the Attribute Mapping API Parameter Descriptions The following chart describes all parameters used by the public Attribute Mapping. Update_Attribute_Mapping_Rule: Populates sourcing rule data. Delete_Attrib_Mapping_Rule: Populates sourcing rule data. Delete_Condition: Populates sourcing rule data. All of the inbound and outbound parameters are listed. 3-98 Oracle Order Management Suite APIs and Open Interfaces Manual . Attribute Mapping API Features The Attribute Mapping package consists of entities to map attributes. Add_Src_System_To_Condition: Populates sourcing rule data. Add_Attrib_Mapping_Rule: Populates sourcing rule data. The API processes one record with each call. and attribute value. attribute name. Additional information on these parameters may follow. n Contexts_Result_Tbl_Type Contexts_Result_Rec_Type Add_Condition: Populates sourcing rule data.

Allowable values are: n L (Line): The process builds the pricing contexts based on the rules associated with the line pricing attributes entity and builds the qualifier contexts based on the rules associated with the line qualifier attribute H (Header): The process builds the pricing contexts based on the rules associated with the header pricing attributes entity and builds the qualifier contexts based on the rules associated with the header qualifier attributes.Attribute Mapping Application Program Interface BUILD_CONTEXTS Parameter p_request_type_code p_pricing_type x_price_contexts_result_tbl Usage In In Out Type Varchar2 Varchar2 CONTEXTS_ RESULT_TBL_ TYPE CONTEXTS_ RESULT_TBL_ TYPE Required Derived Optional x_qual_contexts_result_tbl Out p_request_type_code An allowable value from the QP_PRICING_REQ_SOURCES table. For example. groups of source system codes form a request type. the process sources all contexts for both I-marketing and I-store source systems. CRM request type code can have the I-marketing and I-store source system codes associated with it (using QP_PRICING_REQ_SOURCES). This is different from source system code. When you call Build_ Contexts with the CRM request type. p_pricing_type Indicates the sourcing rules to use when building the attributes. n CONTEXTS_RESULT_TABLE_TYPE Parameter Contexts_Result_Tbl_Type Usage Type Record Required Derived Optional Oracle Pricing Open Interfaces 3-99 .

A combination of the source system code and the context name.Attribute Mapping Application Program Interface CONTEXTS_RESULT_REC_TYPE Parameter context_name attribute_name attribute_value Usage Type Varchar2 Varchar2 Varchar2 Required Derived Optional ADD_CONDITION Parameter p_context_name p_condition_name p_condition_descr p_context_type p_pricing_type p_src_sys_code Usage In In In In In In Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional p_context_name A context name set up in the flexfield definition. p_condition_name Unique condition name. for example. p_context_type Allowable values: n Q: Qualifier contexts P: Pricing contexts n p_pricing_type Indicates the sourcing rules to use when building the attributes. or volume. item. customer. Allowable values are: n L (Line): The process builds the pricing contexts based on the rules associated with the line pricing attributes entity and builds the qualifier contexts based on the rules associated with the line qualifier attribute 3-100 Oracle Order Management Suite APIs and Open Interfaces Manual . for example. CRM Item.

Allowable values are: n L (Line): The process builds the pricing contexts based on the rules associated with the line pricing attributes entity and builds the qualifier contexts based on the rules associated with the line qualifier attribute H (Header): The process builds the pricing contexts based on the rules associated with the header pricing attributes entity and builds the qualifier contexts based on the rules associated with the header qualifier attributes. n p_src_sys_code An allowable source system code. ADD_SRC_SYSTEM_TO_CONDITION Parameter p_condition_name p_context_type p_pricing_type p_src_sys_code Usage In In In In Type Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional p_condition_name Unique condition name.Attribute Mapping Application Program Interface n H (Header): The process builds the pricing contexts based on the rules associated with the header pricing attributes entity and builds the qualifier contexts based on the rules associated with the header qualifier attributes. for example. p_src_sys_code An allowable source system code. p_context_type Allowable values: n Q: Qualifier contexts P: Pricing contexts n p_pricing_type Indicates the sourcing rules to use when building the attributes. Oracle Pricing Open Interfaces 3-101 . A combination of the source system code and the context name. CRM Item.

p_context_type Allowable values: n Q: Qualifier contexts P: Pricing contexts n p_pricing_type Indicates the sourcing rules to use when building the attributes. A combination of the source system code and the context name. for example.Attribute Mapping Application Program Interface DELETE_CONDITION Parameter p_context_name p_condition_name p_context_type p_pricing_type Usage In In In In Type Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional p_context_name A context name set up in the flexfield definition. customer. p_condition_name Unique condition name. item. for example. CRM Item. Allowable values are: n L (Line): The process builds the pricing contexts based on the rules associated with the line pricing attributes entity and builds the qualifier contexts based on the rules associated with the line qualifier attribute H (Header): The process builds the pricing contexts based on the rules associated with the header pricing attributes entity and builds the qualifier contexts based on the rules associated with the header qualifier attributes. n ADD_ATTRIB_MAPPING_RULE Parameter p_context_name p_condition_name p_context_type Usage In In In Type Varchar2 Varchar2 Varchar2 Required Derived Optional 3-102 Oracle Order Management Suite APIs and Open Interfaces Manual . or volume.

CRM Item. p_context_type Allowable values: n Q: Qualifier contexts P: Pricing contexts n p_pricing_type Indicates the sourcing rules to use when building the attributes. p_condition_name Unique condition name. customer. for example. Oracle Pricing Open Interfaces 3-103 . for example. Allowable values are: n L (Line): The process builds the pricing contexts based on the rules associated with the line pricing attributes entity and builds the qualifier contexts based on the rules associated with the line qualifier attribute H (Header): The process builds the pricing contexts based on the rules associated with the header pricing attributes entity and builds the qualifier contexts based on the rules associated with the header qualifier attributes. item.Attribute Mapping Application Program Interface Parameter p_pricing_type p_src_sys_code p_attribute_code p_src_type p_src_api_pkg p_src_api_fn p_other_src Usage In In In In In In In Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional p_context_name A context name set up in the flexfield definition. n p_src_sys_code An allowable source system code. A combination of the source system code and the context name. or volume.

SYSTEM: For system variables. for example. SYSDATE (system). This should be null if src_ type is not API or API_MULTIREC. API_MULTIREC: For APIs returning multiple values.Attribute Mapping Application Program Interface p_attribute_code Name of the attribute for the sourcing rule. UPDATE_ATTRIB_MAPPING_RULE Parameter p_context_name p_condition_name p_context_type p_pricing_type p_src_sys_code p_attribute_code Usage In In In In In In Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional 3-104 Oracle Order Management Suite APIs and Open Interfaces Manual . for example. CONSTANT: For constants. p_src_type Allowable values: n API: For global structures and APIs returning a single value. PROFILE_OPTION: For the profile options. for example. This should be null if src_type is not API or API_MULTIREC. PRICING_ATTRIBUTE2. n n n n p_src_api_pkg The name of the package that includes the API or global record. 10 (constant). p_src_api_fn The name of the function or global record and the field name. G_LINE_REC. for example. OE_ORDER_PUB.inventory_id (global record) or Get_Customer_Class (API). or QUALIFIER_ATTRIBUTE1. p_other_src The source value for any of the other source type. OM_UNDER_SHIPMENT_TOLERANCE (profile option). PRICING_ATTRIBUTE1.

p_attribute_code Name of the attribute for the sourcing rule. Oracle Pricing Open Interfaces 3-105 . item. or QUALIFIER_ATTRIBUTE1. A combination of the source system code and the context name. Allowable values are: n L (Line): The process builds the pricing contexts based on the rules associated with the line pricing attributes entity and builds the qualifier contexts based on the rules associated with the line qualifier attribute H (Header): The process builds the pricing contexts based on the rules associated with the header pricing attributes entity and builds the qualifier contexts based on the rules associated with the header qualifier attributes. CRM Item.Attribute Mapping Application Program Interface Parameter p_src_type p_src_api_pkg p_src_api_fn p_other_src Usage In In In In Type Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional p_context_name A context name set up in the flexfield definition. PRICING_ATTRIBUTE1. for example. customer. for example. p_condition_name Unique condition name. p_context_type Allowable values: n Q: Qualifier contexts P: Pricing contexts n p_pricing_type Indicates the sourcing rules to use when building the attributes. PRICING_ATTRIBUTE2. n p_src_sys_code An allowable source system code. or volume. for example.

or volume. 3-106 Oracle Order Management Suite APIs and Open Interfaces Manual . for example. 10 (constant). This should be null if src_ type is not API or API_MULTIREC. customer. DELETE_ATTRIB_MAPPING_RULE Parameter p_context_name p_condition_name p_context_type p_pricing_type p_src_sys_code p_attribute_code Usage In In In In In In Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional p_context_name A context name set up in the flexfield definition. for example. for example.inventory_id (global record) or Get_Customer_Class (API). API_MULTIREC: For APIs returning multiple values. p_src_api_fn The name of the function or global record and the field name. PROFILE_OPTION: For the profile options. n n n n p_src_api_pkg The name of the package that includes the API or global record.Attribute Mapping Application Program Interface p_src_type Allowable values: n API: For global structures and APIs returning a single value. OM_UNDER_SHIPMENT_TOLERANCE (profile option). SYSTEM: For system variables. G_LINE_REC. item. CONSTANT: For constants. OE_ORDER_PUB. p_other_src The source value for any of the other source type. for example. SYSDATE (system). This should be null if src_type is not API or API_MULTIREC.

A combination of the source system code and the context name. CRM Item. Other Validation None Oracle Pricing Open Interfaces 3-107 .Attribute Mapping Application Program Interface p_condition_name Unique condition name. or QUALIFIER_ATTRIBUTE1. p_attribute_code Name of the attribute for the sourcing rule. PRICING_ATTRIBUTE1. p_context_type Allowable values: n Q: Qualifier contexts P: Pricing contexts n p_pricing_type Indicates the sourcing rules to use when building the attributes. see your Oracle Pricing Technical Reference Manual for details. For specific information on the data implied by these columns. for example. Allowable values are: n L (Line): The process builds the pricing contexts based on the rules associated with the line pricing attributes entity and builds the qualifier contexts based on the rules associated with the line qualifier attribute H (Header): The process builds the pricing contexts based on the rules associated with the header pricing attributes entity and builds the qualifier contexts based on the rules associated with the header qualifier attributes. for example. n p_src_sys_code An allowable source system code. PRICING_ATTRIBUTE2. Validation of Attribute Mapping API Standard Validation Oracle Pricing validates all required columns in the Attribute Mapping API.

Attribute Mapping Application Program Interface Error Handling If any validation fails. the API will return error status to the calling module. The Attribute Mapping API processes the rows and reports the following values for every record. Condition Success Failure PROCESS_STATIS 5 4 ERROR_MESSAGE null actual error message See Also Oracle Pricing Technical Reference Manual 3-108 Oracle Order Management Suite APIs and Open Interfaces Manual .

Attach multiple qualifiers at the price list header level by giving multiple qualifiers in the p_QUALIFIERS_tbl table structure.Process_Price_List contains the following public record type and table of records entities: n Process_Price_List: QP_Price_List_PUB. You can: n Set up multiple price list lines by giving multiple price list line definitions in the p_ PRICE_LIST_LINE_tbl table structure. Price_List_Val_Rec_Type: Attributes that store the meaning of id or code columns in the price list header table QP_LIST_HEADERS_B. Use this API to insert. Price_List_Line_Val_Rec_Type: Attributes that store the meaning of id or code columns in the price list line table QP_LIST_LINES. Qualifiers_Rec_Type: Corresponds to the columns in the qualifier table QP_ QUALIFIERS. Price_List_Line_Val_Tbl_Type: Table of Price_List_Line_Val_Rec_Type. Attach multiple pricing attributes to price list lines by giving the pricing attributes in the p_PRICING_ATTR_tbl table structure. and delete price lists and to set up a price list for a given p_PRICE_LIST_rec record structure. Currency. Functional Overview The Price List Setup package QP_Price_List_PUB.Process_Price_List:. update. n n n n n n Oracle Pricing Open Interfaces 3-109 . n n n Price_List_Rec_Type: Corresponds to the columns in the price list header tables QP_ LIST_HEADERS_B and QP_LIST_HEADERS_TL. for example.Takes two record types and six table types as input parameters. for example. Price_List_Line_Tbl_Type: Table of Price_List_Line_Rec_Type. Price_By_Formula. Price_List_Line_Rec_Type: Corresponds to columns in the price list line table and related modifiers tables QP_LIST_LINES and QP_RLTD_MODIFIERS. Price List Setup API Features The Price List Setup package consists of entities to set up price lists.Price List Setup Application Program Interface Price List Setup Application Program Interface This section explains how to use the Price List Setup API and how it functions in Oracle Pricing.

PROCESS_PRICE_LIST Parameter p_api_version_number p_init_msg_list p_return_values p_commit x_return_status x_msg_count x_msg_data p_PRICE_LIST_rec p_PRICE_LIST_val_rec Usage In In In In Out Out Out In In Type Number Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Price_List_Rec_ Type Price_List_Val_ Rec_Type Required Derived Optional 3-110 Oracle Order Management Suite APIs and Open Interfaces Manual . All of the inbound and outbound parameters are listed. Qualifiers_Val_Tbl_Type: Table of Qualifiers_Val_Rec_Type. Pricing_Attr_Rec_Type: Corresponds to the columns in the pricing attributes table QP_ PRICING_ATTRIBUTES. n n n n n n Setting Up the Price List Setup API Parameter Descriptions The following chart describes all parameters used by the public Price List Setup. Qualifiers_Val_Rec_Type: Made up of attributes that store the meaning of id or code columns in the qualifiers table QP_QUALIFIERS. Pricing_Attr_Tbl_Type: Table of Pricing_Attr_Rec_Type. Pricing_Attr_Val_Rec_Type: Attributes that store the meaning of id or code columns in the pricing attributes table QP_PRICING_ATTRIBUTES. for example.Price List Setup Application Program Interface n Qualifiers_Tbl_Type: Table of Qualifiers_Rec_Type. for example. Qualifier_Rule. Pricing_Attr_Val_Tbl_Type: Table of Pricing_Attr_Val_Rec_Type. Additional information on these parameters may follow. Accumulate.

Qualifiers_ val_tbl_Type Pricing_Attr_tbl_ type Pricing_Attr_val_ tbl_type Required Derived Optional p_QUALIFIERS_val_tbl In p_PRICING_ATTR_tbl p_PRICING_ATTR_val_tbl x_PRICE_LIST_rec x_ PRICE_LIST_val_rec x_PRICE_LIST_LINE_tbl x_PRICE_LIST_LINE_ val_tbl x_QUALIFIERS_tbl In In Out Out Out Out Out x_QUALIFIERS_val_tbl Out x_PRICING_ATTR_tbl x_PRICING_ATTR_val_tbl Out In Oracle Pricing Open Interfaces 3-111 .Qualifiers_ tbl_Type QP_Qualifier_ Rules_ PUB.Price List Setup Application Program Interface Parameter p_PRICE_LIST_tbl p_PRICE_LIST_val_tbl p_QUALIFIERS_tbl Usage In In In Type Price_List_Line_ tbl_type Price_List_Line_ Val_tbl_type QP_Qualifier_ Rules_ PUB.Qualifiers_ tbl_Type QP_Qualifier_ Rules_ PUB.Qualifiers_ val_tbl_Type Pricing_Attr_tbl_ type Pricing_Attr_val_ tbl_type Price_List_Rec_ Type Price_List_Val_ Rec_Type Price_List_Line_ tbl_type Price_List_Line_ Val_tbl_type QP_Qualifier_ Rules_ PUB.

Price List Setup Application Program Interface PRICE_LIST_REC_TYPE Parameter attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 automatic_flag comments context created_by creation_date currency_code discount_lines_flag end_date_active freight_terms_code gsa_indicator last_updated_by last_update_date Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Number Date Varchar2 Varchar2 Date Varchar2 Varchar2 Number Date Required Derived Optional 3-112 Oracle Order Management Suite APIs and Open Interfaces Manual .

Price List Setup Application Program Interface Parameter last_update_login list_header_id list_type_code program_application_id program_id program_update_date prorate_flag request_id rounding_factor ship_method_code start_date_active terms_id return_status db_flag operation name description version_no Usage Type Number Number Varchar2 Number Number Date Varchar2 Number Number Varchar2 Date Number Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional PRICE_LIST_TBL_TYPE Parameter Price_List_Rec_Type Usage Type Record Required Derived Optional PRICE_LIST_VAL_REC_TYPE Parameter automatic currency discount_lines Usage Type Varchar2 Varchar2 Varchar2 Required Derived Optional Oracle Pricing Open Interfaces 3-113 .

Price List Setup Application Program Interface Parameter freight_terms list_header list_type prorate ship_method terms Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional PRICE_LIST_VAL_TBL_TYPE Parameter Price_List_Val_Rec_Type Usage Type Record Required Derived Optional PRICE_LIST_LINE_REC_TYPE Parameter accrual_qty accrual_uom_code arithmetic_operator attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 Usage Type Number Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional 3-114 Oracle Order Management Suite APIs and Open Interfaces Manual .

Price List Setup Application Program Interface Parameter attribute13 attribute14 attribute15 automatic_flag base_qty base_uom_code comments context created_by creation_date effective_period_uom end_date_active estim_accrual_rate generate_using_formula_id inventory_item_id last_updated_by last_update_date last_update_login list_header_id list_line_id list_line_type_code list_price modifier_level_code number_effective_periods operand organization_id override_flag percent_price Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Number Varchar2 Varchar2 Varchar2 Number Date Varchar2 Date Number Number Number Number Date Number Number Number Varchar2 Number Varchar2 Number Number Number Varchar2 Number Required Derived Optional Oracle Pricing Open Interfaces 3-115 .

Price List Setup Application Program Interface Parameter price_break_type_code price_by_formula_id primary_uom_flag print_on_invoice_flag program_application_id program_id program_update_date rebate_trxn_type_code related_item_id relationship_type_id reprice_flag request_id revision revision_date revision_reason_code start_date_active substitution_attribute substitution_context substitution_value return_status db_flag operation from_rltd_modifier_id rltd_modifier_group_no product_precedence Usage Type Varchar2 Number Varchar2 Varchar2 Number Number Date Varchar2 Number Number Varchar2 Number Varchar2 Date Varchar2 Date Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Number Number Number Required Derived Optional 3-116 Oracle Order Management Suite APIs and Open Interfaces Manual .

Price List Setup Application Program Interface PRICE_LIST_LINE_TBL_TYPE Parameter Price_List_Line_Rec_Type Usage Type Record Required Derived Optional PRICE_LIST_LINE_VAL_REC_TYPE Parameter accrual_uom automatic base_uom generate_using_formula inventory_item list_header list_line list_line_type modifier_level organization override price_break_type price_by_formula primary_uom print_on_invoice rebate_transaction_type related_item relationship_type reprice revision_reason Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required Derived Optional Oracle Pricing Open Interfaces 3-117 .

Parameter QP_Qualifier_Rules_ PUB. Parameter QP_Qualifier_Rules_ PUB.Qualifiers_Val_Rec_ Type Usage Type Record Required Derived Optional QUALIFIERS_VAL_TBL_TYPE Refer to the Qualifiers public API for the definition.Price List Setup Application Program Interface PRICE_LIST_LINE_VAL_TBL_TYPE Parameter Price_List_Line_Val_Rec_ Type Usage Type Record Required Derived Optional QUALIFIERS_REC_TYPE Refer to the Qualifiers public API for the definition. Parameter QP_Qualifier_Rules_ PUB. Parameter QP_Qualifier_Rules_ PUB.Qualifiers_Rec_Type Usage Type Record Required Derived Optional QUALIFIERS_TBL_TYPE Refer to the Qualifiers public API for the definition.Qualifiers_Val_Tbl_ Type Usage Type Record Required Derived Optional 3-118 Oracle Order Management Suite APIs and Open Interfaces Manual .Qualifiers_Tbl_Type Usage Type Record Required Derived Optional QUALIFIERS_VAL_REC_TYPE Refer to the Qualifiers public API for the definition.

Price List Setup Application Program Interface PRICING_ATTR_REC_TYPE Parameter accumulate_flag attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 attribute_grouping_number context created_by creation_date excluder_flag last_updated_by last_update_date last_update_login list_line_id pricing_attribute pricing_attribute_context Usage Type Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Number Varchar2 Number Date Varchar2 Number Date Number Number Varchar2 Varchar2 Required Derived Optional Oracle Pricing Open Interfaces 3-119 .

Price List Setup Application Program Interface Parameter pricing_attribute_id pricing_attr_value_from pricing_attr_value_to product_attribute product_attribute_context product_attr_value product_uom_code program_application_id program_id program_update_date request_id return_status db_flag operation PRICE_LIST_LINE_index from_rltd_modifier_id comparison_operator_code product_attribute_datatype pricing_attribute_datatype Usage Type Number Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Number Number Date Number Varchar2 Varchar2 Varchar2 Number Number Varchar2 Varchar2 Varchar2 Required Derived Optional PRICING_ATTR_TBL_TYPE Parameter Pricing_Attr_Rec_Type Usage Type Record Required Derived Optional PRICING_ATTR_VAL_REC_TYPE Parameter accumulate excluder Usage Type Varchar2 Varchar2 Required Derived Optional 3-120 Oracle Order Management Suite APIs and Open Interfaces Manual .

Price List Setup Application Program Interface Parameter list_line pricing_attribute product_uom Usage Type Varchar2 Varchar2 Varchar2 Required Derived Optional PRICING_ATTR_VAL_TBL_TYPE Parameter Pricing_Attr_Val_Rec_ Type Usage Type Record Required Derived Optional Validation of Formula Calculation API Standard Validation Oracle Pricing validates all required columns in the Price List Setup API. Other Validation None Error Handling If any validation fails. The Price List Setup API processes the rows and reports the following values for every record. see your Oracle Pricing Technical Reference Manual for details. For specific information on the data implied by these columns. the API will return error status to the calling module. Condition Success Failure PROCESS_STATIS 5 4 ERROR_MESSAGE null actual error message See Also Oracle Pricing Technical Reference Manual Oracle Pricing Open Interfaces 3-121 .

Price List Setup Application Program Interface 3-122 Oracle Order Management Suite APIs and Open Interfaces Manual .

4 Release Management Open Interface Topics covered in the Oracle Release Management Open Interface are: s Understanding the Interface Tables on page 4-2 Column Descriptions on page 4-5 RLM_INTERFACE_LINES_ALL on page 4-13 s s Release Management Open Interface 4-1 .

RLM_INTERFACE_HEADERS_ALL This table stores the header level details of the Release Management schedules. The Release Management Demand Processor uses this table to maintain a current picture of demand schedule headers. Table 4–1 RLM_INTERFACE_HEADERS_ALL Column Name HEADER_ID CUST_ADDRESS_1_EXT CUST_ADDRESS_2_EXT CUST_ADDRESS_3_EXT CUST_ADDRESS_4_EXT CUST_CITY_EXT CUST_COUNTRY_EXT CUST_COUNTY_EXT CUSTOMER_EXT CUST_NAME_EXT CUST_POSTAL_CD_EXT CUST_PROVINCE_EXT CUST_STATE_EXT CUSTOMER_ID Type NUMBER VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(30) VARCHAR2(3) VARCHAR2(25) VARCHAR2(30) VARCHAR2(20) VARCHAR2(15) VARCHAR2(10) VARCHAR2(10) NUMBER Required X X X X X X X X X X X X X X Derived Optional 4-2 Oracle Order Management Suite APIs and Open Interfaces Manual .Understanding the Interface Tables Understanding the Interface Tables Oracle Release Management uses two Oracle tables in which the Demand Processor receives data you import from other systems. it validates and converts your import data into customer demand schedules within Oracle Release Management and order lines within Oracle Order Management. It has details pertaining to the specific schedule and customer level information. s RLM_INTERFACE_HEADERS RLM_INTERFACE_LINES s When the Demand Processor receives data.

Understanding the Interface Tables

Table 4–1 RLM_INTERFACE_HEADERS_ALL
Column Name ECE_PRIMARY_ADDRESS_ID ECE_TP_LOCATION_CODE_EXT ECE_TP_TRANSLATOR_CODE EDI_CONTROL_NUM_1 EDI_CONTROL_NUM_2 EDI_CONTROL_NUM_3 EDI_TEST_INDICATOR HEADER_CONTACT_CODE_1 HEADER_CONTACT_CODE_2 HEADER_CONTACT_VALUE_1 HEADER_CONTACT_VALUE_2 HEADER_NOTE_TEXT HEADER_REF_CODE_1 HEADER_REF_CODE_2 HEADER_REF_CODE_3 HEADER_REF_VALUE_1 HEADER_REF_VALUE_2 HEADER_REF_VALUE_3 ORG_ID PROCESS_STATUS SCHEDULE_HEADER_ID SCHEDULE_TYPE SCHEDULE_TYPE_EXT SCHED_GENERATION_DATE SCHED_HORIZON_END_DATE SCHED_HORIZON_START_DATE SCHEDULE_PURPOSE Type NUMBER VARCHAR2(35) VARCHAR2(35) VARCHAR2(15) VARCHAR2(15) VARCHAR2(15) VARCHAR2(1) VARCHAR2(3) VARCHAR2(3) VARCHAR2(80) VARCHAR2(80) VARCHAR2(240) VARCHAR2(3) VARCHAR2(3) VARCHAR2(3) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) NUMBER NUMBER NUMBER VARCHAR2(30) VARCHAR2(30) DATE DATE DATE VARCHAR2(30) X X X X X X Required Derived Optional X X X X X X X X X X X X X X X X X X X X X

Release Management Open Interface 4-3

Understanding the Interface Tables

Table 4–1 RLM_INTERFACE_HEADERS_ALL
Column Name SCHEDULE_PURPOSE_EXT SCHEDULE_REFERENCE_NUM SCHEDULE_SOURCE LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY ATTRIBUTE_CATEGORY ATTRIBUTE1 ATTRIBUTE2 ATTRIBUTE3 ATTRIBUTE4 ATTRIBUTE5 ATTRIBUTE6 ATTRIBUTE7 ATTRIBUTE8 ATTRIBUTE9 ATTRIBUTE10 ATTRIBUTE11 ATTRIBUTE12 ATTRIBUTE13 ATTRIBUTE14 ATTRIBUTE15 LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID Type VARCHAR2(30) VARCHAR2(35) VARCHAR2(30) DATE NUMBER DATE NUMBER VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) NUMBER NUMBER NUMBER NUMBER X X X X X X X X X X X X X X X X X X X X X X X X Required Derived Optional X X X

4-4

Oracle Order Management Suite APIs and Open Interfaces Manual

Column Descriptions

Table 4–1 RLM_INTERFACE_HEADERS_ALL
Column Name PROGRAM_UPDATE_DATE TP_ATTRIBUTE1 TP_ATTRIBUTE2 TP_ATTRIBUTE3 TP_ATTRIBUTE4 TP_ATTRIBUTE5 TP_ATTRIBUTE6 TP_ATTRIBUTE7 TP_ATTRIBUTE8 TP_ATTRIBUTE9 TP_ATTRIBUTE10 TP_ATTRIBUTE11 TP_ATTRIBUTE12 TP_ATTRIBUTE13 TP_ATTRIBUTE14 TP_ATTRIBUTE15 TP_ATTRIBUTE_CATEGORY Type DATE VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(30) Required Derived X X X X X X X X X X X X X X X X X Optional

Column Descriptions
HEADER_ID
Sequence generated unique identifier.

Number

CUST_ADDRESS_1_EXT

VARCHAR2(35)

Customer address line 1, as sent by the customer on the N3 segment.

CUST_ADDRESS_2_EXT

VARCHAR2(35)

Customer address line 2, as sent by the customer on the N3 segment.

Release Management Open Interface 4-5

Column Descriptions

CUST_ADDRESS_3_EXT

VARCHAR2(35)

Customer address line 3, as sent by the customer on the N3 segment.

CUST_ADDRESS_4_EXT

VARCHAR2(35)

Customer address line 4, as sent by the customer on the N3 segment.

CUST_CITY_EXT
Customer address city, as sent by the customer on the N4 segment.

VARCHAR2(30)

CUST_COUNTRY_EXT
Customer country, as sent by the customer on the N4 segment.

VARCHAR2(3)

CUST_COUNTY_EXT
Customer county, as sent by the customer on the N4 segment.

VARCHAR2(25)

CUSTOMER_EXT
Trading Partner designator cross reference.

VARCHAR2(30)

CUST_NAME_EXT
Customer name, as sent by the customer in the N1 or N2 segment.

VARCHAR2(60)

CUST_POSTAL_CD_EXT

VARCHAR2(15)

Customer address postal code, as sent by the customer on the N4 segment.

CUST_PROVINCE_EXT
Customer province, as sent by the customer on the N4 segment.

VARCHAR2(10)

CUST_STATE_EXT
Customer state, as sent by the customer on the N4 segment.

VARCHAR2(10)

CUSTOMER_ID
Customer identifier. FK to RA_CUSTOMERS.

NUMBER

4-6

Oracle Order Management Suite APIs and Open Interfaces Manual

Column Descriptions

ECE_PRIMARY_ADDRESS_ID

NUMBER

Customer primary address ID; populated by e-Commerce Gateway code conversion of external trading partner location code. FK to RA_ADDRESSES.

ECE_TP_LOCATION_CODE_EXT

VARCHAR2(35)

For EDI transactions only, external trading partner location code assigned to the location in the e-Commerce Gateway common control record.

ECE_TP_TRANSLATOR_CODE

VARCHAR2(35)

For EDI transactions only, e-Commerce Gateway trading partner code assigned to the transaction in the e-Commerce Gateway common control record.

EDI_CONTROL_NUM_1

VARCHAR2(15)

EDI control number 1 (ISA) assigned by the customer’s EDI translator for audit.

EDI_CONTROL_NUM_2

VARCHAR2(15)

EDI control number 2 (GS) assigned by the customer’s EDI translator for audit.

EDI_CONTROL_NUM_3

VARCHAR2(15)

EDI control number 3 (ST) assigned by the customer’s EDI translator for audit.

EDI_TEST_INDICATOR

VARCHAR2(1)

EDI Test/Production transaction indicator (T or P), assigned by the customer ’s EDI translator. E-Commerce Gateway rules determine the handling of test transactions within the Demand Processor.

HEADER_CONTACT_CODE_1

VARCHAR2(3)

Contact code 1 included in customer’s EDI transaction (not validated).

HEADER_CONTACT_CODE_2

VARCHAR2(3)

Contact code 2 included in customer’s EDI transaction (not validated).

HEADER_CONTACT_VALUE_1

VARCHAR2(80)

Values associated with contact code 1: concatenation of name, communication code, and communication number.

Release Management Open Interface 4-7

Column Descriptions

HEADER_CONTACT_VALUE_2

VARCHAR2(80)

Values associated with contact code 2: concatenation of name, communication code, and communication number.

HEADER_NOTE_TEXT
Free form note text included in the schedule at the header level.

VARCHAR2(240)

HEADER_REF_CODE_1
Reference code 1 included in customer’s EDI transaction.

VARCHAR2(3)

HEADER_REF_CODE_2
Reference code 2 included in customer’s EDI transaction.

VARCHAR2(3)

HEADER_REF_CODE_3
Reference code 3 included in customer’s EDI transaction.

VARCHAR2(3)

HEADER_REF_VALUE_1
Value associated with reference code 1.

VARCHAR2(35)

HEADER_REF_VALUE_2
Value associated with reference code 2.

VARCHAR2(35)

HEADER_REF_VALUE_3
Value associated with reference code 3.

VARCHAR2(35)

ORG_ID
Operating unit unique ID. FK to HR_ORGANIZATION_UNITS.

NUMBER

PROCESS_STATUS
s

NUMBER

Indicates the current processing status of a record for headers with lines in error: 1=do not process 2=waiting to be processed 3=in process 4=error

s

s

s

4-8

Oracle Order Management Suite APIs and Open Interfaces Manual

Column Descriptions

s

5=processed 6='processed with error(s)'

s

SCHEDULE_HEADER_ID
Schedule header unique identifier. FK to RLM_SCHEDULE_HEADERS.

NUMBER

SCHEDULE_TYPE

VARCHAR2(30)

Schedule Type: planning, shipping or sequenced. Validated against FND_ LOOKUPS.LOOKUP_TYPE = RLM_SCHEDULE_TYPE.

SCHEDULE_TYPE_EXT

VARCHAR2(30)

External value from which RLM_SCHEDULE_TYPE was derived in EDI Gateway code conversion.

SCHED_GENERATION_DATE

DATE

Date customer generated either the schedule or the planning information on the schedule.

SCHED_HORIZON_END_DATE

DATE

Schedule horizon end date, to be derived based on demand contained within the schedule if not specified.

SCHED_HORIZON_START_DATE

DATE

Schedule horizon start date, to be derived based on demand contained within the schedule if not specified.

SCHEDULE_PURPOSE

VARCHAR2(30)

Schedule purpose code, i.e. original, replace, cancellation, etc. Validated against FND_LOOKUPS.LOOKUP_TYPE =RLM_SCHEDULE_PURPOSE

SCHEDULE_PURPOSE_EXT

VARCHAR2(30)

External value from which SCHEDULE_PURPOSE was derived in e-Commerce Gateway code conversion.

SCHEDULE_REFERENCE_NUM
Customer assigned schedule reference or release number.

VARCHAR2(35)

Release Management Open Interface 4-9

Column Descriptions

SCHEDULE_SOURCE

VARCHAR2(30)

EDI or manual transaction source for this schedule, i.e. 830, 862, 866, DELFOR, MANUAL, etc.

LAST_UPDATE_DATE
Standard Who column.

DATE

LAST_UPDATED_BY
Standard Who column.

NUMBER

CREATION_DATE
Standard Who column.

DATE

CREATED_BY
Standard Who column.

NUMBER

ATTRIBUTE_CATEGORY
Descriptive flexfield context column.

VARCHAR2(30)

ATTRIBUTE1
Descriptive flexfield segment column.

VARCHAR2(150)

ATTRIBUTE2
Descriptive flexfield segment column.

VARCHAR2(150)

ATTRIBUTE3
Descriptive flexfield segment column.

VARCHAR2(150)

ATTRIBUTE4
Descriptive flexfield segment column.

VARCHAR2(150)

ATTRIBUTE5
Descriptive flexfield segment column.

VARCHAR2(150)

4-10

Oracle Order Management Suite APIs and Open Interfaces Manual

Column Descriptions

ATTRIBUTE6
Descriptive flexfield segment column.

VARCHAR2(150)

ATTRIBUTE7
Descriptive flexfield segment column.

VARCHAR2(150)

ATTRIBUTE8
Descriptive flexfield segment column.

VARCHAR2(150)

ATTRIBUTE9
Descriptive flexfield segment column.

VARCHAR2(150)

ATTRIBUTE10
Descriptive flexfield segment column.

VARCHAR2(150)

ATTRIBUTE11
Descriptive flexfield segment column.

VARCHAR2(150)

ATTRIBUTE12
Descriptive flexfield segment column.

VARCHAR2(150)

ATTRIBUTE13
Descriptive flexfield segment column.

VARCHAR2(150)

ATTRIBUTE14
Descriptive flexfield segment column.

VARCHAR2(150)

ATTRIBUTE15
Descriptive flexfield segment column.

VARCHAR2(150)

LAST_UPDATE_LOGIN
Standard Who column.

NUMBER

REQUEST_ID
Standard Who column.

NUMBER

Release Management Open Interface 4-11

Column Descriptions

PROGRAM_APPLICATION_ID
Standard Who column.

NUMBER

PROGRAM_ID
Standard Who column.

NUMBER

PROGRAM_UPDATE_DATE
Standard Who column.

DATE

TP_ATTRIBUTE1
Trading Partner flexfield column.

VARCHAR2(150)

TP_ATTRIBUTE2
Trading Partner flexfield column.

VARCHAR2(150)

TP_ATTRIBUTE3
Trading Partner flexfield column.

VARCHAR2(150)

TP_ATTRIBUTE4
Trading Partner flexfield column.

VARCHAR2(150)

TP_ATTRIBUTE5
Trading Partner flexfield column.

VARCHAR2(150)

TP_ATTRIBUTE6
Trading Partner flexfield column.

VARCHAR2(150)

TP_ATTRIBUTE7
Trading Partner flexfield column.

VARCHAR2(150)

TP_ATTRIBUTE8
Trading Partner flexfield column.

VARCHAR2(150)

TP_ATTRIBUTE9
Trading Partner flexfield column.

VARCHAR2(150)

4-12

Oracle Order Management Suite APIs and Open Interfaces Manual

RLM_INTERFACE_LINES_ALL

TP_ATTRIBUTE10
Trading Partner flexfield column.

VARCHAR2(150)

TP_ATTRIBUTE11
Trading Partner flexfield column.

VARCHAR2(150)

TP_ATTRIBUTE12
Trading Partner flexfield column.

VARCHAR2(150)

TP_ATTRIBUTE13
Trading Partner flexfield column.

VARCHAR2(150)

TP_ATTRIBUTE14
Trading Partner flexfield column.

VARCHAR2(150)

TP_ATTRIBUTE15
Trading Partner flexfield column.

VARCHAR2(150)

TP_ATTRIBUTE_CATEGORY
Trading Partner flexfield context column.

VARCHAR2(30)

RLM_INTERFACE_LINES_ALL
This table stores the item and item detail level information associated with customer planning, shipping, or production sequenced schedules. For production sequence schedules, the item represents the feature, not the configuration. This table stores all details for scheduled items: dated demand, authorizations, and customer shipment/receipt information. It has a child relationship to RLM_ INTERFACE_HEADERS.
Table 4–2 RLM_INTERFACE_LINES_ALL
Column Name LINE_ID HEADER_ID AGREEMENT_ID Type NUMBER NUMBER NUMBER Required X X X Derived Optional

Release Management Open Interface 4-13

RLM_INTERFACE_LINES_ALL

Table 4–2 RLM_INTERFACE_LINES_ALL
Column Name ATO_DATA_TYPE BILL_TO_ADDRESS_1_EXT BILL_TO_ADDRESS_2_EXT BILL_TO_ADDRESS_3_EXT BILL_TO_ADDRESS_4_EXT BILL_TO_ADDRESS_ID INVOICE_TO_ORG_ID BILL_TO_CITY_EXT BILL_TO_COUNTRY_EXT BILL_TO_COUNTY_EXT BILL_TO_NAME_EXT BILL_TO_POSTAL_CD_EXT BILL_TO_PROVINCE_EXT BILL_TO_SITE_USE_ID BILL_TO_STATE_EXT CARRIER_ID_CODE_EXT CARRIER_QUALIFIER_EXT COMMODITY_EXT COUNTRY_OF_ORIGIN_EXT CUST_ASSEMBLY_EXT CUST_ASSIGNED_ID_EXT CUST_BILL_TO_EXT CUST_CONTRACT_NUM_EXT CUSTOMER_DOCK_CODE CUST_INTRMD_SHIP_TO_EXT CUST_ITEM_PRICE_EXT CUST_ITEM_PRICE_UOM_EXT Type VARCHAR2(30) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) NUMBER NUMBER VARCHAR2(30) VARCHAR2(3) VARCHAR2(25) VARCHAR2(60) VARCHAR2(15) VARCHAR2(10) NUMBER VARCHAR2(10) VARCHAR2(35) VARCHAR2(3) VARCHAR2(35) VARCHAR2(35) VARCHAR2(30) VARCHAR2(20) VARCHAR2(35) VARCHAR2(35) VARCHAR2(50) VARCHAR2(35) NUMBER VARCHAR2(3) Required Derived Optional X X X X X X X X X X X X X X X X X X X X X X X X X X X

4-14

Oracle Order Management Suite APIs and Open Interfaces Manual

RLM_INTERFACE_LINES_ALL

Table 4–2 RLM_INTERFACE_LINES_ALL
Column Name CUSTOMER_ITEM_REVISION CUSTOMER_JOB CUST_MANUFACTURER_EXT CUST_MODEL_NUMBER_EXT CUST_MODEL_SERIAL_NUMBER CUST_ORDER_NUM_EXT CUST_PROCESS_NUM_EXT CUST_PRODUCTION_LINE CUST_PRODUCTION_SEQ_NUM CUST_SET_NUM_EXT CUST_SHIP_FROM_ORG_EXT CUST_SHIP_TO_EXT CUST_UOM_EXT CUSTOMER_ITEM_EXT CUSTOMER_ITEM_ID REQUEST_DATE SCHEDULE_DATE DATE_TYPE_CODE DATE_TYPE_CODE_EXT DELIVERY_LEAD_TIME END_DATE_TIME EQUIPMENT_CODE_EXT EQUIPMENT_NUMBER_EXT HANDLING_CODE_EXT HAZARD_CODE_EXT HAZARD_CODE_QUAL_EXT HAZARD_DESCRIPTION_EXT Type VARCHAR2(3) VARCHAR2(50) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(50) VARCHAR2(35) VARCHAR2(35) VARCHAR2(80) VARCHAR2(35) VARCHAR2(10) VARCHAR2(50) NUMBER DATE DATE VARCHAR2(30) VARCHAR2(30) NUMBER DATE VARCHAR2(3) VARCHAR2(35) VARCHAR2(3) VARCHAR2(10) VARCHAR2(3) VARCHAR2(80) X X X X X X X X X X Required Derived Optional X X X X X X X X X X X X X X X X X

Release Management Open Interface 4-15

RLM_INTERFACE_LINES_ALL

Table 4–2 RLM_INTERFACE_LINES_ALL
Column Name IMPORT_LICENSE_DATE_EXT IMPORT_LICENSE_EXT INDUSTRY_ATTRIBUTE1 INDUSTRY_ATTRIBUTE10 INDUSTRY_ATTRIBUTE11 INDUSTRY_ATTRIBUTE12 INDUSTRY_ATTRIBUTE13 INDUSTRY_ATTRIBUTE14 INDUSTRY_ATTRIBUTE15 INDUSTRY_ATTRIBUTE2 INDUSTRY_ATTRIBUTE3 INDUSTRY_ATTRIBUTE4 INDUSTRY_ATTRIBUTE5 INDUSTRY_ATTRIBUTE6 INDUSTRY_ATTRIBUTE7 INDUSTRY_ATTRIBUTE8 INDUSTRY_ATTRIBUTE9 INDUSTRY_CONTEXT INTRMD_SHIP_TO_ID SHIP_TO_ORG_ID INTRMD_ST_ADDRESS_1_EXT INTRMD_ST_ADDRESS_2_EXT INTRMD_ST_ADDRESS_3_EXT INTRMD_ST_ADDRESS_4_EXT INTRMD_ST_CITY_EXT INTRMD_ST_COUNTRY_EXT INTRMD_ST_COUNTY_EXT Type DATE VARCHAR2(35) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(30) NUMBER NUMBER VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(30) VARCHAR2(3) VARCHAR2(25) Required Derived Optional X X X X X X X X X X X X X X X X X X X X X X X X X X X

4-16

Oracle Order Management Suite APIs and Open Interfaces Manual

RLM_INTERFACE_LINES_ALL

Table 4–2 RLM_INTERFACE_LINES_ALL
Column Name INTRMD_ST_NAME_EXT INTRMD_ST_POSTAL_CD_EXT INTRMD_ST_PROVINCE_EXT INTRMD_ST_STATE_EXT INTRMD_ST_SITE_USE_ID INVENTORY_ITEM_ID INVENTORY_ITEM_SEGMENT1 INVENTORY_ITEM_SEGMENT10 INVENTORY_ITEM_SEGMENT11 INVENTORY_ITEM_SEGMENT12 INVENTORY_ITEM_SEGMENT13 INVENTORY_ITEM_SEGMENT14 INVENTORY_ITEM_SEGMENT15 INVENTORY_ITEM_SEGMENT16 INVENTORY_ITEM_SEGMENT17 INVENTORY_ITEM_SEGMENT18 INVENTORY_ITEM_SEGMENT19 INVENTORY_ITEM_SEGMENT2 INVENTORY_ITEM_SEGMENT20 INVENTORY_ITEM_SEGMENT3 INVENTORY_ITEM_SEGMENT4 INVENTORY_ITEM_SEGMENT5 INVENTORY_ITEM_SEGMENT6 INVENTORY_ITEM_SEGMENT7 INVENTORY_ITEM_SEGMENT8 INVENTORY_ITEM_SEGMENT9 ITEM_CONTACT_CODE_1 Type VARCHAR2(60) VARCHAR2(15) VARCHAR2(10) VARCHAR2(10) NUMBER NUMBER VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(40) VARCHAR2(3) Required Derived Optional X X X X X X X X X X X X X X X X X X X X X X X X X X X

Release Management Open Interface 4-17

RLM_INTERFACE_LINES_ALL Table 4–2 RLM_INTERFACE_LINES_ALL Column Name ITEM_CONTACT_CODE_2 ITEM_CONTACT_VALUE_1 ITEM_CONTACT_VALUE_2 ITEM_DESCRIPTION_EXT ITEM_DETAIL_QUANTITY ITEM_DETAIL_REF_CODE_1 ITEM_DETAIL_REF_CODE_2 ITEM_DETAIL_REF_CODE_3 ITEM_DETAIL_REF_VALUE_1 ITEM_DETAIL_REF_VALUE_2 ITEM_DETAIL_REF_VALUE_3 ITEM_DETAIL_SUBTYPE ITEM_DETAIL_SUBTYPE_EXT ITEM_DETAIL_TYPE ITEM_DETAIL_TYPE_EXT ITEM_ENG_CNG_LVL_EXT ITEM_MEASUREMENTS_EXT ITEM_NOTE_TEXT ITEM_REF_CODE_1 ITEM_REF_CODE_2 ITEM_REF_CODE_3 ITEM_REF_VALUE_1 ITEM_REF_VALUE_2 ITEM_REF_VALUE_3 ITEM_RELEASE_STATUS_EXT LADING_QUANTITY_EXT LETTER_CREDIT_EXPDT_EXT Type VARCHAR2(3) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) NUMBER VARCHAR2(3) VARCHAR2(3) VARCHAR2(3) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(35) VARCHAR2(240) VARCHAR2(240) VARCHAR2(3) VARCHAR2(3) VARCHAR2(3) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(3) NUMBER DATE X X X X X X X X X X X X X X X X Required Derived Optional X X X X X X X X X X X 4-18 Oracle Order Management Suite APIs and Open Interfaces Manual .

RLM_INTERFACE_LINES_ALL Table 4–2 RLM_INTERFACE_LINES_ALL Column Name LETTER_CREDIT_EXT LINE_REFERENCE LINK_TO_LINE_REF ORDER_HEADER_ID ORG_ID OTHER_NAME_CODE_1 OTHER_NAME_CODE_2 OTHER_NAME_VALUE_1 OTHER_NAME_VALUE_2 PACK_SIZE_EXT PACK_UNITS_PER_PACK_EXT PACK_UOM_CODE_EXT PACKAGING_CODE_EXT PARENT_LINK_LINE_REF PRICE_LIST_ID PRIMARY_QUANTITY PRIMARY_UOM_CODE PRIME_CONTRCTR_PART_EXT PROCESS_STATUS CUST_PO_RELEASE_NUM CUST_PO_DATE CUST_PO_LINE_NUM CUST_PO_NUMBER QTY_TYPE_CODE QTY_TYPE_CODE_EXT RETURN_CONTAINER_EXT SCHEDULE_LINE_ID Type VARCHAR2(35) VARCHAR2(50) VARCHAR2(50) NUMBER NUMBER VARCHAR2(3) VARCHAR2(3) VARCHAR2(80) VARCHAR2(80) NUMBER NUMBER VARCHAR2(3) VARCHAR2(10) VARCHAR2(50) NUMBER NUMBER VARCHAR2(3) VARCHAR2(35) NUMBER VARCHAR2(35) DATE VARCHAR2(35) VARCHAR2(50) VARCHAR2(30) VARCHAR2(30) VARCHAR2(35) NUMBER X X X X Required Derived Optional X X X X X X X X X X X X X X X X X X X X X X X Release Management Open Interface 4-19 .

RLM_INTERFACE_LINES_ALL Table 4–2 RLM_INTERFACE_LINES_ALL Column Name ROUTING_DESC_EXT ROUTING_SEQ_CODE_EXT SCHEDULE_ITEM_NUM SHIP_DEL_PATTERN_EXT SHIP_DEL_TIME_CODE_EXT SHIP_DEL_RULE_NAME SHIP_FROM_ADDRESS_1_EXT SHIP_FROM_ADDRESS_2_EXT SHIP_FROM_ADDRESS_3_EXT SHIP_FROM_ADDRESS_4_EXT SHIP_FROM_CITY_EXT SHIP_FROM_COUNTRY_EXT SHIP_FROM_COUNTY_EXT SHIP_FROM_NAME_EXT SHIP_FROM_ORG_ID SHIP_FROM_POSTAL_CD_EXT SHIP_FROM_PROVINCE_EXT SHIP_FROM_STATE_EXT SHIP_LABEL_INFO_LINE_1 SHIP_LABEL_INFO_LINE_10 SHIP_LABEL_INFO_LINE_2 SHIP_LABEL_INFO_LINE_3 SHIP_LABEL_INFO_LINE_4 SHIP_LABEL_INFO_LINE_5 SHIP_LABEL_INFO_LINE_6 SHIP_LABEL_INFO_LINE_7 SHIP_LABEL_INFO_LINE_8 Type VARCHAR2(35) VARCHAR2(3) NUMBER VARCHAR2(3) VARCHAR2(3) VARCHAR2(30) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(30) VARCHAR2(3) VARCHAR2(25) VARCHAR2(60) NUMBER VARCHAR2(15) VARCHAR2(10) VARCHAR2(10) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) Required Derived Optional X X X X X X X X X X X X X X X X X X X X X X X X X X X 4-20 Oracle Order Management Suite APIs and Open Interfaces Manual .

RLM_INTERFACE_LINES_ALL Table 4–2 RLM_INTERFACE_LINES_ALL Column Name SHIP_LABEL_INFO_LINE_9 SHIP_TO_ADDRESS_1_EXT SHIP_TO_ADDRESS_2_EXT SHIP_TO_ADDRESS_3_EXT SHIP_TO_ADDRESS_4_EXT SHIP_TO_ADDRESS_ID DELIVER_TO_ORG_ID SHIP_TO_CITY_EXT SHIP_TO_COUNTRY_EXT SHIP_TO_COUNTY_EXT SHIP_TO_NAME_EXT SHIP_TO_POSTAL_CD_EXT SHIP_TO_PROVINCE_EXT SHIP_TO_SITE_USE_ID SHIP_TO_STATE_EXT START_DATE_TIME SUBLINE_ASSIGNED_ID_EXT SUBLINE_CONFIG_CODE_EXT SUBLINE_CUST_ITEM_EXT SUBLINE_CUST_ITEM_ID SUBLINE_MODEL_NUM_EXT SUBLINE_QUANTITY SUBLINE_UOM_CODE SUPPLIER_ITEM_EXT TRANSIT_TIME_EXT TRANSIT_TIME_QUAL_EXT TRANSPORT_LOC_QUAL_EXT Type VARCHAR2(80) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) NUMBER NUMBER VARCHAR2(30) VARCHAR2(3) VARCHAR2(25) VARCHAR2(60) VARCHAR2(15) VARCHAR2(10) NUMBER VARCHAR2(10) DATE VARCHAR2(20) VARCHAR2(3) VARCHAR2(50) NUMBER VARCHAR2(35) NUMBER VARCHAR2(3) VARCHAR2(35) VARCHAR2(22) VARCHAR2(3) VARCHAR2(3) Required Derived Optional X X X X X X X X X X X X X X X X X X X X X X X X X X X Release Management Open Interface 4-21 .

RLM_INTERFACE_LINES_ALL Table 4–2 RLM_INTERFACE_LINES_ALL Column Name TRANSPORT_LOCATION_EXT TRANSPORT_METHOD_EXT UOM_CODE WEIGHT_EXT WEIGHT_QUALIFIER_EXT WEIGHT_UOM_EXT FBO_CONFIGURATION_KEY_1 FBO_CONFIGURATION_KEY_2 FBO_CONFIGURATION_KEY_3 FBO_CONFIGURATION_KEY_4 FBO_CONFIGURATION_KEY_5 MATCH_KEY_ACROSS MATCH_KEY_WITHIN CRITICAL_KEY_ATTRIBUTES LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY ATTRIBUTE_CATEGORY ATTRIBUTE1 ATTRIBUTE2 ATTRIBUTE3 ATTRIBUTE4 ATTRIBUTE5 ATTRIBUTE6 ATTRIBUTE7 ATTRIBUTE8 Type VARCHAR2(35) VARCHAR2(3) VARCHAR2(3) NUMBER VARCHAR2(3) VARCHAR2(3) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(35) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) DATE NUMBER DATE NUMBER VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) X X X X X X X X X X X X X Required Derived Optional X X X X X X X X X X X X X X 4-22 Oracle Order Management Suite APIs and Open Interfaces Manual .

RLM_INTERFACE_LINES_ALL Table 4–2 RLM_INTERFACE_LINES_ALL Column Name ATTRIBUTE9 ATTRIBUTE10 ATTRIBUTE11 ATTRIBUTE12 ATTRIBUTE13 ATTRIBUTE14 ATTRIBUTE15 LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE TP_ATTRIBUTE1 TP_ATTRIBUTE2 TP_ATTRIBUTE3 TP_ATTRIBUTE4 TP_ATTRIBUTE5 TP_ATTRIBUTE6 TP_ATTRIBUTE7 TP_ATTRIBUTE8 TP_ATTRIBUTE9 TP_ATTRIBUTE10 TP_ATTRIBUTE11 TP_ATTRIBUTE12 TP_ATTRIBUTE13 TP_ATTRIBUTE14 TP_ATTRIBUTE15 Type VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) NUMBER NUMBER NUMBER NUMBER DATE VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) X X X X X X X X X X X X X X X X X X X X Required Derived Optional X X X X X X X Release Management Open Interface 4-23 .

VARCHAR2(35) BILL_TO_ADDRESS_2_EXT Bill to address line 2.LOOKUP_TYPE =RLM_ITEM_METHOD_TYPE BILL_TO_ADDRESS_1_EXT Bill to address line 1.RLM_INTERFACE_LINES_ALL Table 4–2 RLM_INTERFACE_LINES_ALL Column Name TP_ATTRIBUTE_CATEGORY LINE_NUMBER INTMED_SHIP_TO_ORG_ID LINE_SOURCE PREFERRED_GRADE Type VARCHAR2(30) NUMBER NUMBER VARCHAR2(30) VARCHAR2(4) Required Derived Optional X X X X X Column Descriptions LINE_ID Sequence generated unique identifier. FK to RA_AGREEMENTS ATO_DATA_TYPE Code to describe what type of data is included for the ATO item: s VARCHAR2(30) 1=Model and Options 2=Model 3=Options s s Validated against FND_LOOKUPS. AGREEMENT_ID NUMBER Unique identifier for agreement on which customer purchase order is associated. VARCHAR2(35) 4-24 Oracle Order Management Suite APIs and Open Interfaces Manual . as sent by the customer on the N3 segment. as sent by the customer on the N3 segment. NUMBER HEADER_ID NUMBER Sequence generated unique identifier foreign key to the RLM_INTERFACE_ HEADERS_ALL.

VARCHAR2(35) BILL_TO_ADDRESS_4_EXT Bill to address line 4. as sent by the customer on the N4 segment.RLM_INTERFACE_LINES_ALL BILL_TO_ADDRESS_3_EXT Bill to address line 3. BILL_TO_CITY_EXT Bill to address city. FK to RA_SITE_USES. VARCHAR2(3) BILL_TO_COUNTY_EXT Bill to county. VARCHAR2(10) BILL_TO_SITE_USE_ID Bill to site use identifier. as sent by the customer on the N3 segment. NUMBER Release Management Open Interface 4-25 . as sent by the customer on the N3 segment. BILL_TO_PROVINCE_EXT Bill to province. VARCHAR2(60) BILL_TO_POSTAL_CD_EXT VARCHAR2(15) Bill to address postal code. VARCHAR2(30) BILL_TO_COUNTRY_EXT Bill to country. as sent by the customer on the N4 segment. VARCHAR2(35) BILL_TO_ADDRESS_ID Bill to address identifier. FK to RA_ADDRESSES. as sent by the customer on the N4 segment. NUMBER INVOICE_TO_ORG_ID NUMBER Unique identifier for invoice-to organization which relates to BILL_TO_ADDRESS_ ID. as sent by the customer on the N4 segment. as sent by the customer in the N1 and/or N2 segment. VARCHAR2(25) BILL_TO_NAME_EXT Bill to name. as sent by the customer on the N4 segment. FK in R12 customer-org data model to HR_ORGANIZATIONS.

as sent by the customer on the N4 segment. CUST_BILL_TO_EXT External customer bill to cross reference.RLM_INTERFACE_LINES_ALL BILL_TO_STATE_EXT Bill to state. VARCHAR2(35) 4-26 Oracle Order Management Suite APIs and Open Interfaces Manual . as sent on the LIN segment of the 830 transaction. as sent by the customer on the TD5 segment. VARCHAR2(35) CARRIER_QUALIFIER_EXT The carrier qualifier. VARCHAR2(35) CUST_CONTRACT_NUM_EXT VARCHAR2(35) The customer’s contract number. VARCHAR2(35) CUST_ASSEMBLY_EXT VARCHAR2(30) The customer’s assembly identification. as sent by the customer on the TD5 segment. CUST_ASSIGNED_ID_EXT VARCHAR2(20) Customer assigned identification for differentiation within a transaction set. from LIN01. VARCHAR2(10) CARRIER_ID_CODE_EXT The carrier id. VARCHAR2(3) COMMODITY_EXT Customer specified commodity code. as sent on the LIN segment of the 866 transaction. VARCHAR2(50) CUST_INTERMD_SHIP_TO_EXT External intermediate ship to cross reference. CUSTOMER_DOCK_CODE Customer dock code. VARCHAR2(35) COUNTRY_OF_ORIGIN_EXT Customer-specified country of origin.

CUSTOMER_ITEM_REVISION Customer part revision included on schedule. as sent by the customer on the LIN segment of the 866 transaction. CUST_PRODUCTION_LINE Customer production line. as sent by the customer on the LIN segment of the 866 and 830 transaction.g. as sent by the customer on the LIN segment of the 866 and 862 transaction. CUST_PROCESS_NUM_EXT VARCHAR2(35) The process number. e. VARCHAR2(50) Release Management Open Interface 4-27 . VARCHAR2(35) CUSTOMER_JOB Customer job number. CUST_MODEL_NUMBER_EXT Customer ’s model number for this sequenced detail. VIN or Chassis ID. CUST_ORDER_NUM_EXT VARCHAR2(35) The order number. NUMBER CUST_ITEM_PRICE_UOM_EXT VARCHAR2(3) UOM corresponding to the price included on the customer’s EDI transaction. VARCHAR2(50) CUST_MANUFACTURER_EXT VARCHAR2(35) The manufacturer.RLM_INTERFACE_LINES_ALL CUST_ITEM_PRICE_EXT Price included on the customer’s EDI transaction. VARCHAR2(35) CUST_MODEL_SERIAL_NUMBER VARCHAR2(35) Customer ’s vehicle identification number for this sequenced detail.

based on whether the requirements are delivery based or ship based. Pull signal. VARCHAR2(50) CUSTOMER_ITEM_ID Customer item identifier. CUST_SHIP_FROM_ORG_EXT External inventory organization cross reference.delivery lead time if delivery based). deliver.LOOKUP_TYPE =RLM_DATE_TYPE_CODE 4-28 Oracle Order Management Suite APIs and Open Interfaces Manual . e.RLM_INTERFACE_LINES_ALL CUSTOMER_PROD_SEQ_NUM Customer production sequence number. Validated against FND_LOOKUPS. DATE DATE_TYPE_CODE VARCHAR2(30) Type of start/end date. VARCHAR2(10) CUSTOMER_ITEM_EXT External customer part number cross reference. as sent on the LIN segment of the 862 and 866 transactions. SCHEDULE_DATE Planned shipment date and time (request_date . Cumulative. NUMBER REQUEST_DATE DATE The date and time the customer wants the material delivered or shipped. VARCHAR2(350) CUST_SET_NUM_EXT VARCHAR2(35) The customer’s set number. or delivery number. VARCHAR2(80) CUST_SHIP_TO_EXT External ship to address cross reference. FK to MTL_CUSTOMER_ITEMS.g. VARCHAR2(35) CUST_UOM_EXT External customer unit of measure cross reference. ship.

VARCHAR2(3) EQUIPMENT_NUMBER_EXT VARCHAR2(35) The equipment number. HAZARD_DESCRIPTION_EXT VARCHAR2(80) Hazardous material description as sent by the customer in the TD4 segment. DATE Release Management Open Interface 4-29 . IMPORT_LICENSE_DATE_EXT Customer ’s import license date. HANDLING_CODE_EXT Special handling code as sent by the customer in the TD4 segment. This is determined by the calculate ship date routine and passed into Order Import. as sent by the customer on the TD3 segment.RLM_INTERFACE_LINES_ALL DATE_TYPE_CODE_EXT VARCHAR2(30) External value from which DATE_TYPE_CODE was derived in EDI Gateway code conversion. the difference between arrival and shipment dates. DELIVERY_LEAD_TIME NUMBER For demand lines. END_DATE_TIME Customer-specified optional end date/time. and cumulative information such as authorizations and shipped/received. based on default shipping method between the ship-from and ship-to locations. HAZARD_CODE_QUAL_EXT VARCHAR2(3) Hazardous material code qualifier as sent by the customer in the TD4 segment. applicable for flexible bucketed requirements. VARCHAR2(3) HAZARD_CODE_EXT VARCHAR2(10) Hazardous material code corresponding to the hazardous material code qualifier as sent by the customer in the TD4 segment. as sent by the customer on the TD3 segment. DATE EQUIPMENT_CODE_EXT The equipment code.

VARCHAR2(150) INDUSTRY_ATTRIBUTE11 Industry descriptive flexfield. VARCHAR2(150) INDUSTRY_ATTRIBUTE14 Industry descriptive flexfield. VARCHAR2(35) INDUSTRY_ATTR IBUTE1 Record keeping or model year. VARCHAR2(150) INDUSTRY_ATTRIBUTE12 Industry descriptive flexfield. VARCHAR2(150) INDUSTRY_ATTRIBUTE5 Industry descriptive flexfield. VARCHAR2(150) INDUSTRY_ATTRIBUTE4 Industry descriptive flexfield. VARCHAR2(150) 4-30 Oracle Order Management Suite APIs and Open Interfaces Manual . VARCHAR2(150) INDUSTRY_ATTRIBUTE10 Industry descriptive flexfield.RLM_INTERFACE_LINES_ALL IMPORT_LICENSE_EXT Customer ’s import license for shipment destination country. VARCHAR2(150) INDUSTRY_ATTRIBUTE3 Industry descriptive flexfield. VARCHAR2(150) INDUSTRY_ATTRIBUTE15 Industry descriptive flexfield. VARCHAR2(150) INDUSTRY_ATTRIBUTE2 Industry descriptive flexfield. VARCHAR2(150) INDUSTRY_ATTRIBUTE13 Industry descriptive flexfield.

FK to RA_ ADDRESSES NUMBER SHIP_TO_ORG_ID NUMBER Unique identifier for ship-to organization which relates to SHIP_TO_ADDRESS_ID if there is no intermediate ship-to address. INTRMD_ST_ADDRESS_3_EXT VARCHAR2(35) Intermediate ship to address line 3. INTRMD_ST_ADDRESS_2_EXT VARCHAR2(35) Intermediate ship to address line 2. FK in R12 customer-org data model to HR_ORGANIZATIONS. VARCHAR2(150) INDUSTRY_ATTRIBUTE7 Industry descriptive flexfield. or to INTERMEDIATE_SHIP_TO_ID if intermediate ship-to address is specified. VARCHAR2(150) INDUSTRY_ATTRIBUTE8 Industry descriptive flexfield. VARCHAR2(150) INDUSTRY_CONTEXT Industry descriptive context flexfield. as sent by the customer on the N3 segment. as sent by the customer on the N3 segment.RLM_INTERFACE_LINES_ALL INDUSTRY_ATTRIBUTE6 Industry descriptive flexfield. as sent by the customer on the N3 segment. Release Management Open Interface 4-31 . INTRMD_ST_ADDRESS_1_EXT VARCHAR2(35) Intermediate ship to address line 1. VARCHAR2(30) INTERMEDIATE_SHIP_TO_ID Customer intermediate ship-to destination unique identifier. VARCHAR2(150) INDUSTRY_ATTRIBUTE9 Industry descriptive flexfield.

NUMBER INVENTORY_ITEM_SEGMENT1 Accounting flexfield. FK to MTL_SYSTEM_ITEMS.RLM_INTERFACE_LINES_ALL INTRMD_ST_ADDRESS_4_EXT VARCHAR2(35) Intermediate ship to address line 4. INTRMD_ST_SITE_USE_ID Intermediate ship to site use identifier. as sent by the customer on the N4 segment. INTRMD_ST_COUNTRY_EXT VARCHAR2(3) Intermediate ship to country. INTRMD_ST_NAME_EXT VARCHAR2(60) Intermediate ship to name. VARCHAR2(40) 4-32 Oracle Order Management Suite APIs and Open Interfaces Manual . INTRMD_ST_PROVINCE_EXT VARCHAR2(10) Intermediate ship to province. as sent by the customer on the N4 segment. INTRMD_ST_COUNTY_EXT VARCHAR2(25) Intermediate ship to county. INTRMD_ST_CITY_EXT VARCHAR2(30) Intermediate ship to address city. as sent by the customer on the N4 segment. as sent by the customer in the N1 and/or N2 segment. NUMBER INVENTORY_ITEM_ID Inventory item identifier. as sent by the customer on the N4 segment. as sent by the customer on the N3 segment. INTRMD_ST_STATE_EXT VARCHAR2(10) Intermediate ship to state. as sent by the customer on the N4 segment. FK to RA_SITE_USES. INTRMD_ST_POSTAL_CD_EXT VARCHAR2(15) Intermediate ship to address postal code. as sent by the customer on the N4 segment.

VARCHAR2(40) INVENTORY_ITEM_SEGMENT18 Accounting flexfield.RLM_INTERFACE_LINES_ALL INVENTORY_ITEM_SEGMENT10 Accounting flexfield. VARCHAR2(40) INVENTORY_ITEM_SEGMENT11 Accounting flexfield. VARCHAR2(40) INVENTORY_ITEM_SEGMENT20 Accounting flexfield. VARCHAR2(40) INVENTORY_ITEM_SEGMENT17 Accounting flexfield. VARCHAR2(40) INVENTORY_ITEM_SEGMENT12 Accounting flexfield. VARCHAR2(40) INVENTORY_ITEM_SEGMENT16 Accounting flexfield. VARCHAR2(40) INVENTORY_ITEM_SEGMENT15 Accounting flexfield. VARCHAR2(40) INVENTORY_ITEM_SEGMENT19 Accounting flexfield. VARCHAR2(40) INVENTORY_ITEM_SEGMENT14 Accounting flexfield. VARCHAR2(40) INVENTORY_ITEM_SEGMENT2 Accounting flexfield. VARCHAR2(40) INVENTORY_ITEM_SEGMENT13 Accounting flexfield. VARCHAR2(40) Release Management Open Interface 4-33 .

RLM_INTERFACE_LINES_ALL INVENTORY_ITEM_SEGMENT3 Accounting flexfield. VARCHAR2(40) INVENTORY_ITEM_SEGMENT8 Accounting flexfield. VARCHAR2(40) INVENTORY_ITEM_SEGMENT6 Accounting flexfield. 4-34 Oracle Order Management Suite APIs and Open Interfaces Manual . VARCHAR2(40) ITEM_CONTACT_CODE_1 Contact code 1 included in customer’s EDI transaction. communication code. and communication number. VARCHAR2(40) INVENTORY_ITEM_SEGMENT9 Accounting flexfield. ITEM_CONTACT_VALUE_2 VARCHAR2(80) Values associated with contact code 2 : concatenation of name. communication code. VARCHAR2(40) INVENTORY_ITEM_SEGMENT4 Accounting flexfield. and communication number. VARCHAR2(3) ITEM_CONTACT_CODE_2 Contact code 2 included in customer’s EDI transaction. VARCHAR2(3) ITEM_CONTACT_VALUE_1 VARCHAR2(80) Values associated with contact code 1: concatenation of name. VARCHAR2(40) INVENTORY_ITEM_SEGMENT5 Accounting flexfield. VARCHAR2(40) INVENTORY_ITEM_SEGMENT7 Accounting flexfield.

If Item_Detail_Type = 4. etc. VARCHAR2(3) ITEM_DETAIL_REF_CODE_3 Reference code 3 included in customer’s EDI transaction. s NUMBER If Item_Detail_Type = 0. inventory balance.1. If Item_Detail_Type = 3. VARCHAR2(80) ITEM_DETAIL_QUANTITY Requested quantity. Release Management Open Interface 4-35 . such as ahead/behind. VARCHAR2(3) ITEM_DETAIL_REF_CODE_2 Reference code 2 included in customer’s EDI transaction. VARCHAR2(35) ITEM_DETAIL_REF_VALUE_2 Value associated with reference code 2.2. this is the shipped.RLM_INTERFACE_LINES_ALL ITEM_DESCRIPTION_EXT Item description included on schedule. If Item_Detail_Type = 5. this is the demand quantity. VARCHAR2(35) ITEM_DETAIL_REF_VALUE_3 Value associated with reference code 3. VARCHAR2(35) ITEM_DETAIL_SUBTYPE Schedule item detail row sub-type: s VARCHAR2(30) for form or forecast demand. received or cum quantity. this is a miscellaneous quantity. Bucket type associated with the demand date/quantity. VARCHAR2(3) ITEM_DETAIL_REF_VALUE_1 Value associated with reference code 1. s s s ITEM_DETAIL_REF_CODE_1 Reference code 1 included in customer’s EDI transaction. this is the authorization quantity.

ITEM_DETAIL_SUBTYPE_EXT VARCHAR2(30) External value from which ITEM_DETAIL_SUBTYPE was derived in EDI Gateway Code Conversion. the type of authorization. ITEM_REF_CODE_3 VARCHAR2(3) Reference code 3 included in customer’s EDI transaction (not validated). for shipment/receipt. s Validated against FND_LOOKUPS. ITEM_NOTE_TEXT Free form item note text included in the schedule. cumulative or last.RLM_INTERFACE_LINES_ALL s for authorizations. 2 = Forecast Demand. 4-36 Oracle Order Management Suite APIs and Open Interfaces Manual . ITEM_DETAIL_TYPE VARCHAR2(30) Schedule item detail row type: 0 = Past Due Firm1 = Firm Demand. 5 = OtherValidated against FND_LOOKUPS. ITEM_REF_CODE_2 VARCHAR2(3) Reference code 2 included in customer’s EDI transaction (not validated).LOOKUP_TYPE =RLM_DETAIL_TYPE_CODE ITEM_DETAIL_TYPE_EXT VARCHAR2(30) External value from which ITEM_DETAIL_TYPE was derived in EDI Gateway Code Conversion. 4 = Shipment/Receipt Info. 3 = Authorization. VARCHAR2(240) ITEM_REF_CODE_1 VARCHAR2(3) Reference code 1 included in customer’s EDI transaction (not validated). ITEM_ENG_CNG_LVL_EXT Customer part engineering change level included on schedule VARCHAR2(35) ITEM_MEASUREMENTS_EXT VARCHAR2(240) Item measurement information as sent by the customer on the MEA segments.

VARCHAR2(35) ITEM_REF_VALUE_2 Value associated with reference code 2. DATE LETTER_CREDIT_EXT VARCHAR2(35) Customerís letter of credit with international bank guaranteeing payment for international shipments. NUMBER Release Management Open Interface 4-37 . VARCHAR2(50) LINK_TO_LINE_REF VARCHAR2(50) Link to Immediate Parent_line_reference within an order for a transmission identifier. FK to OE_ORDER_HEADERS. ORDER_HEADER_ID Order header identifier. NUMBER ORG_ID Operating unit unique id. NUMBER LETTER_CREDIT_EXPDT_EXT Customerís letter of credit expiration date.RLM_INTERFACE_LINES_ALL ITEM_REF_VALUE_1 Value associated with reference code 1. LINE_REFERENCE Unique line identifier within an order for a transmission identifier. VARCHAR2(3) LADING_QUANTITY_EXT The lading quantity as sent by the customer on the TD1 segment. VARCHAR2(35) ITEM_RELEASE_STATUS_EXT Customer part release status included on schedule. VARCHAR2(35) ITEM_REF_VALUE_3 Value associated with reference code 3. FK to HR_ORGANIZATION_UNITS.

and number. OTHER_NAME_CODE_2 VARCHAR2(3) Other name code 2 included in customer’s EDI transaction (not validated). code. PACK_SIZE_EXT NUMBER Size of supplier units in pack. PACK_UNITS_PER_PACK_EXT NUMBER Number of inner pack units per out pack unit.RLM_INTERFACE_LINES_ALL OTHER_NAME_CODE_1 VARCHAR2(3) Other name code 1 included in customer’s EDI transaction (not validated). VARCHAR2(10) PARENT_LINK_LINE_REF VARCHAR2(50) Line reference of top model for a transmission identifier for an order. code. FK to RA_PRICE_LISTS 4-38 Oracle Order Management Suite APIs and Open Interfaces Manual . and number. OTHER_NAME_VALUE_1 VARCHAR2(80) Values associated with other name code 1: concatenation of name. OTHER_NAME_VALUE_2 VARCHAR2(80) Values associated with other name code 2: concatenation of name. as sent by the customer in the PO4 segment. as sent by the customer on the PO4 segment. as sent by the customer on the PO4 segment. PACKAGING_CODE_EXT The packaging code as sent by the customer on TD1 segment. PACK_UOM_CODE_EXT VARCHAR2(3) Unit of measure of supplier units in the pack. PRICE_LIST_ID NUMBER Unique identifier for price list associated with customer item or agreement on which customer purchase order is associated.

CUST_PO_NUMBER Customer purchase order number. PROCESS_STATUS Indicates the current processing status of a record s NUMBER 1=do not process 2=waiting to be processed 3=in process 4=error 5=processed 6="processed with error(s)" for headers with lines in-error s s s s s CUST_PO_RELEASE_NUM Customer purchase order release number included on schedule. VARCHAR2(35) CUST_PO_DATE Customer purchase order line number included on schedule. as sent by the customer on the LIN segment of the 862 segment. FK to MTL_UNITS_OF_MEASURE VARCHAR2(3) PRIME_CONTRCTR_PART_EXT VARCHAR2(35) The prime contractor part number. NUMBER PRIMARY_UOM_CODE Primary unit of measure.RLM_INTERFACE_LINES_ALL PRIMARY_QUANTITY Quantity in the primary UOM. DATE CUST_PO_LINE_NUM VARCHAR2(35) Customer-specified effectivity date of purchase order number included on schedule. VARCHAR2(50) Release Management Open Interface 4-39 .

For sequenced schedules. and pass or fail validation as a group. except for aggregated schedule lines. ROUTING_DESC_EXT VARCHAR2(35) The routing description. For EDI planning and shipping schedules. Validated against FND_LOOKUPS. RETURN_CONTAINER_EXT Returnable container specified by customer for item shipment. This number is assigned for manually entered schedules. FK to RLM_SCHEDULE_LINES. SHIP_DEL_PATTERN_EXT VARCHAR2(3) Customer ship delivery pattern code for this item. VARCHAR2(35) RLM_SCHEDULE_LINE_ID NUMBER Schedule line unique identifier. not integrated with delivery rules for date/quantity calculation.LOOKUP_TYPE =RLM_ QTY_TYPE_CODE QTY_TYPE_CODE_EXT VARCHAR2(30) External value from which QTY_TYPE_CODE was derived in EDI Gateway Code Conversion. it is incremented in the EDI Gateway when each 2000 record is encountered on an inbound SPSI or SSSI transaction. it is equal to CUSTOMER_PROD_SEQ_NUM.RLM_INTERFACE_LINES_ALL QTY_TYPE_CODE VARCHAR2(30) Actual or Cumulative. 4-40 Oracle Order Management Suite APIs and Open Interfaces Manual . as sent by the customer on the TD5 segment. as sent by the customer on the TD5 segment. SCHEDULE_ITEM_NUM NUMBER Schedule Item Number. the means to identify how item demand and information is grouped by the customer within the schedule. ROUTING_SEQ_CODE_EXT VARCHAR2(3) Code describing the relationship of a carrier to a specific shipment movement. All interface lines with the same schedule item number are validated together.

SHIP_FROM_ADDRESS_2_EXT VARCHAR2(35) Ship from address line 2. VARCHAR2(60) Release Management Open Interface 4-41 . VARCHAR2(3) SHIP_FROM_COUNTY_EXT Ship from county. SHIP_FROM_ADDRESS_3_EXT VARCHAR2(35) Ship from address line 3. as sent by the customer on the N3 segment. VARCHAR2(30) SHIP_FROM_COUNTRY_EXT Ship from country. as sent by the customer on the N4 segment. as sent by the customer on the N4 segment. SHIP_DEL_RULE_NAME VARCHAR2(30) Shipment/delivery rule name for this schedule item. as sent by the customer on the N3 segment. SHIP_FROM_ADDRESS_4_EXT VARCHAR2(35) Ship from address line 4. as sent by the customer on the N4 segment. as sent by the customer on the N3 segment.RLM_INTERFACE_LINES_ALL SHIP_DEL_TIME_CODE_EXT VARCHAR2(3) Customer ship delivery time code for this item. VARCHAR2(25) SHIP_FROM_NAME_EXT Ship from name. Initially populated only if a successful code conversion in the EDI Gateway has occurred. as sent by the customer on the N3 segment. as sent by the customer in the N1 or N2 segment. FK to RLM_SHIP_ DELIVERY_CODES SHIP_FROM_ADDRESS_1_EXT VARCHAR2(35) Ship from address line 1. not integrated with delivery rules for date/quantity calculation. SHIP_FROM_CITY_EXT Ship from address city.

line 1. VARCHAR2(80) SHIP_LABEL_INFO_LINE_5 Pull signal bar-code label routing information .line 3. as sent by the customer on the N4 segment. VARCHAR2(10) SHIP_FROM_STATE_EXT Ship from state. VARCHAR2(10) SHIP_LABEL_INFO_LINE_1 Pull signal bar-code label routing information .line 5. as sent by the customer on the N4 segment. NUMBER SHIP_FROM_POSTAL_CD_EXT VARCHAR2(15) Ship from address postal code.line 4.line 6. VARCHAR2(80) SHIP_LABEL_INFO_LINE_3 Pull signal bar-code label routing information .line 10.RLM_INTERFACE_LINES_ALL SHIP_FROM_ORG_ID Ship from organization identifier. VARCHAR2(80) SHIP_LABEL_INFO_LINE_4 Pull signal bar-code label routing information . VARCHAR2(80) 4-42 Oracle Order Management Suite APIs and Open Interfaces Manual . as sent by the customer on the N4 segment.line 2. VARCHAR2(80) SHIP_LABEL_INFO_LINE_6 Pull signal bar-code label routing information . VARCHAR2(80) SHIP_LABEL_INFO_LINE_10 Pull signal bar-code label routing information . SHIP_FROM_PROVINCE_EXT Ship from province. FK to MTL_PARAMETERS and HR_ ORGANIZATIONS. VARCHAR2(80) SHIP_LABEL_INFO_LINE_2 Pull signal bar-code label routing information .

VARCHAR2(3) Release Management Open Interface 4-43 . as sent by the customer on the N4 segment. VARCHAR2(35) SHIP_TO_ADDRESS_4_EXT Ship to address line 4. VARCHAR2(35) SHIP_TO_ADDRESS_ID Ship to address identifier.line 7. as sent by the customer on the N3 segment.line 9. VARCHAR2(80) SHIP_TO_ADDRESS_1_EXT Ship to address line 1. FK to RA_ADDRESSES. as sent by the customer on the N3 segment. as sent by the customer on the N4 segment. as sent by the customer on the N3 segment. VARCHAR2(80) SHIP_LABEL_INFO_LINE_8 Pull signal bar-code label routing information . VARCHAR2(35) SHIP_TO_ADDRESS_3_EXT Ship to address line 3. as sent by the customer on the N3 segment.RLM_INTERFACE_LINES_ALL SHIP_LABEL_INFO_LINE_7 Pull signal bar-code label routing information . FK in R12 customer-org data model to HR_ORGANIZATIONS SHIP_TO_CITY_EXT Ship to address city. VARCHAR2(35) SHIP_TO_ADDRESS_2_EXT Ship to address line 2. VARCHAR2(30) SHIP_TO_COUNTRY_EXT Ship to country. NUMBER DELIVER_TO_ORG_ID NUMBER Unique identifier for deliver-to organization which relates to SHIP_TO_ADDRESS_ ID.line 8. VARCHAR2(80) SHIP_LABEL_INFO_LINE_9 Pull signal bar-code label routing information .

NUMBER SHIP_TO_STATE_EXT Ship to state. 1. as sent by the customer on the N4 segment. VARCHAR2(60) SHIP_TO_POSTAL_CD_EXT VARCHAR2(15) Ship to address postal code. DATE SUBLINE_ASSIGNED_ID_EXT VARCHAR2(20) Subline customer assigned identification from the SLN01. as sent by the customer on the N4 segment. as transmitted by the customer on the EDI transaction. Related to but not necessarily equivalent to the baseline number. as sent by the customer on the N1 or N2 segment. VARCHAR2(25) SHIP_TO_NAME_EXT Ship to name. SHIP_TO_PROVINCE_EXT Ship to province. 4-44 Oracle Order Management Suite APIs and Open Interfaces Manual . as sent by the customer on the N4 segment.RLM_INTERFACE_LINES_ALL SHIP_TO_COUNTY_EXT Ship to county. assigned identification from LIN01. as sent by the customer on the SLN segment. SUBLINE_CUST_ITEM_EXT VARCHAR2(50) Subline customer item number. VARCHAR2(10) START_DATE_TIME Customer-specified date and time. as sent by the customer on the N4 segment. VARCHAR2(10) SHIP_TO_SITE_USE_ID Ship to site use identifier. SUBLINE_CONFIG_CODE_EXT VARCHAR2(3) The Subline Configuration Code. For example. indicating the relationship of the subline item to the baseline item. as sent by the customer on the SLN segment.1 or 1A might be used as a subline number to relate to baseline number 1. FK to RA_SITE_USES.

Release Management Open Interface 4-45 . as sent by the customer on the TD5 segment. as sent by the customer on the TD5 segment. This corresponds to the shipping location qualifier. as sent by the customer on the TD5 segment. NUMBER SUBLINE_MODEL_NUM_EXT VARCHAR2(35) Subline customer model number. NUMBER SUBLINE_UOM_CODE VARCHAR2(3) The subline unit of measure (internal) cross-referenced from the UOM sent by the customer on the SLN segment. FK to MTL_UNITS_OF_MEASURE. VARCHAR2(35) TRANSIT_TIME_EXT The transit time. VARCHAR2(22) TRANSIT_TIME_QUAL_EXT VARCHAR2(3) The transit time qualifier. TRANSPORT_METHOD_EXT VARCHAR2(3) The transportation method.RLM_INTERFACE_LINES_ALL SUBLINE_CUST_ITEM_ID Customer item unique identifier. as sent by the customer on the TD5 segment. TRANSPORT_LOCATION_EXT VARCHAR2(35) The specific shipping location (such as pool point or airport) corresponding to the shipping location qualifier. as sent by the customer on the SLN segment. as sent by the customer on the SLN segment. as sent by the customer on the TD5 segment. SUPPLIER_ITEM_EXT Supplier item number specified by customer. TRANSPORT_LOC_QUAL_EXT VARCHAR2(3) The shipping location qualifier. FK to RLM_SHIP_FROM_CUST_ITEM. SUBLINE_QUANTITY The subline quantity. This identifies the type of location which specified in the corresponding shipping location.

NUMBER WEIGHT_QUALIFIER_EXT The weight qualifier. as sent by the customer on the TD1 segment. FBO_CONFIGURATION_KEY_2 VARCHAR2(35) For FBO Production Sequence schedules. the 5th sort key for identifying configurations indicated by the customer. FBO_CONFIGURATION_KEY_3 VARCHAR2(35) For FBO Production Sequence schedules. the 1st sort key for identifying configurations indicated by the customer. MATCH_ACROSS_KEY VARCHAR2(150) Audit trail of match across key used when this schedule was processed. the 3rd sort key for identifying configurations indicated by the customer. FBO_CONFIGURATION_KEY_1 VARCHAR2(35) For FBO Production Sequence schedules. FBO_CONFIGURATION_KEY_5 VARCHAR2(35) For FBO Production Sequence schedules. the 4th sort key for identifying configurations indicated by the customer. WEIGHT_EXT The weight. as sent by the customer on the TD1 segment. FK to MTL_UNITS_OF_MEASURE. the 2nd sort key for identifying configurations indicated by the customer. as sent by the customer on the TD1 segment. 4-46 Oracle Order Management Suite APIs and Open Interfaces Manual . FBO_CONFIGURATION_KEY_4 VARCHAR2(35) For FBO Production Sequence schedules. VARCHAR2(3) WEIGHT_UOM_EXT VARCHAR2(3) The unit of measure corresponding to shipment weight.RLM_INTERFACE_LINES_ALL UOM_CODE VARCHAR2(3) Abbreviated unit of measure code.

NUMBER CREATION_DATE Standard Who column.RLM_INTERFACE_LINES_ALL MATCH_WITHIN_KEY VARCHAR2(150) Audit trail of match within key used when this schedule was processed. VARCHAR2(150) ATTRIBUTE3 Descriptive flexfield segment column. LAST_UPDATE_DATE Standard Who column. NUMBER ATTRIBUTE_CATEGORY Descriptive flexfield context column. VARCHAR2(150) ATTRIBUTE2 Descriptive flexfield segment column. DATE CREATED_BY Standard Who column. An exception (warning) is generated if one of these is missing on Firm demand. CRITICAL_KEY_ATTRIBUTES VARCHAR2(150) Audit trail of critical attributes key used when this schedule was processed. VARCHAR2(150) ATTRIBUTE4 Descriptive flexfield segment column. VARCHAR2(30) ATTRIBUTE1 Descriptive flexfield segment column. DATE LAST_UPDATED_BY Standard Who column. VARCHAR2(150) Release Management Open Interface 4-47 .

RLM_INTERFACE_LINES_ALL ATTRIBUTE5 Descriptive flexfield segment column. VARCHAR2(150) ATTRIBUTE8 Descriptive flexfield segment column. VARCHAR2(150) ATTRIBUTE13 Descriptive flexfield segment column. VARCHAR2(150) ATTRIBUTE12 Descriptive flexfield segment column. NUMBER 4-48 Oracle Order Management Suite APIs and Open Interfaces Manual . VARCHAR2(150) ATTRIBUTE14 Descriptive flexfield segment column VARCHAR2(150) ATTRIBUTE15 Descriptive flexfield segment column. VARCHAR2(150) LAST_UPDATE_LOGIN Standard Who column. VARCHAR2(150) ATTRIBUTE6 Descriptive flexfield segment column VARCHAR2(150) ATTRIBUTE7 Descriptive flexfield segment column. VARCHAR2(150) ATTRIBUTE11 Descriptive flexfield segment column. VARCHAR2(150) ATTRIBUTE9 Descriptive flexfield segment column. VARCHAR2(150) ATTRIBUTE10 Descriptive flexfield segment column.

NUMBER PROGRAM_APPLICATION_ID Standard Who column NUMBER PROGRAM_ID Standard Who column.RLM_INTERFACE_LINES_ALL REQUEST_ID Standard Who column. VARCHAR2(150) Release Management Open Interface 4-49 . VARCHAR2(150) TP_ATTRIBUTE5 Trading partner flexfield segment column. VARCHAR2(150) TP_ATTRIBUTE3 Trading partner flexfield segment column. VARCHAR2(150) TP_ATTRIBUTE2 Trading partner flexfield segment column. VARCHAR2(150) TP_ATTRIBUTE7 Trading partner flexfield segment column. NUMBER PROGRAM_UPDATE_DATE Standard Who column. VARCHAR2(150) TP_ATTRIBUTE8 Trading partner flexfield segment column. VARCHAR2(150) TP_ATTRIBUTE4 Trading partner flexfield segment column. VARCHAR2(150) TP_ATTRIBUTE6 Trading partner flexfield segment column. DATE TP_ATTRIBUTE1 Trading partner flexfield segment column.

FK to HR_ORGANIZATIONS LINE_SOURCE VARCHAR2(30) Schedule Source at line level since lines can also be manually entered. VARCHAR2(150) TP_ATTRIBUTE13 Trading partner flexfield segment column. VARCHAR2(30) LINE_NUMBER Unique identifier of a line within a schedule. 4-50 Oracle Order Management Suite APIs and Open Interfaces Manual . NUMBER INTMED_SHIP_TO_ORG_ID NUMBER Unique identifier for intermediate ship-to organization which relates to INTERMEDIATE_SHIP_TO_ID if intermediate ship-to address is specified. VARCHAR2(150) TP_ATTRIBUTE11 Trading partner flexfield segment column. VARCHAR2(150) TP_ATTRIBUTE10 Trading partner flexfield segment column. VARCHAR2(150) TP_ATTRIBUTE_CATEGORY Trading partner flexfield context column. VARCHAR2(150) TP_ATTRIBUTE14 Trading partner flexfield segment column. VARCHAR2(150) TP_ATTRIBUTE15 Trading partner flexfield segment column. VARCHAR2(150) TP_ATTRIBUTE12 Trading partner flexfield segment column.RLM_INTERFACE_LINES_ALL TP_ATTRIBUTE9 Trading partner flexfield segment column.

VARCHAR2(4) Release Management Open Interface 4-51 .RLM_INTERFACE_LINES_ALL PREFERRED_GRADE Preferred grade.

RLM_INTERFACE_LINES_ALL 4-52 Oracle Order Management Suite APIs and Open Interfaces Manual .

Freight Costs Public Application Program Interface on page 78.5 Oracle Shipping Execution 11i Public APIs This chapter contains information about the following Oracle Shipping Execution public application program interfaces (APIs): s Trip Public Application Program Interface on page 2. s s s s s Oracle Shipping Execution 11i Public APIs 1 . Deliveries Public Application Program Interface on page 21. Stop Public Application Program Interface on page 11. Container Public Application Program Interface on page 60. Delivery Details Public Application Program Interface on page 39.

and Ship Method before performing the actions of creating or updating a trip record. while the trip NAME of an existing trip for update is passed as an IN parameter. The API validates trip information such as Trip Name. Arrive After Trip Name.CREATE_UPDATE_TRIP. All of the inbound and outbound parameters are listed. Additional information on these parameters follows. The Create_Update_Trip procedure enables you to create a new trip record or update an existing trip record in the WSH_TRIPS table. 2 Oracle Order Management Suite APIs and Open Interfaces Manual . It also checks that the insert or update statements were successful. The TRIP_ID.Trip Public Application Program Interface Trip Public Application Program Interface The Trip Public Application Program Interface (API) is a public API that consists of the following two procedures in package WSH_TRIPS_PUB: Create_Update_Trip: Enables you to create a new trip record and update an existing trip record. Create_Update_Trip API Features The Create_Update_Trip API has the following features.CREATE_UPDATE_TRIP The following chart describes all parameters used by the public procedure WSH_ TRIPS_PUB. It inserts the trip information into WSH_TRIPS and returns the TRIP_ID and NAME of the new trip. Functional Overview This API creates a new trip record in WSH_TRIPS as specified by IN parameter p_ action_code value CREATE. and if not returns an error. NAME and return status of a new trip are passed as OUT parameters. Trip_Action: Enables you to perform certain actions on a trip. Procedure Parameter Descriptions WSH_TRIPS_PUB. It also updates an existing trip record in WSH_TRIPS as specified by IN parameter p_action_code value UPDATE. This section describes how to use the Trip Public API and how it functions in Oracle Shipping Execution. The NAME of the trip being updated is passed through IN parameter p_trip_name.

then the list of messages must be retrieved using the call FND_ MSG_PUB. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s s where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively.GET. p_init_msg_list Requests that the API initialize the message list on your behalf. If the x_msg_count is greater than 1. Valid values include: Oracle Shipping Execution 11i Public APIs 3 .Trip Public Application Program Interface Parameter p_api_version_number p_init_msg_list x_return_status x_msg_count x_msg_data p_action_code p_trip_info p_trip_name x_trip_id x_trip_name Usage IN IN OUT OUT OUT IN IN OUT IN OUT OUT Type Number Varchar2 Varchar2 Number Varchar2 Varchar2 Record Varchar2 Number Varchar2 Required x x x p_api_version_number Compares the incoming API call's version number with the current version number.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function. Default Value: FND_API. An error is returned if the version numbers are incompatible.

define TRIP_PUB_REC_TYPE to pass trip information to the Create_Update_Trip routine. Record Parameter Descriptions TRIP_PUB_REC_TYPE RECORD DEFINITION To encapsulate WSH_TRIPS table definition and Value column equivalents for ID columns in a PL/SQL record.G_MISS_CHAR x_trip_id Trip ID of new trip being created. Definition of Trip_Pub_Rec_Type follows.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates number of error messages API has encountered. These attributes are inserted/updated in WSH_TRIPS. x_trip_name Name of new trip being created.G_RET_STS_SUCCESS Error: FND_API.Trip Public Application Program Interface s Success: FND_API. p_action_code Specifies whether API should create a new trip or update existing trip information based on its values CREATE or UPDATE. x_msg_data Returns error message text. If the x_msg_count is equal to 1. Default Value: FND_API. then this contains the actual message. p_trip_info Attributes of the trip entity of type Trip_Pub_Rec_Type. p_trip_name IN parameter to specify Name of trip that is needed to be updated.G_RET_STS_ERROR Unexpected Error: FND_API. 4 Oracle Order Management Suite APIs and Open Interfaces Manual .

g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char Oracle Shipping Execution 11i Public APIs 5 .Trip Public Application Program Interface Attribute trip_id name arrive_after_trip_id arrive_after_trip_name vehicle_item_id vehicle_item_desc vehicle_organization_id vehicle_organization_ code vehicle_number vehicle_num_prefix carrier_id ship_method_code ship_method_name route_id routing_instructions attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 Type Number Varchar2(30) Number Varchar2(30) Number Varchar2(240) Number Varchar2(3) Varchar2(30) Varchar2(10) Number Varchar2(30) Varchar2(80) Number Varchar2(2000) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Default Value fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.

vehicle_tem_flag.g_miss_date fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num Record Parameter Attribute Validations trip_id Should be a valid unique element of wsh_trips.g_miss_num fnd_api.g_miss_char fnd_api. 6 Oracle Order Management Suite APIs and Open Interfaces Manual .Trip Public Application Program Interface Attribute attribute12 attribute13 attribute14 attribute15 creation_date created_by last_update_date last_updated_by last_update_login program_application_id program_id program_update_date request_id Type Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Date Number Date Number Date Number Number Date Number Default Value fnd_api.g_miss_date fnd_api.g_miss_date fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.name arrive_after_trip_id Should be a valid element of wsh_trips. name Should be a valid unique element of wsh_trips. arrive_after_trip_name Should be a valid element of wsh_trips.trip_id.name vehicle_item_id Should be a valid vehicle item in mtl_system_items.trip_id.g_miss_num fnd_api.inventory_item_id as designated by mtl_system_items.g_miss_num fnd_api.g_miss_char fnd_api.

ship_method_code Should be a valid element of fnd_lookup_values_vl.organization_code for that specific organization_id.Trip Public Application Program Interface vehicle_item_desc Key flex field description for vehicle item.lookup_code for lookup_type SHIP_METHOD. vehicle_organization_code Should be a valid element of org_organization_definitions. and x_msg_data on retrieving error messages.organization_id.organization_id and be assigned to the specific item in mtl_system_items.meaning for lookup_type SHIP_METHOD. x_msg_count. vehicle_organization_id Should be a valid element of org_organization_definitions. Oracle Shipping Execution 11i Public APIs 7 . Error Handling Refer to parameters p_init_msg_list. ship_method_name Should be a valid element of fnd_lookup_values_vl.

an action code and any additional parameters needed for specific actions. Parameter p_api_version_number p_init_msg_list x_return_status x_msg_count x_msg_data p_action_code p_trip_id Usage IN IN OUT OUT OUT IN IN OUT Type Number Varchar2 Varchar2 Number Varchar2 Varchar2 Record x Required x 8 Oracle Order Management Suite APIs and Open Interfaces Manual .TRIP_ACTION The following chart describes all parameters used by the public procedure WSH_ TRIPS_PUB. All of the inbound and outbound parameters are listed. It accepts as IN parameters the trip identifiers. This action needs an additional parameter P_WV_OVERRIDE_FLAG. WT-VOL: Is called to calculate weight and volume for the trip. If this is set to Y. s PLAN/UNPLAN: Is called to plan or unplan trips. PICK_RELEASE: Is called to launch pick release to release lines related to the trip. weight and volume re-calculations are done for all deliveries on the trip. s s s Procedure Parameter Descriptions WSH_TRIPS_PUB.Trip Public Application Program Interface Trip_Action API Features The Trip_Action API has the following features: The Trip_Action procedure enables you to carry out actions on a trip. TRIP_ACTION. Additional information on these parameters follows. DELETE: Is called to delete trips. Functional Overview This API validates the trip identifiers and performs the following actions specified in p_action_code by calling the corresponding private procedures. and returns a completion status.

then this contains the actual message.G_RET_STS_SUCCESS Error: FND_API. If the x_msg_count is greater than 1. then the list of messages must be retrieved using the call FND_ MSG_PUB. Valid values include: s Success: FND_API.Trip Public Application Program Interface Parameter p_trip_name p_wv_override_flag Usage IN IN Type Varchar2 Varchar2 Required p_api_version_number Compares the incoming API call's version number with the current version number. An error is returned if the version numbers are incompatible.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function. p_init_msg_list Requests that the API initialize the message list on your behalf. Default Value: FND_API. Oracle Shipping Execution 11i Public APIs 9 . If the x_msg_count is equal to 1.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates number of error messages API has encountered.GET. x_msg_data Returns error message text. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s s where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively.G_RET_STS_ERROR Unexpected Error: FND_API.

Error Handling Refer to parameters p_init_msg_list. DELETE the API should perform. 10 Oracle Order Management Suite APIs and Open Interfaces Manual . x_msg_count. If this is set to Y. WT-VOL. and x_msg_data on retrieving error messages. p_trip_id Trip ID of trip on which actions are being performed. weight and volume re-calculations are done for all deliveries on the trip.Trip Public Application Program Interface p_action_code Specifies which of the actions of PLAN. Default value is N. PICK RELEASE. p_trip_name Name of trip on which actions are being performed. UNPLAN. p_wv_override_flag Additional parameter for WT-VOL.

It also updates an existing stop record in WSH_TRIP_STOPS as specified by IN parameter p_action_code value UPDATE. Stop Location Id/Code and Planned Departure Date. and if not returns an error. The API validates information such as Trip Name. The Create_Update_Stop procedure enables you to create a new stop record or update an existing stop record in WSH_TRIP_STOPS table. Stop_Action: Enables you to perform certain actions on a stop. Create_Update_Stop API Features The Create_Update_Stop API has the following features. It also checks that the insert or update statements were successful. All of the inbound and outbound parameters are listed. It inserts stop information into WSH_ TRIP_STOPS and returns the STOP_ID of the new stop.Stop Public Application Program Interface Stop Public Application Program Interface The Stop Public Application Program Interface (API) is a public API that consists of the following two procedures in package WSH_TRIP_STOPS_PUB: Create_Update_Stop: Enables you to create a new stop record and update an existing stop record. while the TRIP_ID of an existing stop for update is passed as an IN parameter. Location Code.CREATE_UPDATE_STOP.CREATE_UPDATE_STOP The following chart describes all parameters used by the public procedure WSH_ TRIP_STOPS_PUB. The STOP_ID and return status of a new stop are passed as OUT parameters. Stop Location Id/Code and Planned Departure Date. Additional information on these parameters follows. Procedure Parameter Descriptions WSH_TRIP_STOPS_PUB. The stop record being updated is identified by Stop Id or Trip Id/Name. Functional Overview This API creates a new stop record in WSH_TRIP_STOPS as specified by IN parameter p_action_code value CREATE. Oracle Shipping Execution 11i Public APIs 11 . This section describes how to use the Stop Public API and how it functions in Oracle Shipping Execution. Additional IN parameters are provided to update Trip Id/Name. and UOMs before performing the actions of creating or updating a stop record.

p_init_msg_list Requests that the API initialize the message list on your behalf.GET. If the x_msg_count is greater than 1. An error is returned if the version numbers are incompatible.Stop Public Application Program Interface Parameter p_api_version_number p_init_msg_list x_return_status x_msg_count x_msg_data p_action_code p_stop_info p_trip_id p_trip_name p_stop_location_id p_location_code p_planned_dep_date x_stop_id Usage IN IN OUT OUT OUT IN IN OUT IN IN IN IN IN OUT Type Number Varchar2 Varchar2 Number Varchar2 Varchar2 Record Number Varchar2 Number Varchar2 Varchar2 Number Required x x x p_api_version_number Compares the incoming API call's version number with the current version number. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s s where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively. Default Value: FND_API.G_FALSE 12 Oracle Order Management Suite APIs and Open Interfaces Manual . then the list of messages must be retrieved using the call FND_ MSG_PUB.

G_MISS_NUM p_trip_name IN parameter to specify trip name of trip stop record that is needed to be updated. then this contains the actual message. Default Value: FND_API. These attributes are inserted/updated in WSH_TRIP_STOPS. If the x_msg_count is equal to 1.G_RET_STS_SUCCESS Error: FND_API. Default Value: FND_API. x_msg_data Displays error message text.G_MISS_NUM Oracle Shipping Execution 11i Public APIs 13 . Default Value: FND_API.G_RET_STS_ERROR Unexpected Error: FND_API. p_stop_info Attributes of the stop entity of type Trip_Stop_Pub_Rec_Type.G_MISS_CHAR p_stop_location_id IN parameter to specify stop location ID of trip stop record being updated. Definition of Trip_Stop_Pub_Rec_Type follows. p_trip_id IN parameter to specify trip ID of trip stop record being updated. Valid values include: s Success: FND_API.Stop Public Application Program Interface x_return_status Requests that the API return the status of the data for you after it completes its function. p_action_code Specifies whether API should create a new stop or update existing stop information depending on its values CREATE and UPDATE.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates number of error messages API has encountered.

Stop Public Application Program Interface p_location_code IN parameter to specify stop location code of stop record that is needed to be updated.g_miss_num fnd_api.g_miss_num fnd_api. define TRIP_STOP_PUB_REC_TYPE to pass trip information to the Create_Update_Stop routine. Attribute stop_id trip_id trip_name stop_location_id stop_location_code planned_arrival_date planned_departure_date actual_arrival_date actual_departure_date departure_gross_weight departure_net_weight weight_uom_code Type Number Number Varchar2(30) Number Varchar2(20) Date Date Date Date Number Number Varchar2(3) Default Value fnd_api.g_miss_char fnd_api.g_miss_date fnd_api.g_miss_num fnd_api.g_miss_date fnd_api.g_miss_char 14 Oracle Order Management Suite APIs and Open Interfaces Manual . Default Value: FND_API. Record Parameter Descriptions TRIP_STOP_PUB_REC_TYPE RECORD DEFINITION To encapsulate WSH_TRIP_STOPS table definition and Value column equivalents for ID columns in a PL/SQL record.g_miss_date fnd_api.g_miss_date fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.G_MISS_CHAR p_planned_dep_date IN parameter to specify planned date of departure.g_miss_num fnd_api. Default Value: FND_API.G_MISS_DATE x_stop_id OUT parameter to specify new stop ID of new stop record being created.

g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char Oracle Shipping Execution 11i Public APIs 15 .g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.Stop Public Application Program Interface Attribute weight_uom_desc departure_volume volume_uom_code volume_uom_desc departure_seal_code departure_fill_percent tp_attribute_category tp_attribute1 tp_attribute2 tp_attribute3 tp_attribute4 tp_attribute5 tp_attribute6 tp_attribute7 tp_attribute8 tp_attribute9 tp_attribute10 tp_attribute11 tp_attribute12 tp_attribute13 tp_attribute14 tp_attribute15 attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 Type Varchar2(25) Number Varchar2(3) Varchar2(25) Varchar2(30) Number Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Default Value fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.

g_miss_char fnd_api.Stop Public Application Program Interface Attribute attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 creation_date created_by last_update_date last_updated_by last_update_login program_application_id program_id program_update_date request_id Type Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Date Number Date Number Date Number Number Date Number Default Value fnd_api.g_miss_date fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num Record Parameter Attribute Validations stop_id Should be a valid unique element of wsh_trip_stops.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_date fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_date fnd_api.stop_id.trip_id. trip_id Should be a valid unique element of wsh_trips.g_miss_char fnd_api.g_miss_date fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api. trip_name Should be a valid unique element of wsh_trips.g_miss_char fnd_api.name 16 Oracle Order Management Suite APIs and Open Interfaces Manual .

uom_code for a volume uom class.uom_code for a weight uom class. Error Handling Refer to parameters p_init_msg_list.unit_of_measure for a volume uom class. and x_msg_data on retrieving error messages. weight_uom_desc Should be a valid element of mtl_units_of_measure. volume_uom_code Should be a valid element of mtl_units_of_measure. volume_uom_desc Should be a valid element of mtl_units_of_measure. Oracle Shipping Execution 11i Public APIs 17 .location_id stop_location_code Should be a valid element of hr_locations.unit_of_measure for a weight uom class. x_msg_count.Stop Public Application Program Interface stop_location_id Should be a valid element of hr_locations.location_code. weight_uom_code Should be a valid element of mtl_units_of_measure.

Additional information on these parameters follows. ARRIVE/CLOSE: Is called to update departure or arrival dates and to close a stop. Parameter p_api_version_number p_init_msg_list x_return_status x_msg_count x_msg_data p_action_code p_stop_id p_trip_id Usage IN IN OUT OUT OUT IN in IN Type Number Varchar2 Varchar2 Number Varchar2 Varchar2 Number Number x Required x 18 Oracle Order Management Suite APIs and Open Interfaces Manual . All of the inbound and outbound parameters are listed. PICK_RELEASE: Launches pick release to release lines related to a stop. It accepts as IN parameters the trip identifiers.STOP_ACTION. and returns a completion status. s s s Procedure Parameter Descriptions WSH_TRIP_STOP_PUB. DELETE: Is called to delete stops.Stop Public Application Program Interface Stop_Action API Features The Stop_Action API has the following features: The Trip_Action procedure enables you to carry out actions on a stop. an action code and any additional parameters needed for specific actions. Functional Overview This API validates the stop identifiers and performs the following actions specified in p_action_code by calling the corresponding private procedures. This action needs an additional parameter P_ACTUAL_DATE for actual departure or arrival updates. s PLAN/UNPLAN: Is called to plan or unplan stops.STOP_ACTION The following chart describes all parameters used by the public procedure WSH_ TRIP_STOP_PUB.

The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s s where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively. An error is returned if the version numbers are incompatible.G_RET_STS_SUCCESS Error: FND_API.GET.G_RET_STS_UNEXP_ERROR s s Oracle Shipping Execution 11i Public APIs 19 . then the list of messages must be retrieved using the call FND_ MSG_PUB. Default Value: FND_API.Stop Public Application Program Interface Parameter p_trip_name p_stop_location_id p_stop_location_code p_planned_dep_date p_actual_date p_defer_interface_flag Usage IN IN IN IN IN IN Type Varchar2 Varchar2 Varchar2 Date Date Varchar2 Required p_api_version_number Compares the incoming API call's version number with the current version number. Valid values include: s Success: FND_API. p_init_msg_list Requests that the API initialize the message list on your behalf. If the x_msg_count is greater than 1.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function.G_RET_STS_ERROR Unexpected Error: FND_API.

x_msg_data Returns error message text. p_action_code Specifies which of the actions of PLAN. DELETE the API should perform. p_planned_dep_date Planned departure date of trip stop on which actions need to be performed. p_stop_location_code Stop location code of trip stop on which actions need to be performed. p_stop_id Stop ID of trip stop on which actions need to be performed. PICK RELEASE. p_trip_name Trip name of trip stop on which actions need to be performed. p_stop_id Stop ID of trip stop on which actions need to be performed. p_defer_interface_flag Flag to submit/defer concurrent requests to INV and OE interfaces. then this contains the actual message. 20 Oracle Order Management Suite APIs and Open Interfaces Manual . CLOSE. ARRIVE. p_stop_location_id Stop location ID of trip stop on which actions need to be performed.Stop Public Application Program Interface x_msg_count Indicates number of error messages API has encountered. p_trip_id Trip ID of trip stop on which actions need to be performed. If the x_msg_count is equal to 1. UNPLAN. p_actual_date Actual date of arrival/departure of trip stop.

Procedure Parameter Descriptions WSH_DELIVERIES_PUB.Deliveries Public Application Program Interface Deliveries Public Application Program Interface The Deliveries Public Application Program Interface (API) is a public API that consists of the following two procedures in WSH_DELIVERIES_PUB: s Create_Update_Delivery: Enables you to create a new trip stop record and update an existing trip stop record. Create_Update_Delivery API Features The Create_Update_Delivery API has the following features. The API validates delivery information such as Name. Delivery record being updated is identified by Delivery Name. NAME and return status of a new delivery are passed as OUT parameters. All of the inbound and Oracle Shipping Execution 11i Public APIs 21 . It also checks that the insert or update statements were successful. while the DELIVERY_ID or NAME of an existing delivery for update is passed as an IN parameter. The DELIVERY_ID. Inserts delivery information into WSH_NEW_DELIVERIES and returns the DELIVERY_ID of the new delivery.CREATE_UPDATE_DELIVERY The following chart describes all parameters used by the public procedure WSH_ DELIVERIES_PUB. Delivery_Action: Enables you to perform certain actions on a trip stop. and if not. The Create_Update_Delivery procedure enables you to create a new delivery record or update an existing delivery record in WSH_NEW_DELIVERIES table. s This section describes how to use the Deliveries Public API and how it functions in Oracle Shipping Execution. Functional Overview This API creates a new delivery record in WSH_NEW_DELIVERIES as specified by IN parameter p_action_code value CREATE. It also updates an existing delivery record in WSH_NEW_DELIVERIES as specified by IN parameter p_action_code value UPDATE. and Ship Method before performing the actions CREATE or UPDATE. returns an error. Customer Number.CREATE_UPDATE_DELIVERY. An additional IN parameter is provided to identify delivery by Name for update.

Additional information on these parameters follows. If the x_msg_count is greater than 1. p_init_msg_list Requests that the API initialize the message list on your behalf. Default Value: FND_API.GET. An error is returned if the version numbers are incompatible. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s s where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively. Parameter p_api_version_number p_init_msg_list x_return_status x_msg_count x_msg_data p_action_code p_delivery_info p_delivery_name x_delivery_id x_name Usage IN IN OUT OUT OUT IN IN OUT IN OUT OUT Type Number Varchar2 Varchar2 Number Varchar2 Varchar2 Record Varchar2 Number Varchar2 x x Required x p_api_version_number Compares the incoming API call's version number with the current version number.G_FALSE 22 Oracle Order Management Suite APIs and Open Interfaces Manual .Deliveries Public Application Program Interface outbound parameters are listed. then the list of messages must be retrieved using the call FND_ MSG_PUB.

Oracle Shipping Execution 11i Public APIs 23 . p_delivery_info Attributes of the delivery entity of type Delivery_Pub_Rec_Type.G_MISS_CHAR x_delivery_id OUT parameter to specify delivery ID of new delivery record being created. then this contains the actual message. Definition of Delivery_Pub_ Rec_Type follows. p_action_code Specifies whether API should create a new delivery or update existing delivery information depending on its values CREATE and UPDATE.G_RET_STS_ERROR Unexpected Error: FND_API. x_name OUT parameter to specify name of new delivery record being created. These attributes are inserted/updated in WSH_NEW_DELIVERIES. If the x_msg_count is equal to 1. x_msg_data Displays error message text.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates number of error messages API has encountered. p_delivery_name IN parameter to specify name of delivery record being updated. Default Value: FND_API. Valid values include: s Success: FND_API.Deliveries Public Application Program Interface x_return_status Requests that the API return the status of the data for you after it completes its function.G_RET_STS_SUCCESS Error: FND_API.

g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_num fnd_api.g_miss_date fnd_api.g_miss_date fnd_api.Deliveries Public Application Program Interface Record Parameter Descriptions DELIVERY_PUB_REC_TYPE RECORD DEFINITION To encapsulate WSH_NEW_DELIVERIES table definition and Value column equivalents for ID columns in a PL/SQL record. define DELIVERIES_PUB_REC_ TYPE to pass delivery information to the Create_Update_Delivery routine.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char 24 Oracle Order Management Suite APIs and Open Interfaces Manual .g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_num fnd_api. Attribute delivery_id name delivery_type loading_sequence loading_order_flag loading_order_desc initial_pickup_date initial_pickup_location_id initial_pickup_location_code organization_id organization_code ultimate_dropoff_location_id ultimate_dropoff_location_code ultimate_dropoff_date customer_id customer_number intmed_ship_to_location_id intmed_ship_to_location_code pooled_ship_to_location_id pooled_ship_to_location_code carrier_id carrier_code Type Number Varchar2(30) Varchar2(30) Number Varchar2(2) Varchar2(20) Date Number Varchar2(20) Number Varchar2(3) Number Varchar2(20) Date Number Varchar2(30) Number Varchar2(20) Number Varchar2(20) Number Varchar2(25) Default fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.

g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.Deliveries Public Application Program Interface Attribute ship_method_code ship_method_name freight_terms_code freight_terms_name fob_code fob_name fob_location_id fob_location_code waybill dock_code acceptance_flag accepted_by accepted_date acknowledged_by confirmed_by confirm_date asn_date_sent asn_status_code asn_seq_number gross_weight net_weight weight_uom_code weight_uom_desc volume volume_uom_code volume_uom_desc additional_shipment_info currency_code Type Varchar2(30) Varchar2(80) Varchar2(30) Varchar2(80) Varchar2(30) Varchar2(80) Number Varchar2(20) Varchar2(30) Varchar2(30) Varchar2(1) Varchar2(150) Date Varchar2(150) Varchar2(150) Date Date Varchar2(15) Number Number Number Varchar2(3) Varchar2(25) Number Varchar2(3) Varchar2(25) Varchar2(500) Varchar2(15) Default fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char Oracle Shipping Execution 11i Public APIs 25 .g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_num fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_date fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_date fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_date fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.

g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char 26 Oracle Order Management Suite APIs and Open Interfaces Manual .g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.Deliveries Public Application Program Interface Attribute currency_name attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 tp_attribute_category tp_attribute1 tp_attribute2 tp_attribute3 tp_attribute4 tp_attribute5 tp_attribute6 tp_attribute7 tp_attribute8 tp_attribute9 tp_attribute10 Type Varchar2(80) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Default fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.

Deliveries Public Application Program Interface Attribute tp_attribute11 tp_attribute12 tp_attribute13 tp_attribute14 tp_attribute15 global_attribute_category global_attribute1 global_attribute2 global_attribute3 global_attribute4 global_attribute5 global_attribute6 global_attribute7 global_attribute8 global_attribute9 global_attribute10 global_attribute11 global_attribute12 global_attribute13 global_attribute14 global_attribute15 global_attribute16 global_attribute17 global_attribute18 global_attribute19 global_attribute20 creation_date created_by Type Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(30) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Date Number Default fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_date fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num Oracle Shipping Execution 11i Public APIs 27 .g_miss_char fnd_api.

g_miss_num Record Parameter Attribute Validations delivery_id Should be a valid unique element of wsh_new_deliveries. loading_order_desc Should be a valid element of fnd_lookup_values_vl. delivery_name Should be a valid unique element of wsh_new_deliveries.g_miss_num fnd_api.Deliveries Public Application Program Interface Attribute last_update_date last_updated_by last_update_login program_application_id program_id program_update_date request_id Type Date Number Number Number Number Date Number Default fnd_api.g_miss_num fnd_api.g_miss_date fnd_api.g_miss_date fnd_api.g_miss_num fnd_api.location_id.lookup_code for lookup_type LOADING_ORDER.location_code. 28 Oracle Order Management Suite APIs and Open Interfaces Manual . initial_pickup_location_id Should be a valid element of hr_locations. initial_pickup_location_code Should be a valid element of hr_locations.delivery_id.meaning for lookup_type LOADING_ORDER.name. delivery_type Should be either STANDARD.g_miss_num fnd_api. loading_order_flag Should be a valid element of fnd_lookup_values_vl.

lookup_code for lookup_type SHIP_METHOD. customer_code Should be a valid element of ra_customers.location_code.location_id.location_code. ultimate_dropoff_location_id Should be a valid element of hr_locations.customer_id.organization_id. ship_method_code Should be a valid element of fnd_lookup_values_vl. ship_method_name Should be a valid element of fnd_lookup_values_vl. pooled_ship_to_location_id Should be a valid element of hr_locations.organization_code. intmed_ship_to_location_id Should be a valid element of hr_locations. intmed_ship_to_location_code Should be a valid element of hr_locations.location_id. pooled_ship_to_location_code Should be a valid element of hr_locations. customer_id Should be a valid element of ra_customers.customer_code. Oracle Shipping Execution 11i Public APIs 29 .Deliveries Public Application Program Interface organization_id Should be a valid element of org_organization_definitions.location_id. organization_code Should be a valid element of org_organization_definitions.location_code.meaning for lookup_type SHIP_METHOD. ultimate_dropoff_location_code Should be a valid element of hr_locations.

volume_uom_desc Should be a valid element of mtl_units_of_measure.meaning for lookup_type FREIGHT_TERMS. fob_terms_name Should be a valid element of fnd_lookup_values_vl.unit_of_measure for a weight uom class.lookup_code for lookup_type FREIGHT_TERMS.uom_code for a volume uom class. freight_terms_name Should be a valid element of fnd_lookup_values_vl.location_id. fob_location_code Should be a valid element of hr_locations.uom_code for a weight uom class weight_uom_desc Should be a valid element of mtl_units_of_measure. weight_uom_code Should be a valid element of mtl_units_of_measure.Deliveries Public Application Program Interface freight_terms_code Should be a valid element of fnd_lookup_values_vl. fob_location_id Should be a valid element of hr_locations. fob_code Should be a valid element of fnd_lookup_values_vl. volume_uom_code Should be a valid element of mtl_units_of_measure.lookup_code for lookup_type FOB.unit_of_measure for a volume uom class. 30 Oracle Order Management Suite APIs and Open Interfaces Manual .meaning for lookup_type FOB.location_code.

Deliveries Public Application Program Interface currency_code Should be a valid element of fnd_currencies_vl. Error Handling Refer to parameters p_init_msg_list. currency_name Should be a valid element of fnd_currencies_vl. x_msg_count.currency_code.currency_name. and x_msg_data on retrieving error messages. Oracle Shipping Execution 11i Public APIs 31 .

Functional Overview This API validates the delivery identifiers and performs the following actions specified in p_action_code by calling the corresponding private procedures: s PLAN/UNPLAN: Is called to plan or unplan deliveries. UNASSIGN-TRIP: Is called to unassign trip from delivery. This action needs an additional parameter P_ACTUAL_DATE for actual departure or arrival updates. If this is set to Y.Deliveries Public Application Program Interface Delivery_Action API Features The Delivery_Action API has the following features: The Delivery_Action procedure enables you to carry out actions on a delivery. All of the inbound and outbound parameters are listed.DELIVERY_ACTION The following chart describes all parameters used by the public procedure WSH_ DELIVERY_PUB. WT-VOL: Is called to calculate weight and volume for the delivery. s s s s s s s s Procedure Parameter Descriptions WSH_DELIVERY_PUB. PICK_RELEASE: Launches pick release to release lines related to a delivery. Requires additional parameters starting with P_SC PACK. DELETE: Is called to delete a delivery. It requires additional parameters starting with P_ASG. CONFIRM: Is called to confirm delivery. It accepts as IN parameters the delivery identifiers.DELIVERY_ACTION. and returns a completion status. AUTOCREATE-TRIP: Is called to autocreate trip for the delivery. weight and volume re-calculations are done for all deliveries on the trip. Additional information on these parameters follows. 32 Oracle Order Management Suite APIs and Open Interfaces Manual . RE-OPEN. CLOSE: Is called to update status of delivery. ASSIGN-TRIP: Is called to assign a trip to delivery. This action needs an additional parameter P_WV_OVERRIDE_FLAG. an action code and any additional parameters needed for specific actions. IN-TRANSIT.

Deliveries Public Application Program Interface Parameter p_api_version_number p_init_msg_list x_return_status x_msg_count x_msg_data p_action_code p_delivery_id p_delivery_name p_asg_trip_id p_asg_trip_name p_asg_pickup_stop_id p_asg_pickup_loc_id p_asg_pickup_loc_code p_asg_pickup_arr_date p_asg_pickup_dep_date p_asg_dropoff_stop_id p_asg_dropoff_loc_id p_asg_dropoff_loc_code p_asg_dropoff_arr_date p_asg_dropoff_dep_date p_sc_action_flag p_sc_intransit_flag p_sc_close_trip_flag p_sc_create_bol_flag p_sc_stage_del_flag p_sc_trip_ship_method p_sc_actual_dep_date Usage IN IN OUT OUT OUT IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type Number Varchar2 Varchar2 Number Varchar2 Varchar2 Number Varchar2 Number Varchar2 Number Number Varchar2 Date Number Number Number Varchar2 Date Date Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Required x x Oracle Shipping Execution 11i Public APIs 33 .

GET. Valid values include: s Success: FND_API.G_RET_STS_SUCCESS Error: FND_API. An error is returned if the version numbers are incompatible.G_RET_STS_UNEXP_ERROR s s 34 Oracle Order Management Suite APIs and Open Interfaces Manual .G_RET_STS_ERROR Unexpected Error: FND_API. Default Value: FND_API.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function.Deliveries Public Application Program Interface Parameter p_sc_report_set_id p_sc_report_set_name p_sc_defer_interface_flag p_wv_override_flag x_trip_id x_trip_name p_actual_date Usage IN IN IN IN OUT OUT IN Type Number Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Date Required p_api_version_number Compares the incoming API call's version number with the current version number. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s s where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively. If the x_msg_count is greater than 1. then the list of messages must be retrieved using the call FND_ MSG_PUB. p_init_msg_list Requests that the API initialize the message list on your behalf.

AUTOCREATE-TRIP. PACK. Used when assigning a trip. Default Value: NULL.Deliveries Public Application Program Interface x_msg_count Indicates number of error messages API has encountered. Default Value: NULL. Default Value: NULL. Used when assigning a trip. DELETE the API should perform. p_asg_pickup_loc_id Stop location for pickup assignment. WT-VOL. RE-OPEN. PICK RELEASE. p_delivery_name Name of delivery on which actions need to be performed. p_action_code Specifies which of the actions of PLAN. ASSIGN-TRIP. Default Value: NULL. UNPLAN. p_asg_pickup_stop_id Stop ID for pickup assignment. CONFIRM. Used when assigning a trip. Default Value: NULL. If the x_msg_count is equal to 1. Oracle Shipping Execution 11i Public APIs 35 . Used when assigning a trip. CLOSE. then this contains the actual message. x_msg_data Returns error message text. p_asg_trip_id Trip identifier for assignment of trip to delivery. p_trip_name Name of trip for assignment to delivery. IN-TRANSIT. p_delivery_id Delivery ID on which actions need to be performed. UNASSIGN-TRIP.

Deliveries Public Application Program Interface p_asg_pickup_loc_code Stop location code for pickup assignment. Default Value: NULL. Used when assigning a trip. p_asg_dropoff_arr_date Stop location arrival date for dropoff assignment. Used when assigning a trip. Default Value: NULL. Used when assigning a trip. p_asg_dropoff_loc_id Stop location for dropoff assignment. p_asg_dropoff_loc_code Stop location code for dropoff assignment. p_asg_dropoff_stop_id Stop ID for dropoff assignment. Default Value: NULL. Used when assigning a trip. Default Value: NULL. Default Value: NULL. Used when assigning a trip. Used when assigning a trip. p_asg_dropoff_dep_date Stop location departure date for dropoff assignment. Used when assigning a trip. p_asg_pickup_dep_date Stop location departure date for pickup assignment. Default Value: NULL. p_asg_pickup_arr_date Stop location arrival date for pickup assignment. Default Value: NULL. Default Value: NULL. 36 Oracle Order Management Suite APIs and Open Interfaces Manual . Used when assigning a trip.

Default Value: N p_sc_create_bol_flag Ship Confirm create Bill of Lading flag. Default Value: N.S. p_defer_interface_flag Ship Confirm flag to submit/defer concurrent requests to INV and OE interfaces. Used when ship confirming a delivery. Used when ship confirming a delivery. Default Value: Y p_wv_override_flag Override flag for weight volume calculations. Default Value: NULL.Deliveries Public Application Program Interface p_sc_action_flag Ship Confirm option . C. Used when ship confirming a delivery. Default Value: N Oracle Shipping Execution 11i Public APIs 37 . Default Value: N p_sc_close_trip_flag Ship Confirm close trip flag. T. Default Value: S p_sc_intransit_flag Ship Confirm set in-transit flag. Default Value: Y. Used when ship confirming a delivery. B. A. Used when ship confirming a delivery. Used when ship confirming a delivery. p_sc_trip_ship_method Ship Confirm trip ship method. p_sc_stage_del_flag Ship Confirm create delivery for stage quantity flag.

and x_msg_data on retrieving error messages. Error Handling Refer to parameters p_init_msg_list.Deliveries Public Application Program Interface x_trip_id ID of autocreated trip. 38 Oracle Order Management Suite APIs and Open Interfaces Manual . x_msg_count. x_trip_name Name of autocreated trip.

performs ‘ASSIGN’ action to the Delivery Details which are not already assigned. For ’ASSIGN. It also unassigns Delivery Details from a Delivery based on the IN parameter p_action value ’UNASSIGN.’ If the action is ’ASSIGN. The calling procedure decides whether to commit or rollback. Functional Overview This procedure assigns Delivery Details to a Delivery as specified by IN parameter p_action value ’ASSIGN. and returns an error in the return status. Delivery status. Ship To Locations and Ship From Locations. group by attributes defined in Shipping Parameters.’ there is no need to pass a Delivery ID or a Delivery Name as the procedure will just unassign all the Delivery Details from the Deliveries. Update_Shipping_Attributes: Updates a delivery detail with new information. and the Autocreate_Deliveries and Autocreate_Del_Trip procedures.’ either the Delivery ID or the Delivery Name need to be specified. ‘ASSIGN’ is allowed only for the Deliveries in the status of ‘OPEN’ or ‘PACKED’ and not Oracle Shipping Execution 11i Public APIs 39 . The Detail_To_Delivery procedure performs two actions: assign Delivery Details to a Delivery.Delivery Details Public Application Program Interface Delivery Details Public Application Program Interface The Delivery Details Public Application Program Interface (API) is a public API that consists of the following procedures in package WSH_DELIVERY_DETAILS_PUB: Detail_To_Delivery: Enables you to assign/unassign a delivery detail to/from a delivery Split_Line: Splits a delivery detail into two delivery details with the requested quantity summed up to the original delivery detail. If one of the Delivery Details is assigned to a delivery. Note: The creation of a delivery detail is not provided in the open API since it should be part of the order entry process. Detail_To_Delivery API Features The Detail_To_Delivery API has the following features. or unassign Delivery Details from a Delivery.’ If the action is ’UNASSIGN. the procedure continues to the next Delivery Detail.’ the procedure checks the Delivery Detail status. This section describes how to use the Delivery Details Public API and how it functions in Oracle Shipping Execution.

Parameter p_api_version_number p_init_msg_list x_return_status x_msg_count x_msg_data p_TabOfDelDets p_action p_delivery_id p_delivery_name Usage IN IN OUT OUT OUT IN IN OUT OUT Type Number Varchar2 Varchar2 Number Varchar2 Table Varchar2 Number Varchar2 x x Required x p_api_version_number Compares the incoming API call's version number with the current version number. Additional information on these parameters follows. p_init_msg_list Requests that the API initialize the message list on your behalf. All of the inbound and outbound parameters are listed. An error is returned if the version numbers are incompatible. then the list of messages must be retrieved using the call FND_ MSG_PUB. Security rules check if ship-to and ship-from location information and other optional group by attributes are common between delivery details and delivery. The values are: 40 Oracle Order Management Suite APIs and Open Interfaces Manual .DETAIL_TO_DELIVERY. a warning is posted in the return status. and the action continues to the next Delivery Detail. the Delivery status must be OPEN and not planned.DETAIL_TO_DELIVERY The following chart describes all parameters used by the public procedure WSH_ DELIVERY_DETAILS_PUB.GET.’ if one of the Delivery Details is unassigned already. Procedure Parameter Descriptions WSH_DELIVERY_DETAILS_PUB. return status posts a warning. If the x_msg_count is greater than 1. For ‘UNASSIGN.Delivery Details Public Application Program Interface planned. To allow ‘UNASSIGN’ action. If there is freight cost for the Delivery Detail.

’ If the action is ‘ASSIGN.G_RET_STS_ERROR Unexpected Error: FND_API. x_msg_data Returns error message text.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates number of error messages API has encountered.’ Oracle Shipping Execution 11i Public APIs 41 . If both the Delivery ID and Delivery Name are passed in. p_TabOfDelDets Table of Delivery Detail ID’s of type WSH_UTIL_CORE. the Delivery Name will be ignored.Delivery Details Public Application Program Interface s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s s where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively.ID_TAB_TYPE which is a table of type Number indexed by binary integers. then this contains the actual message. Default Value: FND_API.G_RET_STS_SUCCESS Error: FND_API. only the Delivery ID will be used to identify the Delivery.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function. p_delivery_id The Delivery ID to identify the Delivery. If the x_msg_count is equal to 1. p_action Valid values for the Action are: ‘ASSIGN’ and ‘UNASSIGN. not needed if the action is ‘UNASSIGN.’ the user needs to pass either the Delivery ID or the Delivery Name to identity which Delivery the Delivery Details are assigned to. Valid values include: s Success: FND_API.

not needed if the action is ‘UNASSIGN’ Error Handling Refer to parameters p_init_msg_list. 42 Oracle Order Management Suite APIs and Open Interfaces Manual . and x_msg_data on retrieving error messages.Delivery Details Public Application Program Interface p_delivery_name The Delivery Name to identify the Delivery. x_msg_count.

SPLIT_LINE The following chart describes all parameters used by the public procedure WSH_ DELIVERY_DETAILS_PUB. Functional Overview This API splits a Delivery Detail into two Delivery Details. the split quantity is not greater than the requested quantity before calling WSH_DELIVERY_DETAILS_ ACTIONS. Procedure Parameter Descriptions WSH_DELIVERY_DETAILS_PUB. After the split.SPLIT_LINE. Additional information on these parameters follows. or when a backorder occurs. the calling procedure needs to make another call to update the shipped quantity and backordered quantity to complete the whole transaction.Delivery Details Public Application Program Interface Split_Line API Features The Split_Line API has the following features: The Split_Line procedure enables you to split a Delivery Detail into two Delivery Details.Split_Delivery_Details. Parameter p_api_version_number p_init_msg_list p_commit p_validation_level x_return_status x_msg_count x_msg_data Usage IN IN IN IN OUT OUT OUT Type Number Varchar2 Varchar2 Number Varchar2 Number Varchar2 Required x Oracle Shipping Execution 11i Public APIs 43 .Split_Delivery_Details. the backorder quantity is NULL and that the split_from_detail_id points to the original Delivery Detail. Most of the validation is performed in WSH_ DELIVERY_DETAILS_ACTIONS. All of the inbound and outbound parameters are listed. Most of the fields in the new Delivery Detail have the same values except that the requested quantity is the split quantity. This procedure checks that the Delivery Detail is valid. A Delivery Detail needs to be split when ship partially. which checks that the quantity meets the decimal quantity standard. the shipped quantity is NULL.

Default Value: FND_API. p_init_msg_list Requests that the API initialize the message list. then the list of messages must be retrieved using the call FND_ MSG_PUB. If the x_msg_count is greater than 1. An error is returned if the version numbers are incompatible.G_RET_STS_SUCCESS Error: FND_API.G_FALSE.GET.G_RET_STS_UNEXP_ERROR s s 44 Oracle Order Management Suite APIs and Open Interfaces Manual . The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s s where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively.Delivery Details Public Application Program Interface Parameter p_from_detail_id x_new_detail_id x_split_quantity Usage IN OUT IN OUT Type Varchar2 Number Number Required x p_api_version_number Compares the incoming API call's version number with the current version number.’ Default Value: FND_API.G_RET_STS_ERROR Unexpected Error: FND_API.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function. p_commit Commits the transaction if this parameter is set to ‘TRUE. Valid values include: s Success: FND_API.

x_msg_count. then this contains the actual message.Delivery Details Public Application Program Interface x_msg_count Indicates number of error messages API has encountered. x_new_detail_id Delivery Detail ID of the new line being created after splitting the original line. x_msg_data Returns error message text. x_split_quantity Quantity out of the original Delivery Detail quantity allocated to the new Delivery Detail created after the split. If the x_msg_count is equal to 1. Oracle Shipping Execution 11i Public APIs 45 . p_from_detail_id The Delivery Detail ID of the line to be split. Error Handling Refer to parameters p_init_msg_list. and x_msg_data on retrieving error messages.

Delivery Details Public Application Program Interface Update_Shipping_Attributes API Features The Update_Shipping API has the following features: The Update_Shipping_Attributes procedure enables you to modify data in wsh_ delivery_details. Parameter p_api_version_number p_init_msg_list x_return_status x_msg_count x_msg_data p_changed_attributes p_source_code Usage IN IN OUT OUT OUT IN IN Type Number Varchar2 Varchar2 Number Varchar2 Record Varchar2 x x Required x p_api_version_number Compares the incoming API call's version number with the current version number. All of the inbound and outbound parameters are listed. Additional information on these parameters follows. And then it calls WSH_INTERFACE. Procedure Parameter Descriptions WSH_DELIVERY_DETAILS_PUB. Update_Shipping_Attributes. Functional Overview This procedure is called from the source system to modify data in wsh_delivery_ details to reflect any changes made by the source system including pick release.UPDATE_SHIPPING_ATTRIBUTES The following chart describes all parameters used by the public procedure WSH_ DELIVERY_DETAILS_PUB. An error is returned if the version numbers are incompatible. split source line and other update activities. The procedure checks that the attribute parameters passed in are valid and perform value to id conversion while validating. ship confirm.SPLIT_LINE. 46 Oracle Order Management Suite APIs and Open Interfaces Manual .

WSH_DELIVERY_DETAILS_PUB.Delivery Details Public Application Program Interface p_init_msg_list Requests that the API initialize the message list on your behalf.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates number of error messages API has encountered. then the list of messages must be retrieved using the call FND_ MSG_PUB.G_RET_STS_SUCCESS Error: FND_API. then this contains the actual message.ChangedAttributesTabType is a table of ChangedAttributesRecType indexed by Binary_Integer. If the x_msg_count is greater than 1. x_return_status Requests that the API return the status of the data for you after it completes its function. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s s where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively. Definition of ChangedAttributesRecType follows. Valid values include: s Success: FND_API. Default Value: FND_API.G_FALSE. x_msg_data Returns error message text.G_RET_STS_ERROR Unexpected Error: FND_API. If the x_msg_count is equal to 1. p_changed_attributes Attributes of ChangedAttributesTabType that are updated in wsh_delivery_details. Oracle Shipping Execution 11i Public APIs 47 .GET.

g_miss_num fnd_api.g_miss_ num fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_ num fnd_api. define ChangedAttributesRecType.g_miss_ num fnd_api.Delivery Details Public Application Program Interface p_source_code Code for source system which updates wsh_delivery_details table. Attribute source_header_id source_line_id sold_to_org_id customer_number sold_to_contact_id ship_from_org_id ship_from_org_code ship_to_org_id ship_to_org_code ship_to_contact_id deliver_to_org_id deliver_to_org_code deliver_to_contact_id intmed_ship_to_org_id intmed_ship_to_org_code intmed_ship_to_contact_id ship_tolerance_above ship_tolerance_below ordered_quantity Type Number Number Number Number Number Number Varchar2(3) Number Varchar2(3) Number Number Varchar2(3) Number Number Varchar2(3) Number Number Number Number Default Value fnd_api. For Update_Shipping_Attributes this should be ‘OE. Source system can only update delivery details that are created by the same source system.g_miss_ num fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_ num fnd_api.g_miss_num fnd_api.’ Record Parameter Descriptions ChangedAttributesRecType RECORD DEFINITION To encapsulate WSH_DELIVERY_DETAILS table definition and Value column equivalents for ID columns in a PL/SQL record.g_miss_num fnd_api.g_miss_ num fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_ num 48 Oracle Order Management Suite APIs and Open Interfaces Manual .

g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_date fnd_api.g_miss_char fnd_api.g_miss_ num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num Oracle Shipping Execution 11i Public APIs 49 .g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.Delivery Details Public Application Program Interface Attribute order_quantity_uom ordered_qty_unit_of_measure subinventory revision lot_number customer_requested_lot_flag serial_number locator_id date_requested date_scheduled master_container_item_id detail_container_item_id shipping_method_code carrier_id freight_terms_code freight_terms_name freight_carrier_code shipment_priority_code fob_code fob_name dep_plan_required_flag customer_prod_seq customer_dock_code gross_weight net_weight weight_uom_code weight_uom_desc volume Type Varchar2(3) Varchar2(25) Varchar2(10) Varchar2(3) Varchar2(30) Varchar2(1) Varchar2(30) Number Date Date Number Number Varchar2(30) Number Varchar2(30) Varchar2(30) Varchar2(30) Varchar2(30) Varchar2(30) Varchar2(30) Varchar2(1) Varchar2(50) Varchar2(30) Number Number Varchar2(3) Varchar2(50) Number Default Value fnd_api.g_miss_ num fnd_api.g_miss_num fnd_api.g_miss_ num fnd_api.g_miss_char fnd_api.g_miss_date fnd_api.g_miss_char fnd_api.

g_miss_num fnd_api. customer_number Should be a valid unique element of ra_customers.organization_code. ship_to_org_id Should be a valid element of org_organization_definitions.g_miss_char fnd_api.g_miss_char fnd_api.customer_number. 50 Oracle Order Management Suite APIs and Open Interfaces Manual . ship_from_org_code Should be a valid element of org_organization_definitions.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.organization_id.g_miss_num fnd_api.Delivery Details Public Application Program Interface Attribute volume_uom_code volume_uom_desc top_model_line_id ship_set_id ato_line_id arrival_set_id ship_model_complete_flag cust_po_number released_status packing_instructions shipping_instructions container_name container_flag delivery_detail_id Type Varchar2(3) Varchar2(50) Number Number Number Number Varchar2(1) Varchar2(50) Varchar2(1) Varchar2(2000) Varchar2(2000) Varchar2(50) Varchar2(1) Number Default Value fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.organization_id.g_miss_num Record Parameter Attribute Validations sold_to_org_id Should be a valid unique element of ra_customers.g_miss_char fnd_api.g_miss_char fnd_api. ship_from_org_id Should be a valid element of org_organization_definitions.customer_id.

organization_id. deliver_to_org_code Should be a valid element of org_organization_definitions. ordered_quantity Should be a non-negative whole number. delier_to_org_id Should be a valid element of org_organization_definitions.organization_id.’ freight_terms_code Should be a valid element of fnd_lookup_values_vl.’ Oracle Shipping Execution 11i Public APIs 51 .lookup_code for lookup_type ‘SHIP_METHOD.lookup_code for lookup_type ‘FREIGHT_TERMS. ship_tolerance_below Should be a non-negative number. intmed_ship_to_org_id Should be a valid element of org_organization_definitions. ship_tolerance_above Should be a non-negative number.Delivery Details Public Application Program Interface ship_to_org_code Should be a valid element of org_organization_definitions.unit_of_measure.organization_code. intmed_ship_to_org_code Should be a valid element of org_organization_definitions. order_quantity_uom Should be a valid element of mtl_items_uoms_view.organization_code. ordered_quantity_unit_of_measure Should be a valid element of mtl_items_uoms_view. shipping_method_code Should be a valid element of fnd_lookup_values_vl.organization_code.uom_code.

unit_of_measure for a weight uom class.meaning for lookup_type ‘FREIGHT_TERMS.’ dep_plan_required_flag Should be ‘Y’ or ‘N.uom_code for a volume uom class.’ fob_code Should be a valid element of fnd_lookup_values_vl.’ gross_weight Should be a non-negative number. 52 Oracle Order Management Suite APIs and Open Interfaces Manual . net_weight Should be a non-negative number. weight_uom_code Should be a valid element of mtl_units_of_measure.’ fob_name Should be a valid element of fnd_lookup_values_vl.Delivery Details Public Application Program Interface freight_terms_name Should be a valid element of fnd_lookup_values_vl. volume_uom_code Should be a valid element of mtl_units_of_measure.uom_code for a weight uom class weight_uom_desc Should be a valid element of mtl_units_of_measure. volume Should be a non-negative number.meaning for lookup_type ‘FOB.lookup_code for lookup_type ‘FOB.

’ or ‘X.unit_of_measure for a volume uom class. and x_msg_data on retrieving error messages. x_msg_count. ship_model_complete_flag Should be ‘Y’ or ‘N. Oracle Shipping Execution 11i Public APIs 53 .’ released_status Should be one of ‘R.’ Error Handling Refer to parameters p_init_msg_list.Delivery Details Public Application Program Interface volume_uom_desc Should be a valid element of mtl_units_of_measure.’ ‘Y.’ ‘S.

The procedure checks that the attribute parameters passed in are valid and perform value to ID conversion while validating.AUTOCREATE_DELIVERIES. The values are: s p_msg_index => I 54 Oracle Order Management Suite APIs and Open Interfaces Manual . An error is returned if the version numbers are incompatible. All of the inbound and outbound parameters are listed.Delivery Details Public Application Program Interface Autocreate_Deliveries API Features The Autocreate_Deliveries API has the following features: The Autocreate_Deliveries procedure is called from the source system to automatically create deliveries for multiple delivery lines. If the x_msg_count is greater than 1.AUTOCREATE_DELIVERIES The following chart describes all parameters used by the public procedure WSH_ DELIVERY_DETAILS_PUB.GET. p_init_msg_list Requests that the API initializes the message list on your behalf. then the list of messages must be retrieved using the call FND_ MSG_PUB. Procedure Parameter Descriptions WSH_DELIVERY_DETAILS_PUB. Additional information on these parameters follows. Parameter p_api_version_number p_init_msg_list p_commit x_return_status x_msg_count x_msg_data p_line_rows x_del_rows Usage IN IN IN OUT OUT OUT IN OUT Type Number Varchar2 Varchar2 Varchar2 Number Varchar2 Table Table x Required x p_api_version_number Compares the incoming API call's version number with the current version number.

Delivery Details Public Application Program Interface s p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively.G_RET_STS_ERROR Unexpected Error: FND_API. p_commit Commits the transaction if this parameter is set to ‘TRUE. x_del_rows Table of Deliveries of type WSH_UTIL_CORE. Oracle Shipping Execution 11i Public APIs 55 .ID_TAB_TYPE which is a table of type Number indexed by binary integers. Valid values include: s Success: FND_API.G_RET_STS_SUCCESS Error: FND_API. Default Value: FND_API. If the x_msg_count is equal to 1. then this contains the actual message.G_FALSE.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function. p_line_rows Table of Delivery Details of type WSH_UTIL_CORE.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates number of error messages API has encountered. x_msg_data Returns error message text.ID_TAB_TYPE which is a table of type Number indexed by binary integers.’ Default Value: FND_API.

and x_msg_data on retrieving error messages. x_msg_count.Delivery Details Public Application Program Interface Error Handling Refer to parameters p_init_msg_list. 56 Oracle Order Management Suite APIs and Open Interfaces Manual .

Procedure Parameter Descriptions WSH_DELIVERY_DETAILS_PUB. Parameter p_api_version_number p_init_msg_list p_commit x_return_status x_msg_count x_msg_data p_line_rows x_del_rows x_trip_id x_trip_name Usage IN IN IN OUT OUT OUT IN OUT OUT OUT Type Number Varchar2 Varchar2 Varchar2 Number Varchar2 Table Table Number Varchar2 x x x x Required x p_api_version_number Compares the incoming API call's version number with the current version number.AUTOCREATE_DEL_TRIP The following chart describes all parameters used by the public procedure WSH_ DELIVERY_DETAILS_PUB.AUTOCREATE_DEL_TRIP. Oracle Shipping Execution 11i Public APIs 57 .Delivery Details Public Application Program Interface Autocreate_Del_Trip API Features The Autocreate_Del_Trip API has the following features: The Autocreate_Del_Trip procedure is called from the source system to automatically create trips and deliveries for multiple delivery lines. An error is returned if the version numbers are incompatible. The procedure also checks that the attribute parameters passed in are valid and perform value to ID conversion while validating. All of the inbound and outbound parameters are listed. Additional information on these parameters follows.

ID_TAB_TYPE which is a table of type Number indexed by binary integers.G_RET_STS_ERROR Unexpected Error: FND_API. then this contains the actual message.Delivery Details Public Application Program Interface p_init_msg_list Requests that the API initialize the message list on your behalf.GET. then the list of messages must be retrieved using the call FND_ MSG_PUB. Default Value: FND_API. If the x_msg_count is equal to 1. p_line_rows Table of Delivery Details of type WSH_UTIL_CORE. x_msg_data Returns error message text.G_FALSE. 58 Oracle Order Management Suite APIs and Open Interfaces Manual . The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s s where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively. Valid values include: s Success: FND_API.’ Default Value: FND_API. If the x_msg_count is greater than 1.G_FALSE. x_return_status Requests that the API return the status of the data for you after it completes its function.G_RET_STS_SUCCESS Error: FND_API. p_commit Commits the transaction if this parameter is set to ‘TRUE.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates number of error messages API has encountered.

Delivery Details Public Application Program Interface x_del_rows Table of Deliveries of type WSH_UTIL_CORE. x_trip_id ID of autocreated trip. Oracle Shipping Execution 11i Public APIs 59 . x_trip_name Name of autocreated trip. and x_msg_data on retrieving error messages. Error Handling Refer to parameters p_init_msg_list.ID_TAB_TYPE which is a table of type Number indexed by binary integers. x_msg_count.

CREATE_CONTAINERS The following chart describes all parameters used by the public procedure WSH_ CONTAINER_PUB. Functional Overview This API creates a new container record in WSH_DELIVERY_DETAILS. It Inserts container information into WSH_DELIVERY_DETAILS and returns a table of the newly created container IDs. Update_Container: Updates an existing container record.CREATE_CONTAINERS. All of the inbound and outbound parameters are listed.Container Public Application Program Interface Container Public Application Program Interface The Container Public Application Program Interface (API) is a public API that consists of the four following procedures in package WSH_CONTAINER_PUB: Create_Container: Enables you to create a new container record. Create_Container API Features The Create_Container API has the following features. Parameter p_api_version_number p_init_msg_list p_commit Usage IN IN IN Type Number Varchar2 Varchar2 Required x 60 Oracle Order Management Suite APIs and Open Interfaces Manual . Container_Actions: Enables you to perform certain actions on a container. This section describes how to use the Container Public API and how it functions in Oracle Shipping Execution. Procedure Parameter Descriptions WSH_CONTAINER_PUB. Additional information on these parameters follows. It returns a table of container instance ids (delivery detail ids) along with the standard out parameters. The Create_Container procedure takes in a container item id or container item name and other necessary parameters to create one or more containers and creates the required containers. Auto_Pack: Lets you autopack containers.

An error is returned if the version numbers are incompatible. If the x_msg_count is greater than 1. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s s Oracle Shipping Execution 11i Public APIs 61 . then the list of messages must be retrieved using the call FND_ MSG_PUB.GET.Container Public Application Program Interface Parameter p_validation_level x_return_status x_msg_count x_msg_data p_container_item_id p_container_item_name p_organization_id p_organization_code p_name_prefix p_name_suffix p_base_number p_num_digits p_quantity p_container_name p_action x_container_ids Usage IN OUT OUT OUT IN IN IN IN IN IN IN IN IN IN IN OUT Type Number Varchar2 Number Varchar2 Number Varchar2 Number Varchar2 Varchar2 Varchar2 Number Number Number Varchar2 Varchar2 Table Required x x p_api_version_number Compares the incoming API call's version number with the current version number. p_init_msg_list Requests that the API initialize the message list on your behalf.

If the x_msg_count is equal to 1. 62 Oracle Order Management Suite APIs and Open Interfaces Manual . p_container_item_name Flexfield name for the container. Default Value: FND_API. then this contains the actual message. x_msg_data Returns error message text.Container Public Application Program Interface where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively. Valid values include: s Success: FND_API. p_organization_id Organization ID for the container.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function.G_RET_STS_SUCCESS Error: FND_API. p_container_item_id Key flexfield Id for the container.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates number of error messages API has encountered. p_name_prefix Prefix of the container name.G_RET_STS_ERROR Unexpected Error: FND_API. p_name_suffix Suffix of the container name. p_organization_code Organization code for the container.

x_msg_count. p_quantity Number of containers created. p_base_number Starting number for the numeric portion of the container name. x_container_ids Table of the newly created container IDs of type WSH_UTIL_CORE.ID_TAB_TYPE which is a table of type Number indexed by binary integers. p_container_name Container name if creating just one container. Oracle Shipping Execution 11i Public APIs 63 .Container Public Application Program Interface p_name_prefix Prefix of the container name. and x_msg_data on retrieving error messages. Error Handling Refer to parameters p_init_msg_list. p_num_digits Precision for the number of digits.

GET. Parameter p_api_version_number p_init_msg_list p_commit p_validation_level x_return_status x_msg_count x_msg_data p_container_rec Usage IN IN IN IN OUT OUT OUT IN Type Number Varchar2 Varchar2 Varchar2 Varchar2 Number Varchar2 Record x Required x p_api_version_number Compares the incoming API call's version number with the current version number. Functional Overview The API updates an existing container record in WSH_DELIVERY_DETAILS with the attributes input in the container rec type. The values are: s p_msg_index => I p_encoded => F s 64 Oracle Order Management Suite APIs and Open Interfaces Manual . The API validates the input record attributes before updating a container record. The name or the ID of the container being updated is passed as IN parameters p_container_name and p_cont_instance_ id respectively.Container Public Application Program Interface Update Container API Features The Trip_Action API has the following features: The Update_Container procedure enables you to update an existing container. then the list of messages must be retrieved using the call FND_ MSG_PUB. If the x_msg_count is greater than 1. p_init_msg_list Requests that the API initialize the message list on your behalf. It accepts as IN parameters the container information and the name/ID of the container being updated. An error is returned if the version numbers are incompatible.

g_miss_num Oracle Shipping Execution 11i Public APIs 65 . p_container_rec Attributes of the container entity of type ChangedAttributeRecType. define ChangedAttributeRecType and use this to pass trip information to the Update_Container routine.G_RET_STS_SUCCESS Error: FND_API.Container Public Application Program Interface s p_data => 1_message p_msg_index_out => 1_msg_index_out s where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively. x_msg_data Returns error message text. then this contains the actual message. Attribute source_header_id Type Number Default Value fnd_api. Record Parameter Descriptions TRIP_STOP_PUB_REC_TYPE RECORD DEFINITION To encapsulate WSH_DELIVERY_DETAILS table definition and Value column equivalents for ID columns in a PL/SQL record. Definition of ChangedAttributeRecType follows. Valid values include: s Success: FND_API.G_RET_STS_ERROR Unexpected Error: FND_API. Default Value: FND_API.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates number of error messages API has encountered. If the x_msg_count is equal to 1. These attributes are updated in WSH_DELIVERY_DETAILS.

g_miss_char fnd_api.g_miss_ num fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_ num fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_num fnd_api.g_miss_ num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_ num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.Container Public Application Program Interface Attribute source_line_id sold_to_org_id customer_number sold_to_contact_id ship_from_org_id ship_from_org_code ship_to_org_id ship_to_org_code ship_to_contact_id deliver_to_org_id deliver_to_org_code deliver_to_contact_id intmed_ship_to_org_id intmed_ship_to_org_code intmed_ship_to_contact_ id ship_tolerance_above ship_tolerance_below ordered_quantity order_quantity_uom ordered_qty_unit_of_ measure subinventory revision lot_number customer_requested_lot_ flag serial_number locator_id Type Number Number Number Number Number Varchar2(3) Number Varchar2(3) Number Number Varchar2(3) Number Number Varchar2(3) Number Number Number Number Varchar2(3) Varchar2(25) Varchar2(10) Varchar2(3) Varchar2(30) Varchar2(1) Varchar2(30) Number Default Value fnd_api.g_miss_char fnd_api.g_miss_ num fnd_api.g_miss_char fnd_api.g_miss_ num fnd_api.g_miss_ num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_ num 66 Oracle Order Management Suite APIs and Open Interfaces Manual .g_miss_char fnd_api.

g_miss_ num fnd_api.g_miss_date fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_date fnd_api.g_miss_char fnd_api.g_miss_char Oracle Shipping Execution 11i Public APIs 67 .g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_num fnd_api.Container Public Application Program Interface Attribute date_requested date_scheduled master_container_item_id detail_container_item_id shipping_method_code carrier_id freight_terms_code freight_terms_name freight_carrier_code shipment_priority_code fob_code fob_name dep_plan_required_flag customer_prod_seq customer_dock_code gross_weight net_weight weight_uom_code weight_uom_desc volume volume_uom_code volume_uom_desc top_model_line_id ship_set_id ato_line_id arrival_set_id ship_model_complete_ flag Type Date Date Number Number Varchar2(30) Number Varchar2(30) Varchar2(30) Varchar2(30) Varchar2(30) Varchar2(30) Varchar2(30) Varchar2(1) Varchar2(50) Varchar2(30) Number Number Varchar2(3) Varchar2(50) Number Varchar2(3) Varchar2(50) Number Number Number Number Varchar2(1) Default Value fnd_api.g_miss_char fnd_api.g_miss_ num fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.

customer_number Should be a valid unique element of ra_customers.g_miss_char fnd_api. deliver_to_org_code Should be a valid element of org_organization_definitions.organization_id. delier_to_org_id Should be a valid element of org_organization_definitions.organization_code.Container Public Application Program Interface Attribute cust_po_number released_status packing_instructions shipping_instructions container_name container_flag delivery_detail_id Type Varchar2(50) Varchar2(1) Varchar2(2000) Varchar2(2000) Varchar2(50) Varchar2(1) Number Default Value fnd_api.g_miss_char fnd_api. ship_to_org_id Should be a valid element of org_organization_definitions.g_miss_char fnd_api.organization_code.g_miss_char fnd_api.g_miss_char fnd_api.organization_id.organization_code. ship_to_org_code Should be a valid element of org_organization_definitions.customer_number ship_from_org_id Should be a valid element of org_organization_definitions.g_miss_char fnd_api. 68 Oracle Order Management Suite APIs and Open Interfaces Manual .g_miss_num Record Parameter Attribute Validations sold_to_org_id Should be a valid unique element of ra_customers.customer_id.organization_id. ship_from_org_code Should be a valid element of org_organization_definitions.

ship_tolerance_below Should be a non-negative number.organization_id.lookup_code for lookup_type SHIP_METHOD. order_quantity_uom Should be a valid element of mtl_items_uoms_view.meaning for lookup_type FREIGHT_TERMS. ship_tolerance_above Should be a non-negative number. fob_code Should be a valid element of fnd_lookup_values_vl. ordered_quantity Should be a non-negative whole number. shipping_method_code Should be a valid element of fnd_lookup_values_vl.uom_code. freight_terms_name Should be a valid element of fnd_lookup_values_vl.Container Public Application Program Interface intmed_ship_to_org_id Should be a valid element of org_organization_definitions. intmed_ship_to_org_code Should be a valid element of org_organization_definitions. freight_terms_code Should be a valid element of fnd_lookup_values_vl. Oracle Shipping Execution 11i Public APIs 69 .lookup_code for lookup_type FREIGHT_TERMS. ordered_quantity_unit_of_measure Should be a valid element of mtl_items_uoms_view.unit_of_measure.organization_code.lookup_code for lookup_type FOB.

uom_code for a volume uom class. net_weight Should be a non-negative number. volume Should be a non-negative number. gross_weight Should be a non-negative number. volume_uom_code Should be a valid element of mtl_units_of_measure. 70 Oracle Order Management Suite APIs and Open Interfaces Manual .unit_of_measure for a volume uom class.Container Public Application Program Interface fob_name Should be a valid element of fnd_lookup_values_vl.uom_code for a weight uom class weight_uom_desc Should be a valid element of mtl_units_of_measure. dep_plan_required_flag Should be Y or N. released_status Should be one of R. S. weight_uom_code Should be a valid element of mtl_units_of_measure. ship_model_complete_flag Should be Y or N.unit_of_measure for a weight uom class. Y or X. volume_uom_desc Should be a valid element of mtl_units_of_measure.meaning for lookup_type FOB.

and x_msg_data on retrieving error messages. Oracle Shipping Execution 11i Public APIs 71 . x_msg_count.Container Public Application Program Interface Error Handling Refer to parameters p_init_msg_list.

All of the inbound and outbound parameters are listed. The packing of lines and containers into parent containers is determined by the grouping id for each line/container. Additional information on these parameters follows.Container Public Application Program Interface Auto_Pack API Features The Auto_Pack API has the following features. the output table of ids will contain both the detail and parent containers' delivery detail ids. the API determines the grouping ids for the lines/containers based on the grouping attributes of the lines/containers.AUTO_PACK The following chart describes all parameters used by the public procedure WSH_ CONTAINER_PUB. The Auto_Pack procedure takes in a table of ids of either delivery lines or container or deliveries and autopacks the lines/containers/deliveries into detail containers and returns a table of container instance ids created during the autopacking process Functional Overview This API takes in a table of ids of either delivery lines or container or deliveries and autopacks the lines/containers/deliveries into detail containers. If the detail containers are packed into parent containers. If the grouping id table is not input. The API returns a table of container instance ids created during the autopacking operation. Procedure Parameter Descriptions WSH_CONTAINER_PUB. The grouping id table is used only if the input table of entities are lines or containers only. Parameter p_api_version_number p_init_msg_list p_commit p_validation_level x_return_status x_msg_count Usage IN IN IN IN OUT OUT Type Number Varchar2 Varchar2 Number Varchar2 Number Required x 72 Oracle Order Management Suite APIs and Open Interfaces Manual .AUTO_PACK. The lines/containers are then autopacked into detail containers and the detail containers are packed into parent/master containers based on whether the p_pack_cont_flag is set to 'Y' or 'N'.

then the list of messages must be retrieved using the call FND_ MSG_PUB. p_init_msg_list Requests that the API initialize the message list on your behalf.Container Public Application Program Interface Parameter x_msg_data p_entity_tab p_entity_type p_group_id_tab p_pack_cont_flag x_cont_inst_tab Usage OUT IN IN IN IN IN Type Varchar2 Table Varchar2 Table Varchar2 Table Required x p_api_version_number Compares the incoming API call's version number with the current version number. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s s where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively.GET.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function. Valid values include: s Success: FND_API. Default Value: FND_API.G_RET_STS_UNEXP_ERROR s s Oracle Shipping Execution 11i Public APIs 73 . An error is returned if the version numbers are incompatible. If the x_msg_count is greater than 1.G_RET_STS_ERROR Unexpected Error: FND_API.G_RET_STS_SUCCESS Error: FND_API.

Container Public Application Program Interface x_msg_count Indicates number of error messages API has encountered.containers or 'D' . x_msg_count. p_entity_type Type of entity id contained in the entity_tab that needs to be autopacked ('L' . If the x_msg_count is equal to 1. 74 Oracle Order Management Suite APIs and Open Interfaces Manual .lines. p_entity_tab Table of ids of either lines or containers or deliveries that need to be autopacked of type WSH_UTIL_CORE. x_msg_data Returns error message text. Error Handling Refer to parameters p_init_msg_list.ID_TAB_TYPE which is a table of type Number indexed by binary integers. and x_msg_data on retrieving error messages. p_pack_cont_flag A 'Y' or 'N' value to determine whether to autopack the detail containers that are created into parent containers. x_cont_inst_tab Table of container IDs created during the autopacking process of type WSH_UTIL_ CORE. p_group_id_tab Table of ids (numbers that determine the grouping of lines for packing into containers) of type WSH_UTIL_CORE.deliveries). 'C' .ID_TAB_TYPE which is a table of type Number indexed by binary integers.ID_TAB_TYPE which is a table of type Number indexed by binary integers. then this contains the actual message.

The input table of ids could be lines or containers.AUTO_PACK The following chart describes all parameters used by the public procedure WSH_ CONTAINER_PUB. All of the inbound and outbound parameters are listed. It accepts as IN parameters a table of delivery detail ids. The API determines what action to perform based on the action code and then calls appropriate private pack/assign/unpack/unassign API. The delivery lines and containers are separated from the input table and validated before the appropriate private APIs are called. Parameter p_api_version_number p_init_msg_list p_commit p_validation_level x_return_status x_msg_count x_msg_data p_detail_tab p_container_instance_id p_container_flag Usage IN IN IN IN OUT OUT OUT IN IN IN Type Number Varchar2 Varchar2 Number Varchar2 Number Varchar2 Table Number Table x Required x Oracle Shipping Execution 11i Public APIs 75 . Additional information on these parameters follows. and returns a completion status. If the action code is assigned then delivery id and delivery name must be specified. The Container_Actions procedure enables you to carry out actions on a container.CONTAINER_ACTIONS. an action code. Functional Overview This API takes in a table of delivery detail ids and name and/or delivery detail id of the container to pack. Procedure Parameter Descriptions WSH_CONTAINER_PUB. and any additional parameters needed for specific actions.Container Public Application Program Interface Container_Actions API Features The Container_Actions API has the following features.

G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates number of error messages API has encountered.G_RET_STS_ERROR Unexpected Error: FND_API.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s s where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively. 76 Oracle Order Management Suite APIs and Open Interfaces Manual .G_RET_STS_SUCCESS Error: FND_API. p_init_msg_list Requests that the API initialize the message list on your behalf.GET. If the x_msg_count is greater than 1. then the list of messages must be retrieved using the call FND_ MSG_PUB. An error is returned if the version numbers are incompatible. Valid values include: s Success: FND_API.Container Public Application Program Interface Parameter p_delivery_flag p_delivery_id p_delivery_name p_action_code Usage IN IN IN IN Type Varchar2 Number Varchar2 Varchar2 Required p_api_version_number Compares the incoming API call's version number with the current version number. Default Value: FND_API.

Container Public Application Program Interface x_msg_data Returns error message text. p_delivery_flag Y or N depending on whether the container needs to be unassigned from a delivery or not respectively.ID_TAB_TYPE which is a table of type Number indexed by binary integers. p_delivery_name Delivery name the container is assigned to. p_detail_tab Input table of delivery detail ids of type WSH_UTIL_CORE. or Unassign to specify which action to perform. Error Handling Refer to parameters p_init_msg_list. p_delivery_id Delivery ID the container is assigned to. Oracle Shipping Execution 11i Public APIs 77 . and x_msg_data on retrieving error messages. then this contains the actual message. p_action_code Action code Pack. If the x_msg_count is equal to 1. p_container_instance_id Delivery detail ID of parent container being packed p_container_name Container name if ID is not known p_container_flag Y or N depending on whether to unpack or not respectively. Unpack. x_msg_count. Assign.

It also updates an existing freight cost record in WSH_ FREIGHT_COSTS as specified by IN parameter p_action_code value ‘UPDATE.’ It inserts the freight cost information into WSH_FREIGHT_COSTS and returns the FREIGHT_COST_ID of the new freight cost record.Freight Costs Public Application Program Interface Freight Costs Public Application Program Interface The Freight Costs Public Application Program Interface (API) is a public API that consists of the following three procedures in package WSH_FREIGHT_COSTS_ PUB: Create_Update_Freight_Costs: Enables you to create a new freight cost record and update an existing freight cost record. and currency before performing the actions of creating or updating a freight cost record. delivery leg. The Create_Update_Freight_Costs procedure enables you to create a new freight cost record or update an existing freight cost record in WSH_FREIGHT_COSTS table. ensure that only one shipping entity—a trip. while a freight cost record of freight cost information is passed as an IN parameter. conversion rate. 78 Oracle Order Management Suite APIs and Open Interfaces Manual . and return status of a new freight cost record are passed as OUT parameters. Validate_Freight_Cost_Type and Delete_Freight_Costs: Enables you to delete a freight cost record. Create_Update_Freight_Costs API Features The Create_Update_Freight_Cost API has the following features. It also checks that the insert or update statements were successful. Also.’ The API validates freight information such as freight cost type. This section describes how to use the Freight Costs Public API and how it functions in Oracle Shipping Execution. and if not returns an error. unit amount. delivery. Each freight cost must be associated with only one shipping entity. Functional Overview This API creates a new freight cost record in WSH_FREIGHT_COSTS as specified by IN parameter p_action_code value ‘CREATE. stop. The FREIGHT_COST_ID. or delivery detail—is passed in to be associated with a freight cost record.

GET. then the list of messages must be retrieved using the call FND_ MSG_PUB. p_init_msg_list Requests that the API initialize the message list on your behalf. Parameter p_api_version_number p_init_msg_list x_return_status x_msg_count x_msg_data p_pub_freight_costs p_action_code x_freight_cost_id Usage IN IN OUT OUT OUT IN OUT IN OUT Type Number Varchar2 Varchar2 Number Varchar2 Record Varchar2 Number x x Required x p_api_version_number Compares the incoming API call's version number with the current version number. Additional information on these parameters follows.CREATE_UPDATE_FREIGHT_COSTS The following chart describes all parameters used by the public procedure WSH_ FREIGHT_COSTS _PUB. Default Value: FND_API. All of the inbound and outbound parameters are listed.G_FALSE Oracle Shipping Execution 11i Public APIs 79 .CREATE_UPDATE_FREIGHT_COSTS. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s s where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively. If the x_msg_count is greater than 1.Freight Costs Public Application Program Interface Procedure Parameter Descriptions WSH_FREIGHT_COSTS _PUB. An error is returned if the version numbers are incompatible.

80 Oracle Order Management Suite APIs and Open Interfaces Manual .G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates number of error messages API has encountered.Freight Costs Public Application Program Interface x_return_status Requests that the API return the status of the data for you after it completes its function. If the x_msg_count is equal to 1.G_RET_STS_SUCCESS Error: FND_API. p_action_code Specifies whether API should create a new freight cost record or update existing freight cost record information based on its values ‘CREATE’ or ‘UPDATE. Definition of PubFreightCostRecType follows.’ x_freight_cost_id ID of new freight cost record being created. These attributes are inserted/updated in WSH_FREIGHT_COSTS.G_RET_STS_ERROR Unexpected Error: FND_API. then this contains the actual message. x_msg_data Returns error message text. p_pub_freight_costs Attributes of the freight cost entity of type PubFreightCostRecType. Valid values include: s Success: FND_API.

define PubFreightCostRecType and use this to pass freight cost record information to the Create_Update_Freight_Cost routine.g_miss_date fnd_api.g_miss_num fnd_api.g_miss_char fnd_api. Attribute freight_cost_id freight_cost_type_id unit_amount currency_code conversion_date conversion_rate conversion_type_code trip_id trip_name stop_id stop_location_id planned_dep_date delivery_id delivery_name delivery_leg_id delivery_detail_id attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 Type Number Number Number Varchar2(15) Date Number Varchar2(30) Number Varchar2(30) Number Number Date Number Varchar2(30) Number Number Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Default Value fnd_api.g_miss_num fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_num fnd_api.g_miss_date fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.Freight Costs Public Application Program Interface Record Parameter Descriptions PubFreightCostRecType RECORD DEFINITION To encapsulate WSH_FREIGHT_COSTS table definition and Value column equivalents for ID columns in a PL/SQL record.g_miss_char Oracle Shipping Execution 11i Public APIs 81 .g_miss_num fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.

g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.freight_cost_id. 82 Oracle Order Management Suite APIs and Open Interfaces Manual .g_miss_date fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_date fnd_api.g_miss_num fnd_api.g_miss_char Record Parameter Attribute Validations freight_cost_id Should be a unique valid element of wsh_freight_cost_types.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_date fnd_api. freight_cost_type_id Should be a valid element of wsh_freight_cost_types.g_miss_num fnd_api.Freight Costs Public Application Program Interface Attribute attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 creation_date created_by last_update_date last_updated_by last_update_login program_application_id program_id program_update_date request_id freight_cost_type action_code Type Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Date Number Date Number Date Number Number Date Number Varchar2(30) Varchar2(30) Default Value fnd_api.freight_cost_type_id.g_miss_date fnd_api.

currency_code.stop_id. trip_name Should be a valid unique element of wsh_trips. currency_code Should be a valid element of fnd_currencies_vl. Oracle Shipping Execution 11i Public APIs 83 . trip_id Should be a valid unique element of wsh_trips. delivery_id Should be a valid unique element of wsh_new_deliveries.name delivery_leg_id Should be a valid element of wsh_delivery_legs.Freight Costs Public Application Program Interface unit_amount Should be a non-negative number.name stop_id Should be a valid unique element of wsh_trip_stops. stop_location_id Should be a valid element of wsh_trip_stops.delivery_leg_id. delivery_name Should be a valid unique element of wsh_new_deliveries. conversion_rate Should be a non-negative number.stop_location_id. delivery_detail_id Should be a valid element of wsh_delivery_details.planned_departure_date.delivery_detail_id. planned_dep_date Should be a valid element of wsh_trip_stops.trip_id.delivery_id.

and x_msg_data on retrieving error messages. x_msg_count. Error Handling Refer to parameters p_init_msg_list. 84 Oracle Order Management Suite APIs and Open Interfaces Manual .Freight Costs Public Application Program Interface freight_cost_type Should be a valid element of wsh_freight_cost_types.name.

G_RET_STS_SUCCESS Error: FND_API. Valid values include: s Success: FND_API. x_freight_cost_type_id Type Id of the freight cost being validated.DELETE_FREIGHT_COSTS The following chart describes all parameters used by the public procedure WSH_ FREIGHT_COSTS _PUB. while the freight cost id and a return status are passed as an OUT parameter.G_RET_STS_UNEXP_ERROR.Freight Costs Public Application Program Interface Validate_Freight_Cost_Type API Features The Validate_Freight_Cost_Type API has the following features. s s Oracle Shipping Execution 11i Public APIs 85 . The Validate_Freight_Cost_Type procedure enables you to validate an existing freight cost type from the WSH_FREIGHT_COST_TYPES table. All of the inbound and outbound parameters are listed. Parameter p_freight_cost_type x_freight_cost_type_id x_return_status Usage IN IN OUT OUT Type Varchar2 Varchar2 Varchar2 Required x p_freight_cost_type Freight coat type that needs to be validated. Additional information on these parameters follows. x_return_status Requests that the API return the status of the data for you after it completes its function.G_RET_STS_ERROR Unexpected Error: FND_API. Procedure Parameter Descriptions WSH_FREIGHT_COSTS _PUB.DELETE_FREIGHT_COSTS. The freight cost type is passed as an IN parameter.

DELETE_FREIGHT_COSTS. The Delete_Freight_Costs procedure enables you to delete an existing freight cost record from the WSH_FREIGHT_COSTS table. An error is returned if the version numbers are incompatible. It identifies the freight record being deleted by using the freight_cost_id attribute in the freight cost record that is being passed as an IN parameter. Functional Overview The Delete_Freight_Costs procedure enables you to delete a new freight cost record from WSH_FREIGHT_COSTS table.Freight Costs Public Application Program Interface Delete_Freight_Costs API Features The Delete_Freight_Costs API has the following features. A freight cost record of freight cost information of the freight cost record being deleted is passed as an IN parameter. Additional information on these parameters follows. All of the inbound and outbound parameters are listed. Parameter p_api_version_number p_init_msg_list x_return_status x_msg_count x_msg_data p_pub_freight_costs Usage IN IN OUT OUT OUT IN OUT Type Number Varchar2 Varchar2 Number Varchar2 Record x Required x p_api_version_number Compares the incoming API call's version number with the current version number. 86 Oracle Order Management Suite APIs and Open Interfaces Manual . Procedure Parameter Descriptions WSH_FREIGHT_COSTS _PUB.DELETE_FREIGHT_COSTS The following chart describes all parameters used by the public procedure WSH_ FREIGHT_COSTS _PUB.

G_FALSE x_return_status Requests that the API return the status of the data after it completes its function.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates number of error messages API has encountered. Valid values include: s Success: FND_API. p_pub_freight_costs Attributes of the freight cost entity of type PubFreightCostRecType. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s s where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively. then this contains the actual message. If the x_msg_count is greater than 1. If the x_msg_count is equal to 1.GET. These attributes are inserted/updated in WSH_FREIGHT_COSTS. Oracle Shipping Execution 11i Public APIs 87 .Freight Costs Public Application Program Interface p_init_msg_list Requests that the API initialize the message list on your behalf. then the list of messages must be retrieved using the call FND_ MSG_PUB. x_msg_data Returns error message text.G_RET_STS_ERROR Unexpected Error: FND_API. Definition of PubFreightCostRecType follows.G_RET_STS_SUCCESS Error: FND_API. Default Value: FND_API.

g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.Freight Costs Public Application Program Interface Record Parameter Descriptions PubFreightCostRecType RECORD DEFINITION To encapsulate WSH_FREIGHT_COSTS table definition and Value column equivalents for ID columns in a PL/SQL record.g_miss_num fnd_api.g_miss_num fnd_api.g_miss_num fnd_api.g_miss_date fnd_api.g_miss_char 88 Oracle Order Management Suite APIs and Open Interfaces Manual .g_miss_num fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_num fnd_api. we define PubFreightCostRecType and use this to pass Freight Cost information to the Delete_Freight_Cost routine. Attribute freight_cost_id freight_cost_type_id unit_amount currency_code conversion_date conversion_rate conversion_type_code trip_id trip_name stop_id stop_location_id planned_dep_date delivery_id delivery_name delivery_leg_id delivery_detail_id attribute_category attribute1 attribute2 attribute3 attribute4 attribute5 Type Number Number Number Varchar2(15) Date Number Varchar2(30) Number Varchar2(30) Number Number Date Number Varchar2(30) Number Number Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Default Value fnd_api.g_miss_num fnd_api.g_miss_date fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.

g_miss_date fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.freight_cost_id.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_char fnd_api.g_miss_num fnd_api. freight_cost_type_id Should be a valid element of wsh_freight_cost_types.g_miss_char fnd_api.g_miss_date fnd_api.g_miss_char fnd_api.freight_cost_type_id.g_miss_char fnd_api.g_miss_date fnd_api.g_miss_char fnd_api.g_miss_date fnd_api.g_miss_num fnd_api.g_miss_char fnd_api. Oracle Shipping Execution 11i Public APIs 89 .Freight Costs Public Application Program Interface Attribute attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute12 attribute13 attribute14 attribute15 creation_date created_by last_update_date last_updated_by last_update_login program_application_id program_id program_update_date request_id freight_cost_type action_code Type Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Varchar2(150) Date Number Date Number Date Number Number Date Number Varchar2(30) Varchar2(30) Default Value fnd_api.g_miss_char fnd_api.g_miss_num fnd_api.g_miss_char fnd_api.g_miss_char Record Parameter Attribute Validations freight_cost_id Should be a valid element of wsh_freight_cost_types.

currency_code Should be a valid element of fnd_currencies_vl. trip_id Should be a valid unique element of wsh_trips.delivery_leg_id. delivery_id Should be a valid unique element of wsh_new_deliveries. conversion_rate Should be a non-negative number.delivery_id.name delivery_leg_id Should be a valid element of wsh_delivery_legs. delivery_name Should be a valid unique element of wsh_new_deliveries. stop_location_id Should be a valid element of wsh_trip_stops.Freight Costs Public Application Program Interface unit_amount Should be a non-negative number.stop_location_id. 90 Oracle Order Management Suite APIs and Open Interfaces Manual .planned_departure_date. planned_dep_date Should be a valid element of wsh_trip_stops.stop_id. delivery_detail_id Should be a valid element of wsh_delivery_details. trip_name Should be a valid unique element of wsh_trips.trip_id.name stop_id Should be a valid unique element of wsh_trip_stops.currency_code.delivery_detail_id.

Freight Costs Public Application Program Interface freight_cost_type Should be a valid element of wsh_freight_cost_types. and x_msg_data on retrieving error messages. Error Handling Refer to parameters p_init_msg_list.name. x_msg_count. Oracle Shipping Execution 11i Public APIs 91 .

END WSH_SHIP_API. 92 Oracle Order Management Suite APIs and Open Interfaces Manual . x_msg_count OUT NUMBER.show errors package WSH_SHIP_API. For more information on the use of the package. x_msg_data OUT VARCHAR2). x_msg_count OUT NUMBER. see the sample script at the end of the package information. Both procedures are contained in the same package. procedure SHIP_CONFIRM_EXAMPLE2( x_return_status OUT VARCHAR2.Examples of APIs used in Simple Shipment Flows Examples of APIs used in Simple Shipment Flows The following examples demonstrate two simple procedures that use the shipping public APIs. / -. x_msg_data OUT VARCHAR2). Package Specification Create or replace package WSH_SHIP_API as procedure SHIP_CONFIRM_EXAMPLE1( x_return_status OUT VARCHAR2.

p_entity_type VARCHAR2(30). Call WSH_DELIVERY_DETAILS_PUB. p_pack_cont_flag varchar2(30). API to ship confirm the VARCHAR2.id_tab_type. Oracle Shipping Execution 11i Public APIs 93 . Call WSH_FREIGHT_COSTS_PUB.Update_Shipping_Attributes API to update the corresponding delivery details to ship all quantities in the first delivery detail. 18. init_msg_list VARCHAR2(30).Auto_Pack. 19. p_entity_tab WSH_UTIL_CORE. 16. p_validation_level NUMBER. 17. */ procedure SHIP_CONFIRM_EXAMPLE1( x_return_status OUT x_msg_count OUT x_msg_data OUT /* --Standard Parameters.Delivery_Action delivery. x_msg_summary VARCHAR2(3000).Create_Update_Freight_Costs API to create freight costs for the delivery that the details have been assigned to.Examples of APIs used in Simple Shipment Flows Package Body Create or replace package body WSH_SHIP_API as /* Example 1: This procedure can be used as an example on how to ship confirm a delivery consisting of delivery details that have already been pick released and assigned to a delivery.ChangedAttributeTabType. Call WSH_CONTAINER_PUB. p_group_id_tab WSH_UTIL_CORE.id_tab_type.Auto_Pack to pack the delivery lines into a container. to back order all in the second. changed_attributes WSH_DELIVERY_DETAILS_PUB. VARCHAR2) IS --Parameters for WSH_DELIVERY_DETAILS_PUB. --Parameters for WSH_CONTAINER_PUB. x_msg_details VARCHAR2(3000). p_commit VARCHAR2(30). source_code VARCHAR2(15).Update_Shipping_Attributes. Call WSH_DELIVERIES_PUB. NUMBER. to stage all in the third delivery detail. p_api_version_number NUMBER.

p_asg_dropoff_stop_id NUMBER.Examples of APIs used in Simple Shipment Flows x_cont_inst_tab WSH_UTIL_CORE.G_RET_STS_SUCCESS. p_asg_trip_name VARCHAR2(30).PubFreightCostRecType. p_sc_stage_del_flag VARCHAR2(10). p_asg_dropoff_loc_code VARCHAR2(30).Delivery_Action. p_sc_report_set_id NUMBER. p_wv_override_flag VARCHAR2(10). stage everything in the second line. action_code VARCHAR2(15). /* Values for updating delivery details to ship all quantities in the first line. x_trip_id VARCHAR2(30). x_trip_name VARCHAR2(30). p_sc_close_trip_flag VARCHAR2(10). p_sc_intransit_flag VARCHAR2(10). p_asg_pickup_loc_code VARCHAR2(30). /*Handle exceptions*/ fail_api EXCEPTION. p_sc_create_bol_flag VARCHAR2(10).Create_Update_Freight_Costs. p_sc_action_flag VARCHAR2(10). freight_cost_id NUMBER. p_asg_dropoff_arr_date DATE. p_delivery_id NUMBER. p_delivery_name VARCHAR2(30). --Parameters for WSH_FREIGHT_COSTS_PUB. p_asg_trip_id NUMBER. and back order all in the third. p_action_code VARCHAR2(15). p_sc_actual_dep_date VARCHAR2(30). pub_freight_costs WSH_FREIGHT_COSTS_PUB. p_asg_dropoff_loc_id NUMBER. p_asg_pickup_stop_id NUMBER. p_asg_pickup_arr_date DATE. BEGIN /* Initialize return status*/ x_return_status := WSH_UTIL_CORE. p_sc_report_set_name VARCHAR2(60). p_asg_pickup_loc_id NUMBER. p_asg_pickup_dep_date DATE. --Parameters for WSH_DELIVERIES_PUB. p_asg_dropoff_dep_date DATE. It 94 Oracle Order Management Suite APIs and Open Interfaces Manual .id_tab_type. p_sc_trip_ship_method VARCHAR2(30).

Stage All in this detail. -. WSH_DELIVERY_DETAILS_PUB. p_init_msg_list => init_msg_list.0. end if.unit_amount pub_freight_costs. --Call to WSH_DELIVERY_DETAILS_PUB. p_commit => p_commit.currency_code pub_freight_costs.0.Update_Shipping_Attributes. changed_attributes(3).source_line_id := 13433. x_return_status => x_return_status.cycle_count_quantity := 2. Oracle Shipping Execution 11i Public APIs 95 . /* Values for creating freight costs for the delivery created for the above delivery details. The delivery can be queried for the respective delivery detail through wsh_delivery_assignments. if (x_return_status <> WSH_UTIL_CORE.freight_cost_type_id pub_freight_costs. */ source_code := 'OE'.delivery_detail_id := 13431. changed_attributes(2). x_msg_data => x_msg_data. --Call to WSH_FREIGHT_COSTS_PUB. p_source_code => source_code). p_commit => p_commit. */ pub_freight_costs.Ship All quantities in this detail.Examples of APIs used in Simple Shipment Flows is assumed that the user knows the quantities in each line. -. changed_attributes(3).detail. changed_attributes(3).Create_Update_Freight_Costs.The only source code that should be used by the API changed_attributes(1).G_RET_STS_SUCCESS) then raise fail_api. changed_attributes(1).delivery_id := := := := 1.Update_Shipping_Attributes( p_api_version_number => 1. 20. 'USD'. changed_attributes(2).Back Order All in this -.shipped_quantity := 1. x_return_status => x_return_status. x_msg_count => x_msg_count.source_line_id := 13432.shipped_quantity := 0. changed_attributes(2).shipped_quantity := 0. p_init_msg_list => init_msg_list.cycle_count_quantity := 0. p_changed_attributes => changed_attributes.Create_Update_Freight_Costs( p_api_version_number => 1. 5341. -. WSH_FREIGHT_COSTS_PUB. -.

p_pack_cont_flag => p_pack_cont_flag.Examples of APIs used in Simple Shipment Flows x_msg_count => x_msg_count.The delivery name. */ p_action_code := 'CONFIRM'. p_entity_tab(2) := 13432.Call to WSH_DELIVERIES_PUB. -. */ p_entity_tab(1) := 13431.G_RET_STS_SUCCESS) then raise fail_api. 96 Oracle Order Management Suite APIs and Open Interfaces Manual . p_entity_tab => p_entity_tab. -. p_entity_tab(3) := 13434. end if. x_cont_inst_tab => x_cont_inst_tab). p_action_code => 'CREATE'. x_return_status => x_return_status.Close the trip after ship confirm p_sc_trip_ship_method := 'GROUND'. x_msg_data => x_msg_data. p_entity_type => 'L'.The ship method code -. p_commit => p_commit.G_RET_STS_SUCCESS) then raise fail_api. /* Values for Ship Confirming the delivery. --Call to WSH_CONTAINER_PUB. -.Auto_Pack( p_api_version => 1. -.Delivery_Action. -. /* Values for autopacking the delivery details to a container. x_msg_count => x_msg_count. p_init_msg_list => init_msg_list. -.The delivery that needs to be confirmed p_delivery_name := '5341'. if (x_return_status <> WSH_UTIL_CORE.Auto_Pack WSH_CONTAINER_PUB. end if. -. if (x_return_status <> WSH_UTIL_CORE.Ship entered quantity. p_group_id_tab => p_group_id_tab.In transit flag is set to 'Y' closes the -. p_sc_intransit_flag := 'Y'. p_sc_close_trip_flag := 'Y'. p_pub_freight_costs => pub_freight_costs. p_sc_action_flag := 'S'.pickup stop and sets the delivery in -.The action code for ship confirm p_delivery_id := 5341.0.transit. p_validation_level => p_validation_level. x_freight_cost_id => freight_cost_id). x_msg_data => x_msg_data.

p_sc_report_set_id => p_sc_report_set_id. exception when fail_api then WSH_UTIL_CORE. p_asg_pickup_arr_date => p_asg_pickup_arr_date. p_asg_pickup_stop_id => p_asg_pickup_stop_id. p_asg_dropoff_arr_date => p_asg_dropoff_arr_date. p_sc_report_set_name => p_sc_report_set_name. x_trip_name => x_trip_name). p_asg_trip_name => p_asg_trip_name. end if. p_init_msg_list => init_msg_list.get_messages('Y'.0. p_sc_stage_del_flag => p_sc_stage_del_flag. p_sc_action_flag => p_sc_action_flag. p_asg_pickup_loc_id => p_asg_pickup_loc_id. x_msg_data => x_msg_data. p_sc_actual_dep_date => p_sc_actual_dep_date.Examples of APIs used in Simple Shipment Flows WSH_DELIVERIES_PUB. p_delivery_name => p_delivery_name. x_msg_summary. p_sc_create_bol_flag => p_sc_create_bol_flag. else Oracle Shipping Execution 11i Public APIs 97 . p_sc_close_trip_flag => p_sc_close_trip_flag.Delivery_Action( p_api_version_number => 1. p_sc_trip_ship_method => p_sc_trip_ship_method. p_asg_pickup_dep_date => p_asg_pickup_dep_date. p_action_code => p_action_code. if (x_return_status <> WSH_UTIL_CORE. p_wv_override_flag => p_wv_override_flag. x_msg_count). x_msg_details. p_asg_pickup_loc_code => p_asg_pickup_loc_code. p_asg_trip_id => p_asg_trip_id. p_asg_dropoff_loc_code => p_asg_dropoff_loc_code. x_return_status => x_return_status. p_asg_dropoff_dep_date => p_asg_dropoff_dep_date. p_sc_intransit_flag => p_sc_intransit_flag. p_delivery_id => p_delivery_id. p_asg_dropoff_loc_id => p_asg_dropoff_loc_id. if x_msg_count > 1 then x_msg_data := x_msg_summary || x_msg_details. x_msg_count => x_msg_count. p_asg_dropoff_stop_id => p_asg_dropoff_stop_id. x_trip_id => x_trip_id.G_RET_STS_SUCCESS) then raise fail_api.

3.Delivery_Pub_Rec_Type. delivery_name VARCHAR2(30). name VARCHAR2(30). VARCHAR2(30).Parameters for WSH_DELIVERIES_PUB. 2. NUMBER.CREATE_UPDATE_DELIVERY to create a new delivery. p_asg_trip_id NUMBER. delivery_id NUMBER.Delivery_Action to ship confim. Call WSH_DELIVERY_DETAILS_PUB.CREATE_UPDATE_DELIVERY action_code VARCHAR2(15). p_delivery_name VARCHAR2(30). Call WSH_DELIVERIES_PUB. p_action VARCHAR2(30).Delivery_Action. p_api_version_number init_msg_list x_msg_details x_msg_summary p_validation_level commit OUT OUT OUT VARCHAR2. delivery_info WSH_DELIVERIES_PUB.id_tab_type.Detail_to_Delivery to assign the delivery details to the new delivery. p_delivery_id NUMBER. p_action_code VARCHAR2(15). 98 Oracle Order Management Suite APIs and Open Interfaces Manual . END SHIP_CONFIRM_EXAMPLE1.Standard Parameters. -. VARCHAR2(30). -. p_TabOfDelDets WSH_DELIVERY_DETAILS_PUB. VARCHAR2(3000). -.Parameters for WSH_DELIVERY_DETAILS_PUB.Examples of APIs used in Simple Shipment Flows x_msg_data := x_msg_summary. end if. VARCHAR2) IS NUMBER. NUMBER.Parameters for WSH_DELIVERIES_PUB. Call WSH_DELIVERIES_PUB. /** Example 2: This procedure can be used as an example on how to ship confirm delivery details that have originally not been assigned to a delivery. VARCHAR2(3000). **/ procedure SHIP_CONFIRM_EXAMPLE2( x_return_status x_msg_count x_msg_data -.Detail_to_Delivery p_delivery_id NUMBER. 1.

-. -.Examples of APIs used in Simple Shipment Flows p_asg_trip_name p_asg_pickup_stop_id p_asg_pickup_loc_id p_asg_pickup_loc_code p_asg_pickup_arr_date p_asg_pickup_dep_date p_asg_dropoff_stop_id p_asg_dropoff_loc_id p_asg_dropoff_loc_code p_asg_dropoff_arr_date p_asg_dropoff_dep_date p_sc_action_flag p_sc_intransit_flag p_sc_close_trip_flag p_sc_create_bol_flag p_sc_stage_del_flag p_sc_trip_ship_method p_sc_actual_dep_date p_sc_report_set_id p_sc_report_set_name p_wv_override_flag x_trip_id x_trip_name /*Handle exceptions*/ fail_api VARCHAR2(30).0. VARCHAR2(30). VARCHAR2(30).CREATE_UPDATE_DELIVERY( p_api_version_number => 1.CREATE_UPDATE_DELIVERY WSH_DELIVERIES_PUB.Create a new delivery for the following delivery_info. delivery_info. EXCEPTION. delivery_info. VARCHAR2(10). VARCHAR2(30). VARCHAR2(30).Values for WSH_DELIVERIES_PUB. NUMBER. VARCHAR2(10). VARCHAR2(60). p_init_msg_list => init_msg_list. DATE. VARCHAR2(10). NUMBER. DATE.ship_method_code := 'UPS'. VARCHAR2(10). NUMBER.Initialize return status x_return_status := WSH_UTIL_CORE.initial_pickup_location_id := 204. NUMBER. VARCHAR2(10). NUMBER.G_RET_STS_SUCCESS.gross_weight := 10. BEGIN -.ultimate_dropoff_location_id := 840. DATE. VARCHAR2(30). x_return_status => return_status. delivery_info. p_action_code := 'CREATE'. Oracle Shipping Execution 11i Public APIs 99 . DATE.Call to WSH_DELIVERIES_PUB.CREATE_UPDATE_DELIVERY -. VARCHAR2(10). x_msg_count => msg_count. VARCHAR2(30). x_msg_data => msg_data.

-. -. p_delivery_id pub_freight_costs.G_RET_STS_SUCCESS) then raise fail_api. 'S'. 'CONFIRM'.The action code for ship confirm 5341. if (x_return_status <> WSH_UTIL_CORE. p_validation_level => p_validation_level. p_delivery_name => delivery_name). p_action => p_action.0. x_return_status => return_status.Values for WSH_DELIVERY_DETAILS_PUB.The delivery name. end if. p_action := 'ASSIGN'. delivery_info. -. delivery_id. -. name ).Examples of APIs used in Simple Shipment Flows p_action_code p_delivery_info p_delivery_name x_delivery_id x_name => => => => => p_action_code. x_msg_data => msg_data. -. := delivery_id. p_TabOfDelDets(2) := 13464.Ship entered quantity. p_TabOfDelDets(1) := 13463.G_RET_STS_SUCCESS) then raise fail_api. ’Y'.Call to WSH_DELIVERY_DETAILS_PUB.Call Detail_to_Delivery with an action code of ASSIGN to assign details to a -. delivery_name. p_commit => commit.Detail_to_Delivery. -. if (x_return_status <> WSH_UTIL_CORE. -. WSH_DELIVERY_DETAILS_PUB.Detail_to_Delivery -. x_msg_count => msg_count.delivery_id := delivery_id. p_TabOfDelDets => p_TabOfDelDets.pickup stop and sets the delivery in 100 Oracle Order Management Suite APIs and Open Interfaces Manual .The delivery that needs to be confirmed '5341'.Detail_to_Delivery( p_api_version => 1.Values for Ship Confirming p_action_code := p_delivery_id := p_delivery_name := p_sc_action_flag := p_sc_intransit_flag := the delivery. p_delivery_id => p_delivery_id. end if.delivery. p_init_msg_list => init_msg_list. -.In transit flag is set to 'Y' closes the -.

p_sc_action_flag => p_sc_action_flag. -. p_delivery_name => p_delivery_name. p_asg_trip_name => p_asg_trip_name. p_sc_report_set_id => p_sc_report_set_id. if (x_return_status <> WSH_UTIL_CORE. p_sc_actual_dep_date => p_sc_actual_dep_date. p_sc_stage_del_flag => p_sc_stage_del_flag. := 'Y'. p_sc_trip_ship_method => p_sc_trip_ship_method. p_asg_pickup_loc_id => p_asg_pickup_loc_id. p_sc_report_set_name => p_sc_report_set_name. p_asg_dropoff_stop_id => p_asg_dropoff_stop_id.G_RET_STS_SUCCESS) then raise fail_api. x_msg_count => x_msg_count. x_trip_name => x_trip_name). p_sc_create_bol_flag => p_sc_create_bol_flag. exception when fail_api then Oracle Shipping Execution 11i Public APIs 101 . end if. -.transit. p_asg_pickup_dep_date => p_asg_pickup_dep_date. x_return_status => x_return_status.The ship method code -. p_action_code => p_action_code. p_wv_override_flag => p_wv_override_flag. p_asg_dropoff_loc_id => p_asg_dropoff_loc_id. p_asg_pickup_loc_code => p_asg_pickup_loc_code. p_asg_dropoff_arr_date => p_asg_dropoff_arr_date.Examples of APIs used in Simple Shipment Flows p_sc_close_trip_flag p_sc_trip_ship_method -. x_trip_id => x_trip_id. p_asg_pickup_stop_id => p_asg_pickup_stop_id.Delivery_Action( p_api_version_number => 1. p_asg_pickup_arr_date => p_asg_pickup_arr_date.Close the trip after ship confirm := 'UPS'. p_delivery_id => p_delivery_id. p_sc_intransit_flag => p_sc_intransit_flag. p_asg_dropoff_loc_code => p_asg_dropoff_loc_code. WSH_DELIVERIES_PUB. p_sc_close_trip_flag => p_sc_close_trip_flag. p_asg_dropoff_dep_date => p_asg_dropoff_dep_date. p_init_msg_list => init_msg_list. p_asg_trip_id => p_asg_trip_id.Call to WSH_DELIVERIES_PUB.Delivery_Action.0.

END WSH_SHIP_API. end if. else x_msg_data := x_msg_summary. 102 Oracle Order Management Suite APIs and Open Interfaces Manual . x_msg_summary. END SHIP_CONFIRM_EXAMPLE2.get_messages('Y'. x_msg_details. x_msg_count). / --show errors package body WSH_SHIP_API. --COMMIT.Examples of APIs used in Simple Shipment Flows WSH_UTIL_CORE. if x_msg_count > 1 then x_msg_data := x_msg_summary || x_msg_details.

Oracle Shipping Execution 11i Public APIs 103 . / VARCHAR2(15). End.put_line('The return status: '|| x_return_status).Examples of APIs used in Simple Shipment Flows Example of a Script set serveroutput on Declare x_return_status x_msg_count x_msg_data Begin WSH_SHIP_API. VARCHAR2(3000). dbms_output. x_msg_data => x_msg_data). SHIP_CONFIRM_EXAMPLE1( x_return_status => x_return_status. dbms_output. x_msg_count => x_msg_count. NUMBER.put_line(x_msg_data).

Examples of APIs used in Simple Shipment Flows 104 Oracle Order Management Suite APIs and Open Interfaces Manual .

5-1 Stop Public API. 5-11 Trip Public API. 2-127 transaction sources. 5-39 Freight Costs Public API. 2-130 invoice sources. 5-78 Introduction. 5-21 Delivery Details Public API. 5-60 Deliveries Public API.Index A AutoInvoice accounting rules. 2-124 I Internal sales orders Receivables Interface. 2-130 O OM Item Validation Organization. 2-124 invoicing rules. 2-130 internal sales orders. 2-128 ATO configurations. 5-2 Index-1 . 2-129 sales tax calculation. 2-131 credit methods. 2-70 S Shipping Execution APIs Container Public API.

Index-2 .

You're Reading a Free Preview

Download
scribd
/*********** DO NOT ALTER ANYTHING BELOW THIS LINE ! ************/ var s_code=s.t();if(s_code)document.write(s_code)//-->