0 Using Web Services With Order Management Cloud

March 2016
Using Web Services

with Order
Management
Copyright © 2005, 2015 Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions on use
and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license
agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit,
distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering,
disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you
find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf
of the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs
installed on the hardware, and/or documentation, delivered to U.S. Government end users are “commercial
computer software” pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental
regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any
operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be
subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S.
Government.
This software or hardware is developed for general use in a variety of information management applications. It is not
developed or intended for use in any inherently dangerous applications, including applications that may create a
risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to
take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation
and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous
applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their
respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used
under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD
logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a
registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information on content, products, and
services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all
warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its
affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party
content, products, or services.
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.
Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.
Contents
1 Using Web Services with Order Management Cloud ........................................... 5
Introduction ....................................................................................................................... 5
Terminology ................................................................................................................. 5
Usage Requirements and Capabilities .................................................................... 6
Receive Order Request Web Service ............................................................................ 7

Submit Draft Order Operation .................................................................................. 8
Process Order Request ..................................................................................................... 8
Entity Hierarchy That the Receive Order Request Service Supports .......................... 8
Logical Data Model of the Order Request Object ................................................ 9
Response Payload ............................................................................................................ 9

Example Successful Response Payload ................................................................ 12
Example Failed Response Payload ........................................................................ 12
2 Defining Your Source System .................................................................................. 13
3 Creating Cross-References ..................................................................................... 16
How Order Management Cross-References Customer Data .................................. 16
Creating Cross-References When Your Implementation Uses the Product

Model ............................................................................................................................... 17
Creating Cross-References When Your Implementation Uses the Product Hub .... 18
Using Reference Entities in the Order Management and Planning Repository ..... 19
4 Attributes That You Can Include in the Request Payload of Receive Order
Request Service .............................................................................................................. 20
Specifying Attributes in Groups ..................................................................................... 20
Specifying Coded Attributes and Their Partners ........................................................ 21
Attributes That Define the Order Header .................................................................... 22

Required Attributes That You Must Include in the Request Payload to
Define the Order Header ........................................................................................ 22
Optional Attributes That You Can Use in the Request Payload to Define the
Order Header ............................................................................................................ 23
Using Web Services with Order Management 3

Contents
Attributes That Define the Order Lines ......................................................................... 26

Required Attributes That You Must Include in the Request Payload to
Define Order Lines .................................................................................................... 27
Optional Attributes That You Can Include in the Request Payload to
Define the Order Lines ............................................................................................. 27
Attributes That Define Order Preferences .................................................................... 37
Other Optional Attributes That You Can Include in the Request Payload ............. 38
Source Transaction Information .............................................................................. 38
Lot Numbers and Serial Numbers ........................................................................... 39
Sales Credits .............................................................................................................. 39
Payments ................................................................................................................... 40
Attachments.............................................................................................................. 40
Document References............................................................................................. 41
Transaction Items ...................................................................................................... 42
Charges...................................................................................................................... 43
Charge Components ............................................................................................... 44
5 Processing Change Orders ..................................................................................... 45
6 Cancelling Orders .................................................................................................... 46
7 Using Security with Receive Order Request Service ............................................ 46
8 Using Receive Order Request Service with Configured Products ..................... 46
Validations That the Configurator Performs on Import Payloads ............................. 47
How the Service Resolves Missing Nodes in Import Payloads ................................... 47
How the Service Handles Quantities in Import Payloads ........................................... 48

9 Using Other Web Services ....................................................................................... 49
OrderInformationService................................................................................................ 49
GetOrderDetails Operation ........................................................................................... 49

Using Files to Import Source Orders ........................................................................ 50
4 Using Web Services with Order Management

1 Using Web Services with Order
Management Cloud
Introduction
You can use web services to create an integration with Order Management Cloud.
Various types of upstream systems and applications can use these web services, such
as:
• Channels
• Legacy systems
• Quoting systems
• Contract systems
• Service request systems
• Inventory systems
• Purchasing systems
For details about integrations and the architecture that Order Management uses, see
the section that describes the Order Management architecture in the Implementing
Order Management Guide on the Oracle Applications Help website at
https://fusionhelp.oracle.com.
Terminology
This document uses the following terminology:
• Source system. An order capture system or an application that sends the Order
Request object to the Order Import web service. For brevity, this document mentions
only source system.
• Internal. An action, process, or object that resides in Order Management. A cross-
reference that resides in the Order Management and Planning Repository is an
example of an internal object.
• External. An action, process, or object that resides outside of Order Management. A
source order that a source system creates in an order capture system is an example
of an external object.
• Source order. An order that a source system creates in an order capture system.
• Sales order. A source order that Order Management converts to a sales order so that
it can use it to fulfill the source order.

Using Web Services with Order Management Cloud ▪ Introduction
Usage Requirements and Capabilities

Note the following usage requirements and capabilities when you use the Order Import
web service:
• You must register each source system that sends the order request as a source
system. Multiple source systems might create a source order, so the web service
stores information that identifies the source system on the order so that it can track
the source system that sent the order. The web service uses the source system during
cross-referencing to determine the corresponding internal identifier or value
according to the identifier or value that is specific to the source system that sends the
source order.
• You must synchronize the customer master data before you import a source order.
Note that if the customer on the order does not exist in the Fusion Trading customer
model according to the preference CreateCustomerInformationFlag under the order
preferences in the service schema, then Order Management can create the
customer information. If you use Oracle Configure, Price, and Quote Cloud (CPQ),
then CPQ sends information about the fields that Order Management requires to use
this functionality, such as FreezePriceFlag, FreezeShippingChargeFlag, FreezeTaxFlag,
and so on.
• Use the Order Orchestration and Planning Repository for other reference entities. For
details, see Creating Cross-References.
• If the upstream system sends a change order, then it must send a revised order
request that includes the changed lines and the unchanged lines.
• You can send a priced source order, or the web service can price the source order
for you. If you use Oracle Configure, Price, and Quote Cloud, then the web service
assumes that the source order is already priced and will not allow price changes in
Order Management.
• You can send a booked source order or a source order that is in draft status. If the
source order is in draft status, then you must book the sales order that references the
source order. Order Management will not run the orchestration process that fulfills
your sales order until you book it. If the web service creates the order in draft status,
then you can submit it from the Order Management work area, or you can use the
submitdraftorder operation in the web service to submit it. If you use submitdraftorder,
then you must add the payload that defines it.
Sending Identifiers and Values
You can use attributes that include the word Identifier in their names to send the
identifier, such as Requesting Business Unit Identifier. If you send the identifier and the
value for this identifier, then the web service uses the identifier.
Master data includes customers and items. The source system can send different
information, depending on whether or not it uses the same master data and reference
data that Order Management uses:
• Uses the same data. The source system can send the Oracle identifier or the values.

Using Web Services with Order Management Cloud ▪ Receive Order Request Web Service
• Does not use the same data. The source system can send the identifiers and values
that it contains. The Order Import web service uses them as keys to look up the cross-
reference that resides in one of the following models, depending on whether or not
the key references a customer data or product data:
o Oracle Trading Community Model, and then resolve them into Oracle
customer data
o Oracle Fusion Product Model, and then resolve them into Oracle product
data
In most situations, each service uses a pair of synchronous and asynchronous operations,
and the service uses the following format to indicate synchronicity:
• Appends the operation name with Sync. The other operation in the pair is
asynchronous.
• Appends the operation name with Async. The other operation in the pair is
synchronous.
For example, GetOrderDetails and GetOrderDetailsAsync is a pair of services, and
GetOrderDetails is synchronous.
Receive Order Request Web Service

You can use ReceiveOrderRequestService to create an integration that sends order
requests from your upstream system to Order Management. This web service processes
the request, and then creates a sales order in Order Management. You can also use this
service to submit a draft sales order for fulfillment.
The following table describes interface information for the ReceiveOrderRequestService
services. It is a SOAP (Simple Object Access Protocol) service that uses the Order
Request Object as the payload. To view an example payload that includes typical
values, and to access a variety of other example payloads in XML format, see Doc ID
2051640.1 on My Oracle Support at https://support.oracle.com.
Table 1. Interface Information for ReceiveOrderRequestService

Information Description
Type Technical
Mandatory No
Service Name ReceiveOrderRequestService
Description This Service receives source orders from different Channel Systems
WSDL http://host:port/soa-
infra/services/default/DooDecompReceiveOrderExternalComposit
e/ReceiveOrderRequestService?WSDL
Input ReceiveOrderServiceRequestMessage
Output ReceiveOrderServiceResponseMessage
ReceiveOrderRequestService includes the following operations.

