Overview of Importing Orders Into Order Management

Use the Order Import Template, a web service, or REST API to import orders from your source system into Oracle Order Management.

Use the Order Import Template, a web service, or REST API to import orders from your source system into Order Management.

Use the Order Import Template to reduce errors and simplify your import. This template contains a structure that the Oracle database requires. It includes a tab for each database table, and it displays tabs in a specific sequence. Columns on each tab represent the table columns that Oracle requires, and the template specifies the data type that Oracle requires for each database column.

What You Need Where You Can Get It
Learn how to use the Order Import Template. Convert Source Data Into CSV File
Copy of the Order Import Template and details about tables that the template references. Go to File-Based Data Import (FBDI) for SCM. In the Order Management chapter, click Import Sales Orders.
Example templates. Go to Technical Reference for Order Management (Doc ID 2051639.1), then download the Payloads and Files attachment.
Details about how to use a web service to create an integration that imports source orders. Guidelines for Using Web Services to Integrate Order Management.
Details about the salesOrdersForOrderHub REST API.

For details and examples, go to REST API for Oracle Supply Chain Management Cloud, expand Order Management, then click Sales Orders for Order Hub.

More technical details. Master Note Importing Data using FBDI (Doc ID 2665940.1)

Compare the Import Technologies

What You're Doing Order Management Work Area File Based Data Import REST API Web Service ADF Desktop Integration (ADFDI)
Update an extensible flexfield on the order header while the sales order and the order lines are closed. No No No No No
Update the Request Date attribute on the order line. Yes Yes Yes Yes No
Update the Order Type attribute on the order header. Yes Yes Yes Yes No

Update the header of an order that isn't Canceled or Closed.

Yes No Yes No No
Update the Primary Salesperson on the order header. Yes Yes, but only if you haven't submitted the order. Yes No No
Update pricing on an order line.* Yes Yes Yes Yes No
Update a sales order that's in Awaiting Billing status. No No No No No

* You can update pricing only if pricing isn't frozen. For details see, Freeze Price on Sales Orders.

Import a Large Number of Source Orders

We recommend that you use file-based data import (FBDI) instead of web services or REST API to import a large number of source orders. FBDI is more resilient and is easier to retry imports that fail without having to resend the source order from your source system.

Consider an example.

  • You process about 4,000 orders each day.

  • You average about 50 order lines in each source order.

  • You process about 200,000 order lines each day.

  • You expect to import about 330 source orders each hour from 8AM to 8 PM.

  • You currently need to import from four source systems, and you plan to expand to eight, possibly doubling overall processing to 8,000 source orders a day.

  • You must ship your sales orders the day after you import them.

  • Your orchestration process includes typical fulfillment tasks, such as schedule, reserve, ship, bill, and so on.

FBDI is the best technology to handle this kind of volume.

If you must use a web service or REST API to import your source orders, then include only one source order in each payload request.

REST API only supports the synchronous operation, so if you include more than one source order in each payload, and if the request runs for more than about 5 minutes, then you might encounter a time out error that you can't recover from.

If you must use the Order Import web service, then use the asynchronous operation. Don't use the synchronous operation.

Differences in Attribute Names and Values

The import technologies use slightly different names and values for some attributes. Order Management processes the attributes in the same way regardless of these nomenclature differences.

Attribute Names

Format

Order Import Template

Web Services and REST API

Capitalization of the attribute name.

Headline, such as Payment Method Code.

Camel case, such as PaymentMethodCode.

Name of an attribute that contains a Boolean value.

Doesn't give an indication, for example Freeze Pricing.

Typically includes the text Flag, such as FreezePriceFlag.

Name of an attribute that contains an identifier.

Typically includes the word Identifier, such as Source Transaction Identifier.

Typically includes the text Id, such as SourceTransactionId.

Boolean Values

Technology

True

False

Order Import Template

Y

N

Web Services

Y or true

N or false

REST API

true

false