1. Implementing Order Management
  2. Import Returns When You Split the Original Order Line

Import Returns When You Split the Original Order Line

Create a return for a source order line that you split in Order Management.

If Order Management doesn't split the fulfillment line, then one order line in the source order in the source system maps to one fulfillment line in the sales order in Order Management. But if Order Management splits the fulfillment line into two or more fulfillment lines, then the lines reference the same source order, source order line, and schedule details. To create a return for a source order line that you split in Order Management, you must provide details that identify which fulfillment line to return.

Use the DocumentReferenceType attribute to identify the original order line you're returning.

DocumentReferenceType

Description

ORIGINAL_SALES_ORDER

Identify the original order line in the source system from a channel, such as a legacy order capture system.

ORIGINAL_ORCHESTRATION_ORDER

Identify the original sales order line in Order Management.

You must use DocumentSubLineIdentifier.

If the original order line.

  • Isn't split, you can use ORIGINAL_SALES_ORDER or ORIGINAL_ORCHESTRATION_ORDER.

  • Is split, you must use ORIGINAL_ORCHESTRATION_ORDER, or ORIGINAL_SALES_ORDER and ORIGINAL_ORCHESTRATION_ORDER.

Use ORIGINAL_SALES_ORDER

Use ORIGINAL_SALES_ORDER in the DocumentReference section to specify details about the source order you originally created in your source system.

Attribute

Description

Example Value

DocumentReferenceType

Not applicable.

ORIGINAL_SALES_ORDER

DocumentIdentifier

Value that uniquely identifies the original source order. This is the source order in your source system that you originally used to order the item.

CS_SO_1234445555565656

DocumentAdditionalIdentifier

Name of the source system.

You can use the Code attribute on the Manage Planning Source Systems page to set this value.

LEG

DocumentNumber

Number of the original sales order.

CS_SO_122_0034

DocumentLineIdentifier

Number that uniquely identifies the order line on the original sales order that contains the item you're returning.

101

DocumentLineNumber

Identify the line number.

Not applicable

Note

  • Provide values that uniquely identify the source order line. For instance, you can provide identifiers for the source order and source order line to uniquely identify the source order line. You can also provide other values, such as source order number and source order line number, to uniquely identify the source order line.

  • Include values for DocumentNumber or DocumentIdentifier, or DocumentNumber and DocumentIdentifier.

  • Include values for DocumentLineNumber or DocumentLineIdentifier, or DocumentLineNumber and DocumentLineIdentifier.

Use ORIGINAL_ORCHESTRATION_ORDER

Add another DocumentReference section, and use ORIGINAL_ORCHESTRATION_ORDER to identify details about the order you originally created in Oracle Order Management.

Attribute

Description

Example Value

DocumentReferenceType

Not applicable.

ORIGINAL_ORCHESTRATION_ORDER

DocumentIdentifier

Value that uniquely identifies the order header of the original sales order in Order Management. This is the sales order you originally used to order the item.

300100177488708

DocumentAdditionalIdentifier

Name of the source system.

GPR

DocumentNumber

Number of the original sales order.

45098

DocumentSubLineIdentifier

Value that uniquely identifies the fulfillment line that fulfilled the item you're returning.

300100177495497

DocumentLineIdentifier

LineNumber

DocumentLineNumber

DocumentSubLineNumber

Leave these values empty.

Not applicable

Identify the Source System

You use different attributes to identify the name of the source system depending on whether you use the import template or web service.

How You Import

Attribute You Use

Template

Source Transaction System

Web Service

DocumentAdditionalIdentifier

Example Payload

Here's an example payload. It uses ORIGINAL_SALES_ORDER and ORIGINAL_ORCHESTRATION_ORDER. You use the DocumentReference section to specify details about the original sales order. Use the Order Information Service to get the values you need for your payload. For details, see Web Services That You Can Use to Integrate Order Management.

<ns2:DocumentReference>
 <ns2:DocumentReferenceType>ORIGINAL_SALES_ORDER</ns2:DocumentReferenceType>
 <ns2:DocumentIdentifier>CS_SO_1234445555565656</ns2:DocumentIdentifier>
 <ns2:DocumentAdditionalIdentifier>LEG</ns2:DocumentAdditionalIdentifier>
 <ns2:DocumentNumber>CS_SO_122_0034</ns2:DocumentNumber>
 <ns2:DocumentAdditionalNumber/>
 <ns2:DocumentLineIdentifier>101</ns2:DocumentLineIdentifier>
 <ns2:DocumentAdditionalLineIdentifier/>
 <ns2:DocumentLineNumber/>
 <ns2:DocumentAdditionalLineNumber/>
 <ns2:DocumentAdditionalSubLineIdentifier/>
 <ns2:DocumentSubLineNumber/>
 <ns2:DocumentAdditionalSubLineNumber/>