Using Web Services with Order Management Cloud ▪ Process Order Request
Table 2. Operations for ReceiveOrderRequestService

Operation Input Message Output Message
ProcessOrderReques ReceiveOrderServiceRequest ReceiveOrderServiceResponse
t Message Message
ProcessOrderReques ReceiveOrderServiceRequest ReceiveOrderServiceResponse
tSync Message Message
SubmitDraftOrder SubmitDraftOrderRequestMess SubmitDraftOrderResponseMess
age age
SubmitDraftOrderSyn SubmitDraftOrderRequestMess ReceiveOrderServiceResponse
c age Message
Submit Draft Order Operation

The SubmitDraftOrder operation of ReceiveOrderRequestService submits a draft order to
order fulfillment. It includes the following attributes.
Table 3. Attributes for the SubmitDraftOrder Operation of ReceiveOrderRequestService

Attribute Type Description
SourceTransactionIdentifier Value that uniquely identifies the
Varchar2 transaction.
Source system that placed the request for
SourceTransactionSystem Varchar2 fulfillment.
Process Order Request

You can use the processOrderRequest operation to create a sales order in Order
Management. Receive Order Request Service exposes a payload in the Order Request
object that consists of the order request header, order request lines, and child entities
that reside in the order header and the order line.
This topic describes the structure of Receive Order Request Service.
Entity Hierarchy That the Receive Order Request Service Supports

Receive Order Request Service supports the following entity hierarchy:
• Header
o Order Payment
o Order Sales Credit
o Order Attachments
o Order Lines
 Line LotSerial
 Line SalesCredit

Using Web Services with Order Management Cloud ▪ Response Payload
 Line Payments
 Line Document References
 Line Attachments
 Line Transactional Item Attributes
 Charge
 Charge Components
o Order Preferences
Logical Data Model of the Order Request Object

The following diagram illustrates the logical data model that the Order Request object uses.
Response Payload
Receive Order Request Service returns one of the following statuses:

• SUCCESS. The response includes the source keys and the Order Management DOO
keys. It sends this response after Order Management successfully creates the sales
order.
• FAILURE. The response includes the first validation error message.
The response payload uses the following structure:


Example Successful Response Payload

If Order Management successfully creates the sales order, then Receive Order Request Service
returns the following example payload:
<ns6:OrchestrationOrderRequestResponse>
<ns6:SourceOrderSystem>LEG</ns6:SourceOrderSystem>
<ns6:SourceOrderNumber>123</ns6:SourceOrderNumber>
<ns6:SourceOrderId>123</ns6:SourceOrderId>
<ns6:OrderNumber>456</ns6:OrderNumber>
<ns6:HeaderId/>34534534</ns6:HeaderId/>
<ns6:returnStatus>SUCCESS</ns6:returnStatus>
<ns6:messageName/>
<ns6:messageDescription/>
<ns6:Line>
<ns6:SourceLineNumber>1</ns6:SourceLineNumber>
<ns6:SourceScheduleNumber>2</ns6:SourceSchedule
Number>
<ns6:LineNumber>1</ns6:LineNumber>
<ns6:LineId>123323</ns6:LineId>
<ns6:FulfillLineNumber>
1</ns6:FulfillLineNumber>
<ns6:FulfillLineId>234234</ns6:FulfillLineId>
<ns6:messageName></ns6:messageName>
<ns6:messageDescription>
</ns6:messageDescription>
<ns6:Line/>
</ns6: OrchestrationOrderRequestResponse>
Example Failed Response Payload

If Order Management does not successfully create the sales order, then Receive Order Request
Service returns the following example payload:
<ns6:OrchestrationOrderRequestResponse>
<ns6:SourceOrderSystem>LEG</ns6:SourceOrderSystem>
<ns6:SourceOrderNumber>123</ns6:SourceOrderNumber>
<ns6:SourceOrderId>123</ns6:SourceOrderId>
<ns6:OrderNumber>456</ns6:OrderNumber>
<ns6:HeaderId/>34534534</ns6:HeaderId/>
<ns6:returnStatus>ERROR</ns6:returnStatus>
<ns6:messageName>
<ns6:messageDescription></ns6:messageDescription>
<ns6:Line>
<ns6:SourceLineNumber>1</ns6:SourceLineNumber>

Defining Your Source System ▪ Response Payload
<ns6:SourceScheduleNumber>2</ns6:SourceSchedule
Number>
<ns6:LineNumber>1</ns6:LineNumber>
<ns6:LineId>123323</ns6:LineId>
<ns6:FulfillLineNumber>
1</ns6:FulfillLineNumber>
<ns6:FulfillLineId>234234</ns6:FulfillLineId>
<ns6:messageName></ns6:messageName>
<ns6:messageDescription>A cross-referenced
value was not found for attribute TERM_ID in source
system LEG</ns6:messageDescription>
<ns6:Line/>
</ns6:OrchestrationOrderRequestResponse>
2 Defining Your Source System

You must define your source system in Order Management so that it can access the
reference data and master data that your source system uses. Defining the source
system allows Order Management to identify where the sales order originates and helps
to define the characteristics of this source system, such as whether it is an order capture
system or an order fulfillment system, and whether or not this source system requires
Order Management to perform cross-referencing when a user creates a sales orders in
Order Management. Order Management uses this information to establish cross-
reference values for various entities.
Define your source system

1. Log into Order Management.
2. In the Navigator, click Setup and Maintenance.
3. On the Setup and Maintenance page, in the search window, enter Manage
Trading Community Source Systems, and then click Search.
4. On the Create Source System page, set the following values.
Field Description
Code Enter a few characters that you can use to identify the
source system. For example, enter SEBL to identify a
source system that uses Siebel Order Capture.
Enter text that describes the source system. For example,
Name
enter Siebel Order Capture.
Type Choose one of the following values:
• Spoke. Identifies a spoke system, such as a legacy
system.
• Purchased. Identifies a purchased system, such as data
from a third party provider.

Field Description
Specify the following types of data that you will import:
• Enable for Items. Required. Import data for items.
• Enable for Trading Community Members. Required.
Import data for the trading community. Establishes the
Original System Unique Reference (OSR) for customer
entities.
Options • Enable for Order Orchestration and Planning. Required.

Import data for Order Orchestration.
• Enable for Assets. Optional. Import data for assets.
For example, if you add a check mark to Enable for
Trading Community Members, then you can choose the
source system as a data source on various pages in the
Order Management work area and the Order
Orchestration work area.
Administer your source system

1. On the Setup and Maintenance page, in the search window, enter Upstream, and
then click Search.
2. On the Search page, click Manage Upstream and Fulfillment Source Systems.
3. On the Manage Orchestration Source Systems page, in the Source Systems area,
click Actions, and then click Create.
4. In the Create Source System dialog, set the following values, and then click Save
and Close.
Field Description
Code Choose the code that you created above. For example,
choose SEBL.
Time Zone Choose the time zone that Global Order Promising and
Planning must use when they plan fulfillment for the sales
orders.
Version Choose Others.
Choose one of the following values:
• Fulfillment. Specifies the source system as a fulfillment
system where Order Management sends fulfillment
Order Orchestration requests and receives fulfillment replies.
Type • Order Capture. Specifies the source system as an order
capture system that sends source orders to Order
Management. You typically use Order Capture with
the import web service.
Collections Allowed Add a checkmark.

Field Description
Do one of the following:
• Add a checkmark if the source system expects Order
Enable Data Cross- Management to perform the cross-reference.
Reference • Do not add a checkmark if the source system uses the
same values that the setup in Fusion uses, and if you
have already set up these values in Fusion.
Location of the Oracle
Fusion Product Model
Not applicable. Note that Global Order Promising uses this
and Oracle Fusion
feature. Order Management does not use this feature.
Trading Community
Model

Creating Cross-References ▪ How Order Management Cross-References Customer Data
3 Creating Cross-References
Your source system sends identifiers or values that reside in the source system but not in
Order Management. Receive Order Request Service uses the cross-reference data that
collections creates for each reference entity. Personal Information Manager and Oracle
Trading Community Architecture maintain a cross-reference between the item master
data and customer master data that reside in Oracle, and the reference data that
resides in your source system.
If you must cross-reference a large volume of items, then it is recommended that you
use Open Interface tables to import them. You can automatically create cross-
references for a spoke system when you use item batches through Open Interface
tables or web services to import a spoke system item. For details about cross-references
and how to import them, see Doc ID 1311629.1 (Fusion PIM: Sample SQL to Import Items
Cross References into Fusion Product Information Management Using Open Interface
Tables) on My Oracle Support at https:// support.oracle.com.
How Order Management Cross-References Customer Data

