1. Integration Playbooks for Procurement
  2. REST APIs (Inbound) for Purchasing

REST APIs (Inbound) for Purchasing

Use the REST APIs inbound integration option to integrate with Oracle Purchasing if your business process requires near real-time updates to your purchasing data.

For example, you might need to update a price on a purchase order.

Key Features

  • Use REST APIs for real-time integration requirements for Purchase Orders, Purchase Agreements, Procurement Agents, Processing Requisitions into Purchase Orders, Work Confirmations, and other Oracle Purchasing REST resources.
  • Use the Purchase Order REST resource to view and perform custom actions on open purchase orders.
  • Use the Draft Purchase Order REST resource to view, create, update, perform custom actions on draft purchase orders or change orders.
    • BATCH is supported for updates, insert, delete, and GET operations.
    • UPSERT mode is supported.
    • Use the calculateTaxAndAccounting custom action to derive key values quickly, expedite data entry, and to perform certain validations.
  • Use the Purchase Agreement REST resource to search for a blanket or contract purchase agreement and child resources.
  • Use the Purchase Agreement Import Requests REST resource to import purchase agreements.
  • Use the Requisition Processing Requests REST resource to processes approved requisition lines into a new order or add them to an existing order.
  • Use REST APIs to achieve end-to-end process orchestration.
  • Use the batch action to update multiple blanket agreements.

Best Practices

  • Use this option if you need to perform near real-time mode operations in Oracle Purchasing.
  • To improve performance and prevent REST APIs from experiencing 504 gateway time outs if a request runs for more than 5 minutes, limit the attributes using the fields query parameter while performing a GET operation whenever it's supported.
  • Although we don't expect customers to have hundreds of distributions per purchase order line or schedule, consider splitting the line or schedule to achieve better performance when handling a large purchase order.
  • To have more control when organizing requisition lines onto a purchase order, use the Requisition Processing Requests REST resource instead of generating orders.
    Note: To do this, you must first disable automatic purchase order generation.
  • POST a batch of records with each batch containing 500 lines until you've looped through all the lines that need to be updated. The POST operation will return interface header IDs that correspond to the blanket purchase agreements (BPAs) being updated. Use any interface header ID that's returned and start the custom action. To process all records in the batch, start a custom action without providing the batch ID.

Constraints

  • REST APIs don't allow the return of more than 500 records in a single call. You can paginate through the entire set using offset and limit in REST API parameters.
  • Batch mode isn't supported when using custom actions for draft purchase orders. For example, when submitting multiple purchase orders for approval in a single request.

Related Topics