</ns2:DocumentReference>

<ns2:DocumentReference>
 <ns2:DocumentReferenceType>ORIGINAL_ORCHESTRATION_ORDER</ns2:DocumentReferenceType>
 <ns2:DocumentIdentifier>300100177488708</ns2:DocumentIdentifier>
 <ns2:DocumentAdditionalIdentifier>GPR</ns2:DocumentAdditionalIdentifier>
 <ns2:DocumentNumber>45098</ns2:DocumentNumber>
 <ns2:DocumentAdditionalNumber/>
 <ns2:DocumentLineIdentifier>300100177488711</ns2:DocumentLineIdentifier>
 <ns2:DocumentSubLineIdentifier>300100177495497</ns2:DocumentSubLineIdentifier>
 <ns2:DocumentAdditionalLineIdentifier/>
 <ns2:DocumentLineNumber>1</ns2:DocumentLineNumber>
 <ns2:DocumentAdditionalLineNumber/>
 <ns2:DocumentSubLineNumber>2</ns2:DocumentSubLineNumber>
 <ns2:DocumentAdditionalSubLineNumber/>
</ns2:DocumentReference>

Here's the entire payload. It returns a quantity of 1 Each for item AS92888.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 <soap:Body>
  <ns1:createOrders xmlns:ns1="http://xmlns.oracle.com/apps/scm/fom/importOrders/orderImportService/types/">
    <ns1:request xmlns:ns2="http://xmlns.oracle.com/apps/scm/fom/importOrders/orderImportService/">
     <ns2:BatchName>Test001</ns2:BatchName>
     <ns2:Order>
      <ns2:SourceTransactionIdentifier>ppar_mar22_12</ns2:SourceTransactionIdentifier>
      <ns2:SourceTransactionSystem>GPR</ns2:SourceTransactionSystem>
      <ns2:SourceTransactionNumber>ppar_mar22_12</ns2:SourceTransactionNumber>
      <ns2:BuyingPartyId>1006</ns2:BuyingPartyId>
      <ns2:BuyingPartyContactId>1560</ns2:BuyingPartyContactId>
      <ns2:TransactionalCurrencyCode>USD</ns2:TransactionalCurrencyCode>
      <ns2:TransactionOn>2018-01-01T06:08:52.0340</ns2:TransactionOn>
      <ns2:RequestingBusinessUnitIdentifier>204</ns2:RequestingBusinessUnitIdentifier>
      <ns2:RequestingLegalUnitIdentifier>204</ns2:RequestingLegalUnitIdentifier>
      <ns2:FreezePriceFlag>true</ns2:FreezePriceFlag>
      <ns2:FreezeShippingChargeFlag>true</ns2:FreezeShippingChargeFlag>
      <ns2:FreezeTaxFlag>true</ns2:FreezeTaxFlag>
      <ns2:ShipToPartyIdentifier>1006</ns2:ShipToPartyIdentifier>
      <ns2:ShipToPartySiteIdentifier>1036</ns2:ShipToPartySiteIdentifier>
      <ns2:ShipToPartyContactIdentifier>1560</ns2:ShipToPartyContactIdentifier>
      <ns2:BillToCustomerIdentifier>1006</ns2:BillToCustomerIdentifier>
      <ns2:BillToCustomerName>1006</ns2:BillToCustomerName>
      <ns2:BillToAccountSiteUseIdentifier>1025</ns2:BillToAccountSiteUseIdentifier>
      <ns2:BillToAccountContactIdentifier>4820</ns2:BillToAccountContactIdentifier>
      <ns2:Line>
       <ns2:SourceTransactionLineIdentifier>101</ns2:SourceTransactionLineIdentifier>
       <ns2:SourceTransactionScheduleIdentifier>101</ns2:SourceTransactionScheduleIdentifier>
       <ns2:SourceTransactionLineNumber>1</ns2:SourceTransactionLineNumber>
       <ns2:SourceTransactionScheduleNumber>1</ns2:SourceTransactionScheduleNumber>
       <ns2:ProductNumber>AS92888</ns2:ProductNumber>
       <ns2:OrderedQuantity>1</ns2:OrderedQuantity>
       <!--ns2:OrderedUOMCode>BX1</ns2:OrderedUOMCode-->
       <ns2:OrderedUOM>Each</ns2:OrderedUOM>
       <ns2:RequestedFulfillmentOrganizationIdentifier>207</ns2:RequestedFulfillmentOrganizationIdentifier>
       <ns2:RequestingBusinessUnitIdentifier>204</ns2:RequestingBusinessUnitIdentifier>
       <ns2:RequestedShipDate>2018-01-01T06:08:52.0340</ns2:RequestedShipDate>
       <ns2:PaymentTermsCode>4</ns2:PaymentTermsCode>
       <ns2:TransactionCategoryCode>RETURN</ns2:TransactionCategoryCode>
       <ns2:ShipToPartyIdentifier>1006</ns2:ShipToPartyIdentifier>
       <ns2:ScheduleShipDate>2018-11-20T06:08:52.0340</ns2:ScheduleShipDate>
       <ns2:ScheduleArrivalDate>2018-11-20T06:08:52.0340</ns2:ScheduleArrivalDate>
       <ns2:ShipToPartySiteIdentifier>1036</ns2:ShipToPartySiteIdentifier>
       <ns2:BillToCustomerIdentifier>1006</ns2:BillToCustomerIdentifier>
       <ns2:BillToCustomerName>1006</ns2:BillToCustomerName>
       <ns2:BillToAccountSiteUseIdentifier>1025</ns2:BillToAccountSiteUseIdentifier>
       <ns2:BillToAccountContactIdentifier>4820</ns2:BillToAccountContactIdentifier>
       <ns2:InventoryOrganizationIdentifier>204</ns2:InventoryOrganizationIdentifier>
       <ns2:ShippingInstructions>BM Ship Instructions- Ship it in a day</ns2:ShippingInstructions>
       <ns2:UnitListPrice currencyCode="USD">105</ns2:UnitListPrice>
       <ns2:PartialShipAllowedFlag>FALSE</ns2:PartialShipAllowedFlag>
       <ns2:FOBPoint>DEST</ns2:FOBPoint>
       <ns2:OrderCharge>
        <ns2:ChargeDefinitionCode>QP_SALE_PRICE</ns2:ChargeDefinitionCode>
        <ns2:ChargeSubtypeCode>ORA_PRICE</ns2:ChargeSubtypeCode>
        <ns2:PriceTypeCode>ONE_TIME</ns2:PriceTypeCode>
        <ns2:PricedQuantity>1</ns2:PricedQuantity>
        <ns2:PricedQuantityUOM>Each</ns2:PricedQuantityUOM>
        <ns2:PricedQuantityUOMCode/>
        <ns2:PrimaryFlag>true</ns2:PrimaryFlag>
        <ns2:ApplyTo>PRICE</ns2:ApplyTo>
        <ns2:RollupFlag>false</ns2:RollupFlag>
        <ns2:SourceChargeIdentifier>SC1</ns2:SourceChargeIdentifier>
        <ns2:ChargeCurrencyCode>USD</ns2:ChargeCurrencyCode>
        <ns2:ChargeTypeCode>ORA_SALE</ns2:ChargeTypeCode>
        <ns2:ChargeCurrencyCode/>
        <ns2:SequenceNumber>1</ns2:SequenceNumber>
        <ns2:PricePeriodicityCode/>
        <ns2:GsaUnitPrice/>
        <ns2:OrderChargeComponent>
         <ns2:ChargeCurrencyCode>USD</ns2:ChargeCurrencyCode>
         <ns2:HeaderCurrencyCode>USD</ns2:HeaderCurrencyCode>
         <ns2:HeaderCurrencyExtendedAmount>-100</ns2:HeaderCurrencyExtendedAmount>
         <ns2:PriceElementCode>QP_LIST_PRICE</ns2:PriceElementCode>
         <ns2:SequenceNumber>1</ns2:SequenceNumber>
         <ns2:PriceElementUsageCode>LIST_PRICE</ns2:PriceElementUsageCode>
         <ns2:ChargeCurrencyUnitPrice>-10</ns2:ChargeCurrencyUnitPrice>
         <ns2:HeaderCurrencyUnitPrice>-10</ns2:HeaderCurrencyUnitPrice>
         <ns2:RollupFlag>false</ns2:RollupFlag>
         <ns2:SourceParentChargeComponentId/>
         <ns2:SourceChargeIdentifier>SC1</ns2:SourceChargeIdentifier>
         <ns2:SourceChargeComponentIdentifier>SCC2</ns2:SourceChargeComponentIdentifier>
         <ns2:ChargeCurrencyExtendedAmount>-100</ns2:ChargeCurrencyExtendedAmount>
        </ns2:OrderChargeComponent>
        <ns2:OrderChargeComponent>
         <ns2:ChargeCurrencyCode>USD</ns2:ChargeCurrencyCode>
         <ns2:HeaderCurrencyCode>USD</ns2:HeaderCurrencyCode>
         <ns2:HeaderCurrencyExtendedAmount>-90</ns2:HeaderCurrencyExtendedAmount>
         <ns2:ChargeCurrencyExtendedAmount>-90</ns2:ChargeCurrencyExtendedAmount>
         <ns2:PriceElementCode>QP_NET_PRICE</ns2:PriceElementCode>
         <ns2:SequenceNumber>2</ns2:SequenceNumber>
         <ns2:PriceElementUsageCode>NET_PRICE</ns2:PriceElementUsageCode>
         <ns2:ChargeCurrencyUnitPrice>-9</ns2:ChargeCurrencyUnitPrice>
         <ns2:HeaderCurrencyUnitPrice>-9</ns2:HeaderCurrencyUnitPrice>
         <ns2:RollupFlag>false</ns2:RollupFlag>
         <ns2:SourceParentChargeComponentId/>
         <ns2:SourceChargeIdentifier>SC1</ns2:SourceChargeIdentifier>
         <ns2:SourceChargeComponentIdentifier>SCC1</ns2:SourceChargeComponentIdentifier>
        </ns2:OrderChargeComponent>
       </ns2:OrderCharge>

       <ns2:DocumentReference>
        <ns2:DocumentReferenceType>ORIGINAL_SALES_ORDER</ns2:DocumentReferenceType>
        <ns2:DocumentIdentifier>CS_SO_1234445555565656</ns2:DocumentIdentifier>
        <ns2:DocumentAdditionalIdentifier>LEG</ns2:DocumentAdditionalIdentifier>
        <ns2:DocumentNumber>CS_SO_122_0034</ns2:DocumentNumber>
        <ns2:DocumentAdditionalNumber/>
        <ns2:DocumentLineIdentifier>101</ns2:DocumentLineIdentifier>
        <ns2:DocumentAdditionalLineIdentifier/>
        <ns2:DocumentLineNumber/>
        <ns2:DocumentAdditionalLineNumber/>
        <ns2:DocumentAdditionalSubLineIdentifier/>
        <ns2:DocumentSubLineNumber/>
        <ns2:DocumentAdditionalSubLineNumber/>
       </ns2:DocumentReference>

       <ns2:DocumentReference>
        <ns2:DocumentReferenceType>ORIGINAL_ORCHESTRATION_ORDER</ns2:DocumentReferenceType>
        <ns2:DocumentIdentifier>300100177488708</ns2:DocumentIdentifier>
        <ns2:DocumentAdditionalIdentifier>GPR</ns2:DocumentAdditionalIdentifier>
        <ns2:DocumentNumber>45098</ns2:DocumentNumber>
        <ns2:DocumentAdditionalNumber/>
        <ns2:DocumentLineIdentifier>300100177488711</ns2:DocumentLineIdentifier>
        <ns2:DocumentSubLineIdentifier>300100177495497</ns2:DocumentSubLineIdentifier>
        <ns2:DocumentAdditionalLineIdentifier/>
        <ns2:DocumentLineNumber>1</ns2:DocumentLineNumber>
        <ns2:DocumentAdditionalLineNumber/>
        <ns2:DocumentSubLineNumber>2</ns2:DocumentSubLineNumber>
        <ns2:DocumentAdditionalSubLineNumber/>
       </ns2:DocumentReference>

     </ns2:Line>
     <ns2:OrderPreferences>
     <!--Optional:-->
      <ns2:CreateCustomerInformationFlag>false</ns2:CreateCustomerInformationFlag>
      <!--Optional:-->
      <ns2:SubmitFlag>true</ns2:SubmitFlag>
     </ns2:OrderPreferences>
    </ns2:Order>
   </ns1:request>
  </ns1:createOrders>
 </soap:Body>
</soap:Envelope>

Related Topics