Source System Management maintains cross-references between the TCA Registry
(Oracle Trading Community Architecture) and a source system that you define. It
records the Originating System reference and the Original System Unique Reference
(OSR) for each record that your source system sends. The web service uses the Original
System Unique Reference to map the identifier of the record that resides in the source
system to the registry identifier that resides in the record in TCA.
For example, assume your source system sends a record that includes an identifier value
of 12345. In this situation, the web service does the following:
1. Loads this record into the TCA Registry.
2. Assigns a registry ID of 100 for this record in the TCA Registry.
3. Creates a cross-reference between the source ID, 12345, and the registry ID, 100.
Order Management can use values, such as customer name, contact name, or
address, when it synchronizes the customer master data that resides in the Oracle
Customer Model repository that the Trading Community Model uses with the reference
data that resides on your source system. It expects that the value in the Oracle
Customer Model will match the value on your source system. If your source system sends
a value, then the web service will use it to resolve and identify the master data instead
of using the Original System Unique Reference.
Note the following:
• You can use attributes that include the phrase Orig System Reference in their names
to cross-reference the customer master data, such as:
o Buying Party Orig System Reference
o Ship To Address Orig System Reference

Creating Cross-References ▪ Creating Cross-References When Your Implementation Uses
the Product Model
o Bill To Address Orig System Reference

• To cross-reference the product or item data, use the Source System Product
Reference attribute.
Creating Cross-References When Your Implementation Uses the

Product Model
Order Management uses the Product Model to store the product definition. It uses the
Item Relationship Model in the Product Model to create a cross-reference between the
product that resides in the Product Model and the product that resides on the source
system. The Item Relationship Model allows Order Management to use a cross-reference
to create a relationship between an internal item and another item, or to use a source
system item to reference the item.
If your deployment uses only the Product Model, then you can use the item relationship
type known as Cross-References. The Product Model allows you to use a value and
cross-reference so that you can map more information about an item. For example, you
can map a cross-reference between an item and a part number in the source system,
where the value is the value of the part number that resides in the source system, and
the type is Source Item.
Order Management does not come predefined with cross-reference types. You must
use the Manage Cross Reference Types task to define the values. The lookup code must
match the value that the Orig System (ORIG_SYSTEM) contains in the source system
definition.
You can use item import or Item Service to manage the following types of item
relationships:
• Source System Item Relationship
• Item Cross-Reference
For details on how to use the item import or the service, see the documentation for the
Personal Information Manager on the Oracle Applications Help website at
For details about how to create cross-references, including using the Manage Item
Relationships page, see Doc ID 1309859.1 (Fusion PIM - Understanding Item Cross
References)on My Oracle Support at https:// support.oracle.com.
To create cross-references when your implementation uses the Product Model

1. In the Navigator, click Setup and Maintenance.
2. On the Setup and Maintenance page, in the search window, enter Manage
Standard Lookups, and then click Search.
3. On the Manage Standard Lookups page, in the Search area, in the Meaning field,
enter Item Cross Reference Types, and then click Search.
4. Make a note of the following rows that the Search Results list displays. You must add
the source system to each of these lookup codes:

Creating Cross-References ▪ Creating Cross-References When Your Implementation Uses the
Product Hub
• Charge Master
• Old Item Number
• Supplier Part Number
• Golden Tax Adaptor
5. Click Cancel.
6. Navigate to the Manage Item Relationships page.
7. In the Search Results area, click Actions, and then click Create.
8. In the Create Cross-Reference Relationship dialog, set the following values.
Field Description
Organization
Set to the organization where Order Management must
create the item relationship.
Do not modify this value. The dialog defaults the value in
Item
this field to the item that you must cross-reference.
Type You must set the Type to the same value that Order
Management uses when it cross-references the item that
resides on the source system.
9. Click Save and Close.
Order Management creates a cross-reference between the items that you specified.
Creating Cross-References When Your Implementation Uses the

Product Hub
If you implement the Oracle Product Data Hub instead of the Product Model, then
Order Management creates the product cross-reference in the Item Relationship Model
differently. It uses the Item Relationship Type for the source system item when it
establishes the cross-reference. This relationship is helpful when Order Management must
map and identify an item that it has consolidated from multiple source systems into a
single master item.
To create cross-references when your implementation uses the Product Hub

1. On the Manage Item Relationships page, click Actions, and then click Create.
2. In the Create Source System Item Relationship dialog, set the following values.
Field Description
Organization
Set to the organization where Order Management must
create the item relationship.
Choose the item that resides in the Product Model that
Item
you must cross-reference.
Source System Choose the source system that contains the item that you
must cross-reference.
Source System Item Enter a value that identifies the item that resides on the

Creating Cross-References ▪ Using Reference Entities in the Order Management and
Planning Repository
Field Description
source system. You must enter the value or the user key
that the source system uses to uniquely identify the item.
Choose the date when this relationship must go into
Start Date
effect.
3. Click Save and Close.
Order Management creates a cross-reference between the item that you specified
in the Item field and the item that you specified in the Source System Item field.
4. Repeat steps 1 through 3 for each item that you must cross-reference.
Using Reference Entities in the Order Management and Planning

Repository
You can use the Order Management and Planning repository to store data that you
collect from different order capture systems and fulfillment systems, and then use them
to reference various entities that Order Management uses during order import or to
resolve cross-references.
A global entity is an entity that references multiple instances of entities that reside in
multiple source systems. Data Collection collects entities into the Order Management
and Planning repository, validates them, and then consolidates them into a single
record that represents all of the entity instances in multiple systems. This single record is
the global entity. For details about these entities, see the Data Collection Entities:
Explained topic on the Oracle Applications Help website at
Data Collection also collects the transactions that are related to supply and demand so
that Global Order Promising can do planning and promising. You set up the source
system so that Order Management can store information that identifies the source of
records, and to manage this collection and consolidation process. The Order
Management and Planning repository uses this information so that it can identify the
source system where the information originated.
Data Collection can collect the following types of entities into the Order Management
and Planning Repository:
• Accounting rules
• Conversion types
• Currencies
• Demand classes
• Document categories
• FOBs
• Freight carriers
• Freight terms

Attributes That You Can Include in the Request Payload of Receive Order Request Service ▪
Specifying Attributes in Groups
• Invoicing rules
• Payment terms
• Receipt methods
• Return reasons
• Sales credit types
• Ship class of service
• Ship mode of transport
• Shipment priority
• Tax classification codes
• Tax exemption reason
• UOMs
• Warehouses
4 Attributes That You Can

Include in the Request
Payload of Receive Order
Request Service
This topic describes the attributes that you can include in the Request Payload of
Receive Order Request Service.
Specifying Attributes in Groups

To make sure the payload includes all the required information, the web service
processes some attributes as a group. For example, the web service examines the
following attributes as a group to make sure the payload identifies the buying party:
1. BuyingPartyId
2. BuyingPartyName
3. BuyingPartyNumber
The web service uses the following sequence when it processes each group of
attributes:
1. Use the attribute that specifies the identifier, such as BuyingPartyId.
2. If the attribute that specifies the identifier is empty, then use the attribute that
specifies the number, such as BuyingPartyNumber.
3. If the attribute that specifies the number is empty, then use the attribute that specifies
the name, such as BuyingPartyName.

Attributes That You Can Include in the Request Payload of Receive Order Request Service
▪ Specifying Coded Attributes and Their Partners
If the attribute that specifies the identifier includes a value, then the web service will
always use this value even if the attributes that specify the name or number are not
empty.
If the payload does not include a value for the identifier, name, or number, then your
order import will likely fail.
Specifying Coded Attributes and Their Partners

Some attributes, such as ReturnReasonCode, store an abbreviation for a longer term.
This abbreviation is typically text that the user can view to quickly identify the meaning
of a lookup value. You can think of the value of this attribute as coded. A coded
attribute typically includes a partner attribute. For example, the ReturnReason attribute
is the partner for ReturnReasonCode. If you provide a value only for the coded attribute
in the payload, then Order Management will use the value that the database cross-
references from the lookup value to the meaning. For example, it cross-references the
RET lookup value to the meaning for RET, which is Return. Continuing this example,
assume you set ReturnReasonCode=RET in the payload, and:
• You set ReturnReason=”Return Order”, then the web service will ignore this value and
use the code. This behavior is similar to using Identifier when you do not supply the
Name.
• You do not specify a value for ReturnReason, and if the value that the database
cross-references to the meaning is Return, then the web service will use Return for the
reason.
The web service uses this logic for each of the following sets of attributes.
Table 4. Coded Attributes and Their Partner Attributes

