PeopleSoft Supply Chain Management API

openapi: 3.1.0
info:
  title: PeopleSoft Supply Chain Management API
  description: REST API endpoints for procurement, inventory management, order fulfillment,
    logistics, and enterprise integration points for warehouse management systems.
  version: 1.0.0
  contact:
    name: Oracle Support
    email: [email protected]
    url: https://support.oracle.com
  license:
    name: Proprietary
    url: https://www.oracle.com/contracts/
servers:
- url: https://{hostname}:{port}/psft/api/scm/v1
  description: PeopleSoft Instance
  variables:
    hostname:
      description: PeopleSoft server hostname
      default: localhost
    port:
      description: PeopleSoft server port
      default: '8000'
externalDocs:
  description: PeopleSoft FSCM REST API Documentation
  url: https://docs.oracle.com/cd/F92336_01/fscm92pbr50/eng/fscm/eccf/UnderstandingRestApiEndpointsForPeoplesoft.html
tags:
- name: Procurement
  description: Procurement and purchasing operations
- name: Inventory
  description: Inventory management operations
- name: Orders
  description: Order fulfillment operations
paths:
  /procurement/requisitions:
    get:
      summary: PeopleSoft List Requisitions
      description: Retrieve procurement requisitions.
      operationId: listRequisitions
      tags:
      - Procurement
      security:
      - basicAuth: []
      responses:
        '200':
          description: Successful response with requisitions
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /procurement/purchase-orders:
    get:
      summary: PeopleSoft List Purchase Orders
      description: Retrieve purchase orders.
      operationId: listPurchaseOrders
      tags:
      - Procurement
      security:
      - basicAuth: []
      responses:
        '200':
          description: Successful response with purchase orders
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /inventory/items:
    get:
      summary: PeopleSoft List Inventory Items
      description: Retrieve inventory items and stock levels.
      operationId: listInventoryItems
      tags:
      - Inventory
      security:
      - basicAuth: []
      parameters:
      - name: businessUnit
        in: query
        description: Business unit filter
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Successful response with inventory items
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /orders:
    get:
      summary: PeopleSoft List Orders
      description: Retrieve order fulfillment records.
      operationId: listOrders
      tags:
      - Orders
      security:
      - basicAuth: []
      responses:
        '200':
          description: Successful response with orders
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
  schemas:
    PurchaseOrder:
      type: object
      description: PeopleSoft purchasing purchase order.
      properties:
        BUSINESS_UNIT:
          type: string
          description: Business unit.
          example: US001
        PO_ID:
          type: string
          description: Purchase order ID.
          example: PO0012345
        VENDOR_ID:
          type: string
          description: Vendor ID.
          example: VND001234
        PO_DT:
          type: string
          format: date
          description: PO date.
          example: '2026-04-17'
        PO_STATUS:
          type: string
          description: PO status.
          enum:
          - O
          - A
          - C
          - D
          - X
          - PX
          example: A
        CURRENCY_CD:
          type: string
          description: Currency.
          example: USD
        BUYER_ID:
          type: string
          description: Buyer ID.
          example: BYR001
        SHIP_TO_LOCATION:
          type: string
          description: Ship-to location.
          example: WH001
        LINES:
          type: array
          description: PO lines.
          items:
            type: object
            properties:
              LINE_NBR:
                type: integer
                description: Line number.
                example: 1
              INV_ITEM_ID:
                type: string
                description: Item ID.
                example: ITEM001234
              DESCR:
                type: string
                description: Description.
                example: Office Chair - Ergonomic
              QTY_PO:
                type: number
                description: Quantity.
                example: 25
              PRICE_PO:
                type: number
                description: Unit price.
                example: 450.0
              UNIT_OF_MEASURE:
                type: string
                description: UOM.
                example: EA