Web Services That You Can Use to Integrate Order Management
You can use the Order Information Service to integrate Order Management with some other system.
Here are some examples of other systems that you can integrate.
-
Channel
-
Legacy
-
Quoting
-
Contract
-
Service request
-
Purchasing
-
Inventory
-
Warehouse
-
Shipping
-
Invoicing
-
Billing
Create, read, update, and delete the same data that Oracle Applications use.
For example:
Oracle Application |
Data |
---|---|
Order Promising |
Promising model |
Trading Community Architecture |
Customer model |
Product Information Management |
Product model |
Configurator |
Configuration model |
Order Management |
Data model |
Terminology
-
Source system. An order capture system or application that sends the request. 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 Order Management and Planning Repository is an example of an internal object.
-
External. An action, process, or object that resides outside of Oracle 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 into a sales order so it can fulfill the source order.
Use Web Services to Manage Imports
Use web services to help manage your imports. For example, communicate shipping details to your source system, manage holds, or check availability.
Web Service |
Description |
---|---|
Get Order Shipping Details |
|
Apply a Hold |
Route a request for a hold from your source system to a hold task. Process more than one hold in a request, each hold for one sales order, or more than one order line in the sales order. |
Release a Hold |
Route a request to release a hold from our source system to the hold task. |
Check Availability |
Send a request to Order Management to determine the quantity that's available on a date in the source system. Order Management sends a reply to the source system that includes these details. |
Use REST API or FBDI Instead of Order Import Service or Receive Order Request Service
You must use REST API or FBDI instead of Order Import Service or Receive Order Request Service. For more, see Overview of Importing Orders Into Order Management.
Order Import Web Service
The Order Import web service imported source orders from your order capture system into Oracle Order Management. Oracle replaced this service and all of its operations in Update 24D. It will remove support for them entirely in Update 25D.
Operation | Use This Instead |
---|---|
createOrders createOrdersAsync |
Create Sales Orders action or the Update One Sales Order action for small sales orders. File Based Data Import (FBDI) for large orders. |
submitDraftOrder submitDraftOrderAsync |
Update One Sales Order action for small sales orders. File Based Data Import (FBDI) for large orders. |
stageOrders stageOrdersAsync |
Create Sales Orders action or the Update One Sales Order action. |
Each action is an action in the Sales Order for Order Hub 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.
Operation | Use This Instead |
---|---|
ProcessOrderRequest ProcessOrderRequestSync |
Create Sales Orders action or the Update One Sales Order action for small sales orders. File Based Data Import (FBDI) for large orders. |
GetOrderDetails GetOrderDetailsSync |
Get All Sales Orders action or the Get One Sales Order action. |
SubmitDraftOrder SubmitDraftOrderSync |
Update One Sales Order action for small sales orders. File Based Data Import (FBDI) for large orders. |
CheckAvailability GetAvailabilityCheck GetAvailabilityCheckSync |
Quick Availability Check action in the Global Order Promising REST API. |
RequestHold | Apply Hold action. |
Each action is an action in the Sales Order for Order Hub REST API, except as noted.
You can continue to use the ReleasePausedTasks operation.
ReleasePausedTasks Operation
The ReleasePausedTasks operation releases paused tasks according to a combination of search parameters. You can use it only as an asynchronous web service. You must include these attributes when you use ReleasePausedEventTaskRequest.
Attribute |
Type |
Required |
Description |
---|---|---|---|
SourceSystem |
String |
Yes |
Source system that provides the release pause request. |
EventName |
String |
Yes |
Name of the pause event to release. |
InventoryItemId |
Long |
Yes |
Item identifier. |
OrderNumber |
String |
Yes |
Sales order number. |
LineNumber |
Long |
Yes |
Order line number. |
FulfillLineNumber |
Long |
Yes |
Number of the order fulfillment line. |
SoldToCustomerId |
Long |
Yes |
Customer identifier. |
FulfillOrgId |
Long |
Yes |
Warehouse identifier. |
PauseTaskId |
Long |
Yes |
Paused task identifier. |
FromOrderDate |
DateTime |
Yes |
Filter sales orders that happen on or after FromOrderDate. |
ToOrderDate |
DateTime |
Yes |
Filter sales orders that happen on or before ToOrderDate. |
FromScheduledShipDate |
DateTime |
Yes |
Filter sales orders that are scheduled to ship on or after FromScheduledShipDate. |
ToScheduledShipDate |
DateTime |
Yes |
Filter sales orders that are scheduled to ship on or before ToScheduledShipDate. |
FromPauseWaitUntilDate |
DateTime |
Yes |
Filter pause tasks that are scheduled to release on or after FromPauseWaitUntilDate. |
ToPauseWaitUntilDate |
DateTime |
Yes |
Filter pause tasks that are scheduled to release on or before ToPauseWaitUntilDate. |
SourceOrderSystem |
String |
Yes |
Source system that provides the source order. |
SourceOrderNumber |
String |
Yes |
Order number in the source system. |
TaskInstanceId |
Long |
Yes |
Task Instance Identifier. |
ReleasePausedTasks provides this response:
Attribute |
Type |
Description |
---|---|---|
NumberOfTasksReleased |
Long |
Number of tasks released. |
ErrorMessage |
String |
Error message if the service doesn't complete successfully. |
ReturnStatus |
String |
Return status. |