Coded Attribute Partner Attribute
AccountingRulecode AccountingRule
CancelReasonCode CancelReason
ChargeDefinitionCode ChargeDefinition
ChargeSubtypeCode ChargeSubType
DemandClassCode DemandClass
FOBPointcode FOBPoint
FreightTermsCode FreightTerms
InvoicingRuleCode InvoicingRule
OrderedUOMCode OrderedUOM
PaymentMethodCode PaymentMethod
PaymentTerm PaymentTermCode
RequestedFulfillmentOrganizationCode RequestedFulfillmentOrganizationName
RequestedSupplierCode RequestedSupplierName
ShipmentPriorityCode ShipmentPriority
ShippingCarrierCode ShippingCarrier
ShippingModeCode ShippingMode
ShippingServiceLevelCode ShippingServiceLevel

Attributes That Define the Order Header
Coded Attribute Partner Attribute

SubInventoryCode Subinventory
SubstitutionReasonCode SubstitutionReason
TaxExemptReasonCode TaxExemptReason
TransactionalCurrencyCode TransactionalCurrencyName
TransactionLineTypeCode TransactionLineType

This topic describes required and optional attributes that define the order header.
Required Attributes That You Must Include in the Request Payload to Define
the Order Header
The following table describes the attributes that you must include in the request payload
to define the order header.
Table 5. Required Attributes That You Must Include in the Request Payload to Define the
Order Header
BuyingPartyId Value that identifies the person,
company, or organization that placed
the source order, sometimes known as
Number the Sold To Customer.
TransactionalCurrencyCode Currency code for pricing the
TransactionOn Date and time that the transaction
started. This value identifies the date
that the customer committed to
purchase the items that this source
order contains. Order Management
uses this date to measure the time
Timestamp required to fulfill the sales order.
RequestingBusinessUnitIdentifier Value that identifies the internal
organization that sold the source
Number order.
SourceTransactionNumber Transaction number that the source
Varchar2 system uses.
SourceTransactionSystem Source system that placed the request
Varchar2 for fulfillment.
SourceTransactionRevisionNumb Revision number of the transaction.
er Varchar2

▪ Attributes That Define the Order Header
Optional Attributes That You Can Use in the Request Payload to Define the
Order Header
The following table describes the optional attributes that you can include in the request
payload to define the order header. You are not required to include them.
Table 6. Optional Attributes That You Can Include in the Request Payload to Define the
Order Header
BuyingPartyName Name of the person, company, or
organization that placed the source
order, also known as the Sold To
Varchar2 Customer.
BuyingPartyNumber Person, company, or organization
number that placed the source
order, also known as the Sold To
Varchar2 Customer.
BuyingPartyOrigSystemReference Cross-reference value for the person,
company, or organization number
that placed the source order. The
customer master in the TCA maintains
this value.
Varchar2
BuyingPartyContactId Value that identifies the person who
placed the source order or who is the
Number primary contact for the source order.
BuyingPartyContactName Name of the person who placed the
source order or who is the primary
Varchar2 contact for the source order.
BuyingPartyContactNumber Contact number for the person who
placed the source order or who is the
Varchar2 primary contact for the source order.
BuyingPartyContactOrigSystemRe Cross-reference value of the person
ference who placed the source order or who
is the primary contact for the source
order. The customer master in TCA
Varchar2 maintains this value.
CustomerPONumber The purchase order number that the
customer sends to identify the source
Varchar2 order.
TransactionalCurrencyName Currency name that Order
Management must use to price the
CurrencyConversionType Varchar2 Conversion type for foreign currency.
CurrencyConversionRate The exchange rate that Order
Number Management must use if it converts


the value from one currency to
another currency.
CurrencyConversionDate Date Currency conversion date.
TransactionDocumentTypeCode Indicates the type of request as one
of the following:
• Sales order
• Purchase order
• Internal material transfer
Varchar2
CancelReasonCode Brief text that identifies the cancel
Varchar2 reason.
CancelReason Varchar2 Reason for the cancel.
RequestCancelDate Time and day when the user
Date requested the cancel.
Comments Varchar2 Text that describes the transaction.
RequestingLegalUnitIdentifier Value that identifies the legal entity
that formed a contract with the
Number customer.
RequestingLegalUnit Name of the legal entity that formed
Varchar2 a contract with the customer.
OrigSysDocumentReference Document number from the source
Varchar2 system.
PartialShipAllowedFlag
Indicates how to ship the items that
the source order contains. Use one of
the following values:
• True. Ship items in multiple
shipments, if necessary.
• False. Ship all items in a single
shipment.
Varchar2
ShipToPartyIdentifier Value that identifies the party that
Varchar2 must receive the goods.
ShipToPartyName Name of the party that must receive
Varchar2 the goods.
ShipToPartyNumber Number that identifies the party that
Varchar2 must receive the goods.
ShipToAddress1 Address Line 1 of the ship-to
Varchar2 destination.
ShipToPartySiteIdentifier Value that identifies the party site of
Varchar2 the ship-to destination, such as 1036.
ShipToAddress3 Varchar2 Address Line 3 of the ship-to

▪ Attributes That Define the Order Header

destination.
ShipToCity Varchar2 City of the ship-to destination.
ShipToPostalCode Varchar2 Postal code of the ship-to destination.
ShipToState Varchar2 State of the ship-to destination.
ShipToProvince Varchar2 Province of the ship-to destination.
ShipToCounty Varchar2 County of the ship-to destination.
ShipToAddressOrigSystemReferen Cross-reference value of the address
ce for the ship-to destination.
ShipToContactPartyIdentifier Value that identifies the contact for

Varchar2 the shipping address.
ShipToContactPartyNumber Contact number for the shipping
Varchar2 address.
ShipToContactPartyName Contact name for the shipping
Varchar2 address.
ShipToContactPartyOrigSystemRef Cross-reference value of the party
erence Varchar2 contact.
BillToCustomerIdentifier Value that identifies the party that is
Varchar2 legally responsible for payment.
BillToPartyName Name of the party that is legally
Varchar2 responsible for payment.
BillToPartyNumber Number of the party that is legally
BillToPartySiteIdentifier Value that identifies the party that is
BillToAddress1 Address Line 1 of the party that is
BillToCity City of the party that is legally
BillToPostalCode Postal Code of the party that is
BillToState State of the party that is legally
BillToProvince Province of the party that is legally
BillToAddressOrigSystemReference Varchar2 Cross-reference value for the

Attributes That Define the Order Lines

account site.
BillToCounty County of the party that is legally
BillToAccountContactIdentifier Value that identifies the contact for
Varchar2 the billing address.
BillToAccountContactNumber Contact number for the billing
Varchar2 address.
BillToAccountContactOrigSystemR Cross-reference value of the
eference Varchar2 account contact.
BillToAccountContactName Varchar2 Contact name for the billing address.
The date when the document is
priced. Order Management
populates this attribute with the
system date at the beginning of a
PricedOn Date pricing process.
Indicates whether or not Order
Management can price a sales
order. Use one of the following
values:
• True. Can price a sales order.
• False. Cannot price a sales order.
FreezePricing Varchar2
Management can recalculate
shipping charges. Use one of the
following values:
• True. Can recalculate shipping
charges.
• False. Cannot recalculate shipping
charges.
FreezeShippingCharge Varchar2
Management can recalculate taxes.
Use one of the following values:
• True. Can recalculate taxes.
• False. Cannot recalculate taxes.
FreezeTax Varchar2
A value of CANCEL for this attribute
indicates to cancel the sales order.
OperationMode Varchar2 You can use only CANCEL.

This topic describes required and optional attributes that define the order lines.

▪ Attributes That Define the Order Lines
Required Attributes That You Must Include in the Request Payload to Define
Order Lines
The following table describes the attributes that you must include in the request payload
to define the order lines.
Table 7. Required Attributes That You Must Include in the Request Payload to Define the
Order Lines
SourceTransactionNumber Transaction number that resides in the
Varchar2 source system.
SourceTransactionSystem Name of the source system that
Varchar2 placed the request for fulfillment.
Varchar2 internal transaction.
SourceTransactionRevisionNumber Varchar2 Revision number of the transaction.
SourceTransactionLineIdentifier Value that uniquely identifies the
Varchar2 internal transaction line.
SourceTransactionLineNumber Line number of the transaction line.
Order Management uses this value to
Varchar2 sort transaction lines.
SourceTransactionScheduleIdentifi Value that uniquely identifies the
er Varchar2 source transaction schedule number.
SourceTransactionScheduleNumbe Line number of a schedule line,
r shipment line, or subline. The source
system assigned this value when it
captured the source order in the
Varchar2 source system.
ProductIdentifier Value that uniquely identifies the
internal product that Order
Management processes to fulfill the
Number sales order.
OrderedQuantity Quantity of the product that the
Number source system requested.
OrderedUOMCode Code for the unit of measure that the
source system requested, such as Unit
Varchar2 or Kg.
Optional Attributes That You Can Include in the Request Payload to Define the
Order Lines
payload to define the order lines. You are not required to include them.

