1. Integration Playbooks for SCM
  2. REST APIs (POST and PATCH)

REST APIs (POST and PATCH)

Oracle Fusion Cloud Supply Chain Planning provides several REST resources for integrating with external systems.

A typical use of REST APIs is in a coexistence scenario where a third-party execution system is integrated to work with Oracle Supply Chain Planning using the POST and PATCH actions to import data into Oracle Supply Chain Planning.

REST Resources Group: Planning Demands

These key features and best practices apply to:

  • Supply Plans / Planning Demands
  • Demand and Supply Plans / Planning Demands
  • Replenishment Plans / Planning Demands
  • Simulation Set / Planning Demands
Key Features
  • Create manual demands.
  • Update existing demands.

Best Practices

  • When creating manual demands using the POST action on the Planning Demands REST resource, follow the documentation and provide only the required fields plus the necessary optional fields in payload body. For more information, see the Supply Chain Planning section in REST API for Oracle Fusion Cloud SCM.
  • Create manual demands or update demands in small batches of a maximum of 50 orders.
  • It's important to set the Content-Type to application/vnd.oracle.adf.batch+json in the POST request header for batch post.
  • Provide relevant IDs if they're known.

REST Resources Group: Planning Supplies

These key features and best practices apply to:

  • Supply Plans / Planning Supplies
  • Demand and Supply Plans / Planning Supplies
  • Replenishment Plans / Planning Supplies
  • Simulation Set / Planning Supplies

Key Features

  • Create planned orders or available supplies.
  • Update existing supplies.
  • Mark orders for release.

Best Practices

  • When creating planned orders or available supplies using the POST action on the Planning Supplies REST resource, follow the documentation and provide only the required fields plus the necessary optional fields in payload body. For more information, see the Supply Chain Planning section in REST API for Oracle Fusion Cloud SCM.
  • When creating planned orders or available supplies or when updating existing supplies, use small batches of a maximum of 50 orders.

    This also applies when using the REST resource to mark orders for release.

  • It's important to set the Content-Type: application/vnd.oracle.adf.batch+json in the POST request header for batch post.
  • Provide relevant IDs if they're known.

REST Resources Group: Items

These key features and best practices apply to Simulation Sets / Items.

Key Features

Create an item in a simulation set.

Best Practices

To create a new item using the POST action on the simulationSets/{simSetId}/child/Items, provide InventoryItemId and OrganizationId or ItemName and Organization, plus the other optional editable fields in the payload body.

REST Resources Group: Resources

These key features and best practices apply to Simulation Sets / Resources.

Key Features

Create a resource in a simulation set.

Best Practices

To create a new resource using the POST action on the simulationSets/{simSetId}/child/Resources REST resource, provide ResourceId or ResourceCode and WorkCenterCode and Organization, plus the other optional editable fields in the payload body.

REST Resources Group: Supplier Capacity

These key features and best practices apply to Simulation Sets / Supplier Capacity.

Key Features

Update supplier capacity within a simulation set.

Best Practices

To update supplier capacity using the POST action on the simulationSets/{simSetId}/child/SupplierCapacities REST resource, provide ItemId or ItemName, SupplierId or SupplierCode, SupplierSiteId or SupplierSiteCode, plus other optional editable fields in the payload body.

Oracle Global Order Promising

Key Features

  • Simulate order promising.
  • Schedule orders.
  • Review item availability.
  • Review time-phased supply availability in a report.
  • Review supply allocation details in weekly buckets.

Best Practices

  • Use REST APIs as a standard practice when making calls from an external source system directly to Oracle Global Order Promising, bypassing Oracle Fusion Cloud Order Management.
  • For the best performance of promising actions, use parallel invocation instead of sending a large batch of requests at once.
  • For key attributes like item, customer, and customer site, use the names that were defined and collected in the Planning repository.
  • To check for item supplies on a certain date, use the quick availability call as a lightweight option instead of check availability. You also can use the Supply Availability Report.
  • When invoking from external source systems, the Calling Module and Calling Instance attributes in the payloads should align with the source system name that was defined for the external source on the Manage Planning Source Systems page.
  • When customer and customer site information is defined but not yet collected – as is typically the case where customers are created on-the-fly just before placing orders – use the Ship-to region ID for geography-based sourcing in Check Availability and Automatically Schedule calls.
    Note: Geography setups for this should already exist in Oracle Trading Community Architecture.

For more information about Oracle Global Order Promising REST APIs, see Global Order Promising in the Order Management product group in REST API for Oracle Fusion Cloud SCM.

Related Topics