1. Implementing Order Management
  2. Example Web Service Payloads That Integrate Order Management

Example Web Service Payloads That Integrate Order Management

Get some example payloads in xml files.

To download the xml files, go to Technical Reference for Order Management (Doc ID 2051639.1), then download the Example Web Service Payloads attachment.

Example Payloads for the Create Order Operation

Here are some example payloads for the Create Order operation of the Order Import Service. These payloads create sales orders.

Description

Payload

Create or submit draft sales orders.

draft_sales_order.xml

submit_draft_order_sync.xml

Include pricing.

single_line_priced_in_source_system.xml

single_line_priced_in_oracle_fusion.xml

Note

  • The single_line_priced_in_oracle_fusion.xml payload includes the text QP, which is an acronym for Quality Pricing. It indicates that Oracle Pricing calculates pricing for the sales order.

  • The single_line_priced_in_source_system.xml payload includes the text PREPRICED, which means your source system calculates pricing for the sales order.

Include child entities.

child_entity_transactional_item_attribute.xml

child_entity_sales_credits

child_entity_manual_price_adjustment.xml

child_entity_lot_serial.xml

For new customers.

customer_sync_person.xml

customer_sync_organization.xml

Include extensible flexfields.

sales_order_with_extensible_flexfield.xml

This payload includes the text EFF, which is an acronym for extensible flexfield.

Include billing details.

recurring_billing.xml

Include shipment sets.

shipset_order.xml

Here are some more examples that use the Create Order operation.

Description

Payload

Return sales orders.

return_order_with_reference.xml

Cancel sales orders.

cancel_sales_order.xml

Cancel order line.

cancel_order_lines.xml

Example of a successful operation.

successful_response_for_CreateOrder.xml

Example of a failed operation.

failed_response_for_CreateOrder.xml

Example Payloads for the Stage Order Operation

The payloads for the Stage Order operation are identical to the payloads for the Create Order operation except you use stageOrders at the beginning and at the end of the body. For example, the draft_sales_order.xml payload uses stageOrders on lines 3 and 10 for the stage order operation. To use the Create Orders operation, you replace stageOrders on lines 3 and 10 with createOrders.

successful_response_for_StageOrder.xml is an example of a successful response for the Stage Order operation.

You can't include the Attachment entity in a stage order payload. For example, if you include this content in your payload, it will fail.

<ord:Attachment>
  <ord:Title>HeaderTEXTTitle</ord:Title>
  <ord:FileContent></ord:FileContent>
  <ord:FileName></ord:FileName>
  <ord:Data>VGhlIHNvdXJjZSBmaWxlIGlzIGhhbmRsZWQgYXMgYSBiaW5hcnkgZGF0YS4gVGhlIHRleHRib3gg
aXMgaGFuZGxlZCBhcyBhIHN0cmluZyBkYXRhLCBkZWZhdWx0IGNoYXJhY3RlciBzZXQgZm9yIHRo
ZSB0ZXh0Ym94IGlzICdpc28tODg1OS0xJy4gWW91IGNhbiBjaGFuZ2UgdGhlIGNoYXJzZXQgdXNp
bmcgZm9ybSBiZWxsb3cu</ord:Data>
  <ord:Description>HeaderTEXTDesc</ord:Description>
  <ord:url></ord:url>
  <ord:EntityAttributes></ord:EntityAttributes>
  <ord:DataTypeCode>TEXT</ord:DataTypeCode>
</ord:Attachment>

Other Examples

Use the ProjectDetail tag to include project details. Here's an example.

<ns2:Project xmlns:pjc="http://xmlns.oracle.com/apps/flex/scm/doo/processOrder/pjcDff/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns2:ProjectDetail xsi:type="pjc:OmSalesOrder">
<pjc:projectId>300100010341182</pjc:projectId>
<pjc:taskId>300100010341193</pjc:taskId>
<pjc:expenditureItemDate>2019-03-20</pjc:expenditureItemDate>
<pjc:expenditureTypeId>300100036998309</pjc:expenditureTypeId>
<pjc:organizationId>204</pjc:organizationId>
</ns2:ProjectDetail>
</ns2:Project>