Table 8. Optional Attributes That You Can Include in the Request Payload for the Order
Lines
ProductNumber SKU (stock keeping unit) that
Varchar2 identifies the product to fulfill.
ProductDescription Varchar2 Display name of the product.
SourceSystemProductReference Varchar2 Cross-Reference value of the item.
OrderedUOM Unit of measure of the requested
Varchar2 product, such as Unit or Kgs.
RequestedFulfillmentOrganizationId Value that identifies the requested
entifier Number fulfillment organization.
RequestedFulfillmentOrganizationCo Code that identifies the requested
de Varchar2 fulfillment organization.
RequestedFulfillmentOrganizationNa Name of the organization that
me Varchar2 shipped the sales order.
BusinessUnitIdentifier Value that identifies the business
Number unit.
BusinessUnitName Name of the internal organization
Varchar2 that fulfills the sales order.
RequestingBusinessUnitIdentifier Value that identifies the requesting
Number business unit.
RequestingBusinessUnitName Internal organization that started or
Varchar2 captured the transaction.
CancelReasonCode Brief text that identifies the cancel
Varchar2 reason.
CancelReason Varchar2 Reason for the cancel request.
SubstitutionAllowedFlag Indicates whether or not Order
Management can substitute the
order items during fulfillment. Use
one of the following values:
• True. Can substitute the order
items.
• False. Cannot substitute the order
items.
Varchar2
SubstitutionReasonCode Brief text that identifies the
Varchar2 substitution reason.
SubstitutionReason Varchar2 Reason for the substitution.
CustomerPONumber Purchase order number that the
Varchar2 buying party provides.
CustomerPOLineNumber Line number from the purchase
Varchar2 order that the buying party provides.
CustomerPOScheduleNumber Schedule number from the purchase
Varchar2 order that the buying party provides.
CustomerProductidentifier Number Value that identifies the customer


product number.
CustomerProductNumber Number that identifies the product
that the customer ordered. This
number resides in the customer item
Varchar2 table.
CustomerProductDescription Varchar2 Product description of an item.
TransactionLineTypeCode Code that identifies the transaction
Varchar2 line type.
TransactionLineType Type of line or action that resides in
the source system. Some example
values include Buy, Replace with,
Return For Credit, Upgrade, and so
Varchar2 on.
ParentLineReference Value that identifies the line that is
the parent of this line in a
configurable product hierarchy, or in
any other parent and child
Varchar2 relationship.
RootParentLineReference Value that identifies the line that
resides at the root of the
Varchar2 configurable product hierarchy.
ShippingInstructions Comment text for shipping
Varchar2 instructions.
PackingInstructions Comment text for packing
Varchar2 instructions.
InvoicingRuleCode Value that identifies the invoicing
Varchar2 rule.
InvoicingRule Name of the invoicing rule that
determines when to recognize the
receivable so that Order
Varchar2 Management can invoice it.
AccountingRulecode Brief text that identifies that identifies
Varchar2 the accounting rule.
AccountingRule Name of the accounting rule that
determines the accounting period
to use when recording the revenue
Varchar2 distribution for an invoice line.
RequestedShipDate Date that the customer specified to
Date ship the goods.
RequestedArrivalDate Date that the customer specified to
Date deliver the goods.
DemandClassCode Brief text that identifies the demand
Varchar2 class.
DemandClass Name of the demand class. A
Varchar2 demand class can represent the


following:
• A group of customers, such as
government customers or
commercial customers
• Sales channels
• Regions
• Different sources of demand,
such as retail, mail order, or
wholesale
ShippingCarrierCode Brief text that identifies the shipping
Varchar2 carrier.
ShippingCarrier Name of the carrier who delivered
Varchar2 the goods.
PaymentTerm The payment terms to use for this
Varchar2 payment.
PaymentTermCode Brief text that identifies the payment
Varchar2 term.
TransactionCategoryCode Brief text that identifies the
transaction category. Use one of the
following values:
• ORDER. Process a new source
order.
• RETURN. Process a return of an
existing sales order.
Varchar2
ReturnReasonCode Brief text that identifies the return
Varchar2 reason.
ReturnReason Reason why the customer must
Varchar2 return the product.
ScheduleShipDate Date that Order Management
Date scheduled to ship the goods.
ScheduleArrivalDate Date that Order Management
Date scheduled to deliver the goods.
ShippingServiceLevelCode Brief text that identifies the shipping
Varchar2 service level.
ShippingServiceLevel Level of service to use when
Varchar2 delivering the product.
ShippingModeCode Brief text that that identifies the
Varchar2 shipping mode.
ShippingMode Mode that Order Management
Varchar2 used to deliver the shipment.
ShipmentPriorityCode Varchar2 Brief text that identifies the shipment


priority.
ShipmentPriority Priority that specifies the urgency to
Varchar2 use when shipping the product.
InventoryOrganizationIdentifier Value that identifies the inventory
Number organization identifier.
InventoryOrganization Name of the inventory organization
Varchar2 that owns the product.
FreightTermsCode Brief text that identifies the freight
Varchar2 terms.
FreightTerms Terms for paying freight charges,
such as paid by shipper, collect,
Varchar2 prepaid, and so on.
RequestCancelDate Date when the customer requested
Date to cancel the source order.
OriginalProductIdentifier Value that identifies the internal
product that the customer
requested or ordered. Order
Management subsequently
substituted this product with some
Varchar2 other product.
OriginalProductDescription SKU (stock keeping unit) that
identifies the product that Order
Varchar2 Management fulfils.
OriginalProductNumber Display name of the product that
Varchar2 Order Management fulfils.
ShipToPartyIdentifier Value that identifies the ship-to party
Varchar2 name.
ShipToPartyName Name of the party that receives the
Varchar2 goods.
ShipToPartyNumber Number that identifies the party that
Varchar2 receives the goods.
ShipToAddress1 Varchar2 Address Line 1 of the ship-to party.
ShipToPartySiteIdentifier Value that identifies the party site
that receives the goods, such as
Varchar2 1036.
ShipToCity Varchar2 City of the ship-to party.
ShipToPostalCode Varchar2 Postal Code of the ship-to party.
ShipToState Varchar2 State of the ship-to party.
ShipToProvince Varchar2 Province of the ship-to party.
ShipToCounty Varchar2 County of the ship-to party.
ShipToAddressOrigSystemReference Varchar2 Cross-Reference value for the party


site.
ShipToContactPartyIdentifier Value that identifies the shipping

Varchar2 address of the ship-to contact.
ShipToContactPartyNumber Number of the contact for the
Varchar2 shipping address.
ShipToContactPartyName Name of the contact who resides at
Varchar2 the shipping address.
ShipToContactPartyOrigSystemRefer Cross-reference value for the party
ence Varchar2 contact.
BillToCustomerIdentifier Value that identifies the bill-to
Varchar2 customer.
BillToCustomerName Name of the party who is legally
BillToCustomerNumber Number of the party who is legally
BillToAccountSiteUseIdentifier Value that identifies the party site
who is legally responsible for
Varchar2 payment.
BillToAddress1 Address Line 1 of the party who is
BillToCity City of the party who is responsible
Varchar2 for payment.
BillToPostalCode Postal code of the party who is
BillToState State of the party who is responsible
Varchar2 for payment.
BillToProvince Province of the party who is
BillToAddressOrigSystemReference Cross-reference value for the
Varchar2 account site.
BillToCounty County of the party who is
BillToAccountContactIdentifier Value that identifies the bill-to
Varchar2 account contact.
BillToAccountContactNumber Number for the contact who resides
Varchar2 at the billing address.
BillToAccountContactOrigSystemRef Varchar2 Cross-reference value for the


erence account contact.
BillToAccountContactName Name of the contact who resides at
Varchar2 the billing address.
TaxExemptFlag Indicates whether or not the
transaction is exempt from taxation.
• True. Exempt from taxation.
• False. Not exempt from taxation.
Varchar2
TaxClassificationCode Brief text that identifies the tax
Varchar2 classification.
TaxExemptionCertificateNumber Number that identifies the tax
exemption certificate that a taxing
authority grants for a customer who
Varchar2 is tax exempt.
PartialShipAllowedFlag Indicates whether or not Order
Management can ship the items
that the sales order contains in
multiple shipments or only as one
shipment.
• True. Ship in multiple shipments, if
necessary.
• False. Ship in one shipment.
Varchar2
FulfillmentLineIdentifier Value that uniquely identifies a
fulfillment line. Order Management
can use this value to identify the
fulfillment line that it is referencing in
Number the context of the change.
ShipToRequestRegion Identifies the region of the ship-to
request. Global Order Promising uses
this attribute to process a sales order
Varchar2 according to region.
RequestedSupplierCode Brief text that identifies the supplier
Varchar2 name.
RequestedSupplierName Name of the supplier who is
responsible for shipping the product.
You can specify a supplier
according to a contractual
Varchar2 obligation in a drop ship flow.
RequestedSupplierNumber Number that identifies the supplier
who is responsible for shipping the
Varchar2 product. You can specify a supplier


according to a contractual
obligation in a drop ship flow.
RequestedSupplierSiteCode Brief text that identifies the
Varchar2 requested supplier site.
SupplierAddressLine1 Address Line 1of the organization
Varchar2 that supplies and ships the items.
SupplierAddressLine2 Address Line 2 of the organization
SupplierAddressCity City of the organization that supplies
Varchar2 and ships the items.
SupplierAddressState State of the organization that
Varchar2 supplies and ships the items.
SupplierAddressPostalCode Postal code of the organization that
SupplierAddressProvince Province of the organization that
SupplierAddressCounty County of the organization that
SupplierAddressCountry Country of the organization that
Comments Text that the user can use to add
information that is related to the
Varchar2 order line.
UnitListPrice List price of the item prior to any
Number discounts and adjustments.
UnitSellingPrice Selling price of the product with
Number discounts and adjustments applied.
DestinationShipppingOrganizationId Value that identifies the
entifier organization that receives the
shipment.
Number
DestinationShippingLocationIdentifie Value that identifies the shipment
r destination.
Number
EarliestAcceptableShipDate Date that specifies the earliest time
that the customer is willing to ship
Date the sales order.
LatestAcceptableShipDate Date that specifies the latest time
that the customer is willing to ship
Date the sales order.


LatestAcceptableArrivalDate Date that specifies the latest time
that the customer is willing to
receive the sales order at the ship-to
Date address.
PromiseShipDate Date that the fulfillment process
promised to the customer that the
Date item would ship.
PromiseArrivalDate Date that the fulfillment process
promised to the customer that the
item would arrive at the ship-to
Date address.
SubInventoryCode Brief text that identifies the
Varchar2 subInventory.
Subinventory
Varchar2 Subinventory.
FOBPointcode Brief text that identifies the FOB
Varchar2 point.
FOBPoint Location where the seller is willing to
pay for transportation of the goods
to the port of shipment, plus loading
Varchar2 costs.
ExtendedAmount Monetary value for the fulfill line
Number quantity.
ShipSetName Varchar2 Name of the shipment set.
Name of the country that Order
DefaultTaxationCountry Varchar2 Management uses to calculate tax.
Registration number that Order
Management sends to the supplier.
The supplier uses this number to tax
FirstpartyTaxRegistration Number the transaction.
Registration number that the
customer specifies in the purchase
ThirdpartyTaxRegistration Number order.
Name of the sub type that Order
Management uses to calculate tax
and tax reporting, depending on
the requirements of different
DocumentSubType Varchar2 countries.
Final destination location for the
FinalDischargeLocationIdentifier Number purchases that the customer makes.
Fiscal category of the product that
the tax authority uses. For tax
ProductFiscalCategoryIdentifier Number purposes.
Specifies one of the following types
ProductType Varchar2 for the transaction line:

• Goods
• Services
Classifies the product for tax
purposes. If your deployment does
not use Oracle Inventory to classify
products for tax purposes, then
Order Management uses the
ProductCategory Varchar2 product category.
Category of a transaction that a tax
authority might require. For tax
TransactionBusinessCategory Varchar2 purposes.
Price that a tax authority uses to
AssessableValue Number value a product. For tax purposes.
Classification of the transaction into
different categories. For tax
UserDefinedFiscClass Varchar2 purposes.
Identifies the intended use. For tax
IntendedUseClassificationIdentifier Number purposes.
Brief text that identifies the tax
TaxExemptReasonCode Varchar2 exempt reason.
The reason to grant and take a tax
TaxExemptReason Varchar2 exemption.
Total quantity for a configured
product. This value is a sum of the
requested quantity of the
components that a configured
product contains. The configurator
ExtendedQuantity Number populates and uses this attribute.
Path to the inventory item identifier
for the parent of this line. The
configurator populates and uses this
ComponentIdPath Varchar2 attribute.
Contains one of the following
values:
• True. Configuration is valid.
• False. Configuration is not valid.
The configurator expects that any
application that calls the
configurator will not book a sales
order.
The web service populates this
IsValidConfiguration Varchar2 attribute only for the root order line.

▪ Attributes That Define Order Preferences

The configurator populates and uses
this attribute.
Runtime representation of the path
to the Inventory Item Id for the
component. The configurator
ConfiguratorPath Varchar2 populates and uses this attribute.
Header Id of the configuration. The
configurator populates and uses this
ConfigHeaderId Number attribute.
Revision number of the
configuration. The configurator
ConfigRevisionNumber Number populates and uses this attribute.
A value of CANCEL for this attribute
indicates to cancel the order line.
OperationMode Varchar2 You can use only CANCEL.
Attributes That Define Order Preferences

This topic describes attributes that define order preferences.
Table 9. Attributes That Define Order Preferences

CreateCustomerInformationFlag
Indicates whether or not to create
information for missing attributes. Use
• True. Create the missing attribute.
For example, if the Sold-to attribute
and the Ship-to attribute are each
missing, then create a Sold-to
attribute and a Ship-to attribute.
• False. Do not create the missing
attribute.
Varchar2
SubmitFlag
Indicates whether or not to submit the
sales order if an attribute does not
contain a value. Use one of the
following values:
• True. If an attribute does not
contain a value, then submit the
sales order.
False. If an attribute does not contain
Varchar2 a value, then do not submit the sales

Other Optional Attributes That You Can Include in the Request Payload

order.
To create a sales order in draft status,

the user must send a value of false for
each attribute. You can then use the
SubmitDraftOrder service to submit a
draft order for processing.
Other Optional Attributes That You Can Include in the Request

Payload
This topic describes other optional attributes that you can include in the request
payload. You are not required to define them.
Source Transaction Information

payload for the source transaction. You typically include this information when you
specify one of the following items:
• Lot Numbers and serial numbers
• Sales credits
• Payments
• Attachments
• Document references
• Transaction items
• Charges
• Charge components
Table 10. Optional Attributes That You Can Include in the Request Payload to Define
Source Transaction Information
SourceTransactionNumber Varchar2 External transaction number.
SourceTransactionSystem Name of the source system that
Varchar2 placed the request for fulfillment.
Varchar2 internal transaction.
Varchar2 internal transaction line.
SourceTransactionScheduleIdentifier Value that uniquely identifies the
Varchar2 internal transaction for a schedule,

▪ Other Optional Attributes That You Can Include in the Request Payload

shipment, or subline. The source
system assigns this value.
Lot Numbers and Serial Numbers

payload to define lot numbers and serial numbers.
Table 11. Optional Attributes That You Can Include in the Request Payload for Lot
Numbers and Serial Numbers
SourceTransactionLotIdentifier Value that uniquely identifies the internal
lot. The source system assigns this value.
LotNumber Number assigned to a quantity of items
for identification purposes. A lot number is
an identification number that a
manufacturer assigns to a quantity of
material, typically for quality control.
Some manufacturers combine the lot
number with the serial number to form an
Varchar2 identification number.
SerialNumberFrom Starting serial number of a range of serial
Varchar2 numbers.
SerialNumberTo Ending serial number of a range of serial
Varchar2 numbers.
ItemRevisionNumber Varchar2 Number that identifies the revision.
LocatorIdentifier Value that identifies the locator where
Order Management ships the item from
Number or received into.
Sales Credits
payload to define sales credits.
Sales Credits
SourceTransactionSalesCreditIdentifier Value that uniquely identifies the
internal sales credit. The source
Varchar2 system assigns this value.
SalesPersonIdentifier Value that uniquely identifies the
Number internal salesperson. The source


system assigns this value.
Brief text that identifies the sales
SalesCreditTypeCode Varchar2 credit type.
Foreign key that references the
sales credit type. This type is
SalesCreditTypeReference Varchar2 Revenue or Non Revenue.
Percent Number that specifies the sales
credit percentage for a
Number salesperson.
Payments
payload to define payments.
Payments
PaymentMethodCode Brief text that identifies the payment
Varchar2 method.
PaymentMethod Payment method that is associated
with the payment instrument for the
Varchar2 customer account.
PaymentTransactionIdentifier Value that identifies the payment
information. The source system
Number contains this value.
PaymentSetIdentifier Value that uniquely identifies a
group of payments that belong to
one prepaid order. If the set
identifies a prepayment, then the
Number foreign key references billing.
SourceTransactionPaymentIdentifier Value that uniquely identifies the
internal payment. The source
Varchar2 system assigns this value.
Attachments
payload to define attachments.
Attachments


Title Varchar2 Title of the document.
FileContent Mime type for BLOB (Binary Large OBject)
Varchar2 attachment.
FileName File name of the attached document. If the
attachment is a URL, then Order Management
Varchar2 does not use this attribute.
Data Blobdomain Data that the attachment contains.
Description Varchar2 Description of the attachment.
URL Varchar2 URL.
DataTypeCode Varchar2 Type of attachment.
Document References
payload to define document references. The service currently accepts only the original
sales order or order line reference when creating a return line for the document
reference entity.
Document References
DocumentReferenceType Type of business document or
object that the source order
references, such as asset, sales
Varchar2 order, or purchase order.
DocumentIdentifier Value that uniquely identifies the
Varchar2 document.
DocumentAdditionalIdentifier Value that identifies more qualifiers
for the ID. Used when multipart
Varchar2 keys are present.
DocumentNumber User-friendly number that identifies
the document, such as asset
number, sales order number, or
Varchar2 purchase order number.
DocumentAdditionalNumber Number that identifies the
document. You can use it as
another way to identify the object
instance. You can use it to
capture more identifying details,
Varchar2 as necessary.
DocumentLineIdentifier Value that uniquely identifies the
document line. Order
Management creates this value
Varchar2 internally.


DocumentAdditionalLineIdentifier Value that identifies more qualifiers
for the document line. Used when
Varchar2 multipart keys are present.
DocumentLineNumber User-friendly number that identifies
the document line, such as the line
number in a sales order, or the line
Varchar2 number in a purchase order.
DocumentAdditionalLineNumber Number that identifies the
document line. You can use it as
another way to identify the object
instance. You can use it to
DocumentSubLineIdentifier Value that uniquely identifies the
document subline. Order
Management creates this value
Varchar2 internally.
DocumentAdditionalSubLineIdentifier Value that identifies more qualifiers
for the subline. Used when
Varchar2 multipart keys are present.
DocumentSubLineNumber User-friendly number that identifies
Varchar2 the subline.
DocumentAdditionalSubLineNumber Number that identifies the
document subline. You can use it
as another way to identify the
object instance. You can use it to
Transaction Items
payload to define transaction items.
Transaction Items
TransactionAttributeName Varchar2 Item attribute name.
CharacterValue Varchar2 Item attribute value of type character.
NumberValue Number Item attribute value of type number.
DateValue Date Item attribute value of type date.
TimestampValue Timestamp Item attribute value of type time.

Charges
payload to define charges.
Charges
BatchIdentifier Number Number that identifies the batch.
ChargeDefinitionCode Varchar2 Brief text that identifies the charge definition.
Value for the charge definition entity. A
charge definition defines the price type,
charge type, and the charge subtype. Order
Management typically denormalizes these
ChargeDefinition Varchar2 objects on this entity.
ChargeSubtypeCode Varchar2 Brief text that identifies the charge subtype.
Type of charge, defined for this configuration
to aggregate totals. You can use one of the
following types:
• Goods sale
• Service sale
• Financing compared to lease
• Shipping charges
• Restocking penalties
• Special charges
The Pricing Engine returns the charge value
ChargeSubType Varchar2 for each line.
Parent entity of the charge. You can use one
of the following values:
• Line
• Line Coverage
ParentEntityCode Varchar2
ParentEntityId Number ID of the parent entity of the charge.
Price type of a charge. You can use one of
the following values:
• One-time
• Recurring
PriceTypeCode Varchar2
PricedQuantity The priced quantity. This quantity equals
Number Line.RequestedQuantity for simple products.
Brief text that identifies the UOM for the
PricedQuantityUOMCode Varchar2 priced quantity. For example, Ton. Values for


this attribute come from PIM (Personal
Information Manager), or a similar service
that Order Management provides.
Indicates whether or not this charge is the
primary charge. Use one of the following
values:
• True. Primary charge.
• False. Not the primary charge.
PrimaryFlag string
Indicates whether or not a charge applies to
ApplyTo long product, shipping, or return.
Indicates whether or not this charge is a
rollup charge or an aggregate charge. Use
• True. Rollup charge.
• False. Aggregate charge.
RollupFlag Varchar2
Value that uniquely identifies the internal
charge. The order capture system assigns this
SourceChargeIdentifier Varchar2 value.
Charge Components
payload to define charge components.
Charge Components
Brief text that identifies the currency
that the charge component uses.
Order Management uses this code
ChargeCurrencyCode Varchar2 to standardize service.
Brief text that identifies the currency
that the header uses. Order
Management uses this code to
HeaderCurrencyCode Varchar2 standardize service.
Extended amount in the header
HeaderCurrencyExtendedAmount Number currency.
Brief text that identifies the price
element, such as LISTPRICE,
PriceElementCode Number NETPRICE, and so on.
SequenceNum Number Sequence number for the charge

Processing Change Orders ▪ Other Optional Attributes That You Can Include in the Request
Payload

component.
Brief text that specifies how to use
the charge component. A QP
lookup provides the values for this
attribute. Order Management
comes predefined to use one of the
following values:
• List Price
• Invoice Price
PriceElementUsageCode Varchar2
Price or adjustment for each unit in
the charge currency for the UOM
ChargeCurrencyUnitPrice Number that the order line uses.
Price or adjustment for each unit in
the charge currency for the UOM
HeaderCurrencyUnitPrice Number that the header uses.
Specifies a charge component as a
rollup value or aggregate value for
the element code of the charge
RollupFlag Varchar2 component price.
Identifier for the charge component
for the contributing charge. Order
Management uses this attribute only
for a charge component where the
SourceParentChargeComponentId Varchar2 parent charge is a rollup charge.
Value that uniquely identifies the
internal charge. The source system
SourceChargeIdentifier Varchar2 assigns this value.
Value that uniquely identifies the
internal charge component. The
SourceChargeComponentIdentifier Varchar2 source system assigns this value.
5 Processing Change Orders

To change a sales order, you call Receive Order Request Service with a payload that
includes the following information:
• Source transaction system
• Source transaction identifier
• Order number and source transaction number of a sales order that Order
Management has already processed
Receive Order Request Service will process the order as a change order according to
the combination of source transaction system and source transaction identifier.

Cancelling Orders ▪ Other Optional Attributes That You Can Include in the Request Payload
The payload structure for a change order is similar to the payload structure for create
order.
6 Cancelling Orders
To cancel a sales order or order line, you call Receive Order Request Service with a
payload that includes the following information:
 Cancel sales order. Set the OperationCode for the order header to CANCEL. You
must also identify the source transaction system and include the source transaction
identifier.
 Cancel an order line. Do the following:
o Set the OperationMode for the order line to CANCEL.
o Set the Ordered Quantity attribute to 0.
7 Using Security with Receive

Order Request Service
Receive Order Request Service attaches an LPA security policy to the service and the
callback. It includes the following hybrid policy:
oracle/wss11_saml_or_username_token_with_message_protection_service_policy
This policy supports five different assertions, including the following assertion:
oracle/wss_username_token_over_ssl_client_policy
The callback includes the following attachment:
oracle/wss_username_token_over_ssl_client_policy LPA
You can use these settings to call Receive Order Request Service only with SSL (Secure
Sockets Layer).
8 Using Receive Order Request

Service with Configured
Products
Order Management supports Oracle Fusion Configurator Runtime so that the user can
create and validate a configuration. Order Management calls the
ConfiguratorManager service when a sales order includes a configuration. This service
creates and validates the configuration.
For details about:

Using Receive Order Request Service with Configured Products ▪ Validations That the
Configurator Performs on Import Payloads
• Configurations, see Supply Chain Management Cloud Configurator Modeling Guide

on My Oracle Support at https:// support.oracle.com.
• Specifying the Configuration Effective Date parameter, see Managing Order
Management Parameters: Procedure on My Oracle Support at https://
support.oracle.com.
• Using a file to import orders, see Order Import Template: Explained on
https://support.oracle.com.
• Using a web service to create an integration that automatically imports source
orders, see Article ID 2051640.1 (Using Web Services to Import Orders Into Oracle
Fusion Order Management Cloud) on My Oracle Support at
https://support.oracle.com.
Validations That the Configurator Performs on Import Payloads

The Configurator performs the following validations on the contents of the import
payload:
• Makes sure a definition exists in a model definition in PIM for each of the following
items that the import payload contains:
• Configuration node
• Each item
• Primary UOM for each item
• Makes sure the import payload includes a value for the ProductNumber attribute for
each order line.
• Makes sure the import payload includes a quantity for each order line.
• Makes sure PIM allows a decimal quantity for each decimal quantity that the import
payload contains.
• Makes sure the import payload does not include more than one root model instance.
• Makes sure the import payload does not specify an item more than one time, and
that Order Management can resolve this item according to a model definition in PIM.
• Makes sure that If the import payload includes an optional model reference, then the
payload explicitly states the full input path to this model reference.
If any of these validations fails, then the import fails.
How the Service Resolves Missing Nodes in Import Payloads

If a configuration hierarchy in the import payload includes two levels, but if the model in
PIM that the payload references includes a different hierarchy, then the
createConfigForModelLine service attempts to modify the structure in the payload so
that it matches the hierarchy in PIM.
For example, assume the import payload includes the following hierarchy:

Using Receive Order Request Service with Configured Products ▪ How the Service Handles
Quantities in Import Payloads
M1
|_SI1
|_SI2
|_SI5
Assume the model in PIM includes the following hierarchy:
M1
|_SI1
|_OC1
|_SI2
|_SI3
|_M2
|_OC2
|_SI4
|_SI5
In this example, the createConfigForModelLine service modifies the structure from the
payload to the following structure:
M1
|_SI1
|_OC1
|_SI2
|_M2
|_OC2
|_SI5
How the Service Handles Quantities in Import Payloads

If the order import payload specifies only one of the following quantities for the
configuration line:
• Unit quantity. The createConfigForModelLine service calculates the ordered quantity.
• Ordered quantity. The createConfigForModelLine service calculates the unit quantity.
If the order import payload specifies the unit quantity and the ordered quantity, and if
the unit quantity for the configuration line multiplied by the ordered quantity for the
immediate parent line:
• Equals the ordered quantity for the configuration line. The createConfigForModelLine
service can successfully process the line.
• Does not equal the ordered quantity for the configuration line. The
createConfigForModelLine service creates an error and the order import fails.
If the order import payload specifies the Quantity Per Model, then the
createConfigForModelLine service ignores this value and calculates the unit quantity
and ordered quantity according to the quantities that the order import payload
specifies for all configuration lines.

Using Other Web Services ▪ OrderInformationService
9 Using Other Web Services

This chapter describes some of the other web services that you can use with Order
Management Cloud.
OrderInformationService
You can use OrderInformationService to get information about a sales order.
Use the following address to access the WSDL:
https://host:port/dooDecompOrderDetailSvc/OrderInformationService?WSDL
Table 19. Operations for OrderInformationService

Operation Input Message Output Message
GetOrderDeta OrderInformationService_GetO OrderInformationService_GetOrderD
ils rderDetails etailsResponse
GetOrderDeta OrderInformationService_GetO OrderInformationService_GetOrderD
ilsAsync rderDetailsAsync etailsAsyncResponse
GetOrderDetails Operation
The GetOrderDetails operation of OrderInformationService includes the following
attributes.
Table 20. Attributes for the GetOrderDetails Operation of OrderInformationService

Source system that placed the
SourceTransactionSystem Varchar2 request for fulfillment.
SourceTransactionNumber Transaction number that the source
Varchar2 system uses.
IncludeHeaderAndLineAttributesOnly Use one of the following values:
• All. Get all details of the sales
order.
• Status. Get only the status of the
sales order and the order lines.
Varchar2
internal transaction line. You can
repeat this attribute zero or more
Varchar2 times.

Using Other Web Services ▪ GetOrderDetails Operation
Using Files to Import Source Orders

You can use the Order Import Template to import source orders in bulk. It helps reduce
errors and simplifies order import. This template contains a structure that the Oracle
database requires. For example, it includes a tab for each database table, and it
displays these tabs in a specific sequence. For details, see the topic named Order
Import Template: Explained at https://fusionhelp.oracle.com, and Document ID
1954259.1 (Using Spreadsheet Files to Import Orders Into Oracle Fusion Order
Management Cloud) on My Oracle Support at https://support.oracle.com.
You can automate using files to import source orders. Oracle provides a set of web
services that you can use to upload the completed import template to the Universal
Content Management (UCM) server. You then run a scheduled process that imports the
uploaded file to the interface tables, processes them, and then imports each interface
record as a sales order. For details, see the guide titled Using External Data Integration
Services for Oracle ERP Cloud at
https://fusionappsoer.oracle.com/oer/custom/r10/PDF/publicFinancialCommonErpInteg
ration_ErpIntegrationService.pdf.
You use the following parameters to run the scheduled process.
Table 21. Parameters of the Import Orders Job Scheduled Process

Parameter Value
JobDefinitionName ImportOrdersJob
oracle/apps/ess/scm/doo/decomposition/receiveTransfor
JobPackageName m/receiveSalesOrder

0 Using Web Services With Order Management Cloud

Transféré par

Informations du document

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

0 Using Web Services With Order Management Cloud

Transféré par

Droits d'auteur :

Formats disponibles

March 2016

Using Web Services

Access to Oracle Support

1 Using Web Services with Order Management Cloud ........................................... 5

Receive Order Request Web Service ............................................................................ 7

Process Order Request ..................................................................................................... 8

Response Payload ............................................................................................................ 9

How Order Management Cross-References Customer Data .................................. 16

Creating Cross-References When Your Implementation Uses the Product

Specifying Attributes in Groups ..................................................................................... 20

Specifying Coded Attributes and Their Partners ........................................................ 21

Attributes That Define the Order Header .................................................................... 22

Using Web Services with Order Management 3

Attributes That Define the Order Lines ......................................................................... 26

Attributes That Define Order Preferences .................................................................... 37

Validations That the Configurator Performs on Import Payloads ............................. 47

How the Service Resolves Missing Nodes in Import Payloads ................................... 47

How the Service Handles Quantities in Import Payloads ........................................... 48

GetOrderDetails Operation ........................................................................................... 49

4 Using Web Services with Order Management

Using Web Services with Order Management 5

Usage Requirements and Capabilities

6 Using Web Services with Order Management

Receive Order Request Web Service

Table 1. Interface Information for ReceiveOrderRequestService

Using Web Services with Order Management 7

Table 2. Operations for ReceiveOrderRequestService

Submit Draft Order Operation

Table 3. Attributes for the SubmitDraftOrder Operation of ReceiveOrderRequestService

Process Order Request

Entity Hierarchy That the Receive Order Request Service Supports

8 Using Web Services with Order Management

Logical Data Model of the Order Request Object

Using Web Services with Order Management 9

10 Using Web Services with Order Management

Using Web Services with Order Management 11

Example Successful Response Payload

Example Failed Response Payload

12 Using Web Services with Order Management

2 Defining Your Source System

Define your source system

Using Web Services with Order Management 13

Options • Enable for Order Orchestration and Planning. Required.

Administer your source system

Collections Allowed Add a checkmark.

14 Using Web Services with Order Management

Using Web Services with Order Management 15

How Order Management Cross-References Customer Data

16 Using Web Services with Order Management

o Bill To Address Orig System Reference

Creating Cross-References When Your Implementation Uses the

To create cross-references when your implementation uses the Product Model

Using Web Services with Order Management 17

Creating Cross-References When Your Implementation Uses the

To create cross-references when your implementation uses the Product Hub

18 Using Web Services with Order Management

Using Reference Entities in the Order Management and Planning

Using Web Services with Order Management 19

4 Attributes That You Can

Specifying Attributes in Groups

20 Using Web Services with Order Management

▪ Specifying Coded Attributes and Their Partners

Specifying Coded Attributes and Their Partners

Table 4. Coded Attributes and Their Partner Attributes