Oracle E-Business Suite Work in Process API

openapi: 3.1.0
info:
  title: Oracle EBS e-Commerce Gateway Accounts Payable Work in Process API
  description: RESTful APIs for Oracle E-Business Suite e-Commerce Gateway providing EDI (Electronic Data Interchange) transaction support. Enables exchange of standard ASC X12 and EDIFACT documents with trading partners through flat ASCII file integration with third-party EDI translators. Supports inbound and outbound document processing for purchase orders, invoices, ship notices, and other business documents.
  version: 12.2.0
  contact:
    name: Oracle Support
    email: support@oracle.com
    url: https://support.oracle.com
  license:
    name: Oracle Proprietary
    url: https://www.oracle.com/legal/terms/
  x-logo:
    url: https://www.oracle.com/a/ocom/img/oracle-logo.svg
servers:
- url: https://{instance}.oracle.com/webservices/rest
  description: Oracle EBS ISG REST endpoint
  variables:
    instance:
      default: ebs-host
      description: The Oracle EBS instance hostname
tags:
- name: Work in Process
  description: WIP job, operation, and transaction management
paths:
  /wip/discreteJobs:
    get:
      operationId: getDiscreteJobs
      summary: Retrieve Wip Discrete Jobs
      description: Retrieves Work in Process discrete manufacturing job records. Maps to the WIP_DISCRETE_JOBS table through the WIP_DISCRETE_JOBS_PUB API.
      tags:
      - Work in Process
      security:
      - tokenAuth: []
      - basicAuth: []
      parameters:
      - name: wipEntityId
        in: query
        description: WIP entity identifier
        schema:
          type: integer
        example: '500123'
      - name: wipEntityName
        in: query
        description: Job name/number
        schema:
          type: string
        example: example_value
      - name: primaryItemId
        in: query
        description: Primary assembly item identifier
        schema:
          type: integer
        example: '500123'
      - name: organizationId
        in: query
        description: Organization identifier
        schema:
          type: integer
        example: '500123'
      - name: statusType
        in: query
        description: Job status
        schema:
          type: integer
          enum:
          - 1
          - 3
          - 4
          - 5
          - 6
          - 7
          - 12
          - 14
          - 15
        example: 1
      - name: scheduledStartDateFrom
        in: query
        description: Scheduled start date range (YYYY-MM-DD)
        schema:
          type: string
          format: date
        example: '2026-01-15'
      - name: scheduledStartDateTo
        in: query
        description: Scheduled start date range end (YYYY-MM-DD)
        schema:
          type: string
          format: date
        example: '2026-01-15'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: List of discrete jobs
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/DiscreteJob'
                  totalCount:
                    type: integer
                  hasMore:
                    type: boolean
              examples:
                Getdiscretejobs200Example:
                  summary: Default getDiscreteJobs 200 response
                  x-microcks-default: true
                  value:
                    items:
                    - wipEntityId: '500123'
                      wipEntityName: example_value
                      organizationId: '500123'
                      primaryItemId: '500123'
                      primaryItemNumber: example_value
                      statusType: 10
                      jobType: 10
                      startQuantity: 42.5
                      quantityCompleted: 42.5
                      quantityScrapped: 42.5
                      netQuantity: 42.5
                      scheduledStartDate: '2026-01-15T10:30:00Z'
                      scheduledCompletionDate: '2026-01-15T10:30:00Z'
                      dateReleased: '2026-01-15T10:30:00Z'
                      dateCompleted: '2026-01-15T10:30:00Z'
                      dateClosed: '2026-01-15T10:30:00Z'
                      classCode: example_value
                      bomRevision: example_value
                      routingRevision: example_value
                      description: A sample description.
                      firmPlannedFlag: 10
                      creationDate: '2026-01-15T10:30:00Z'
                      lastUpdateDate: '2026-01-15T10:30:00Z'
                    totalCount: 10
                    hasMore: true
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createDiscreteJob
      summary: Create a Wip Discrete Job
      description: Creates a new WIP discrete manufacturing job using the WIP_JOB_SCHEDULE_INTERFACE table and WIP Mass Load concurrent program.
      tags:
      - Work in Process
      security:
      - tokenAuth: []
      - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DiscreteJobCreate'
            examples:
              CreatediscretejobRequestExample:
                summary: Default createDiscreteJob request
                x-microcks-default: true
                value:
                  wipEntityName: example_value
                  primaryItemId: '500123'
                  organizationId: '500123'
                  statusType: 10
                  jobType: 10
                  startQuantity: 42.5
                  scheduledStartDate: '2026-01-15T10:30:00Z'
                  scheduledCompletionDate: '2026-01-15T10:30:00Z'
                  classCode: example_value
                  bomRevision: example_value
                  routingRevision: example_value
                  description: A sample description.
                  firmPlannedFlag: 10
      responses:
        '201':
          description: Discrete job created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiscreteJob'
              examples:
                Creatediscretejob201Example:
                  summary: Default createDiscreteJob 201 response
                  x-microcks-default: true
                  value:
                    wipEntityId: '500123'
                    wipEntityName: example_value
                    organizationId: '500123'
                    primaryItemId: '500123'
                    primaryItemNumber: example_value
                    statusType: 10
                    jobType: 10
                    startQuantity: 42.5
                    quantityCompleted: 42.5
                    quantityScrapped: 42.5
                    netQuantity: 42.5
                    scheduledStartDate: '2026-01-15T10:30:00Z'
                    scheduledCompletionDate: '2026-01-15T10:30:00Z'
                    dateReleased: '2026-01-15T10:30:00Z'
                    dateCompleted: '2026-01-15T10:30:00Z'
                    dateClosed: '2026-01-15T10:30:00Z'
                    classCode: example_value
                    bomRevision: example_value
                    routingRevision: example_value
                    description: A sample description.
                    firmPlannedFlag: 10
                    creationDate: '2026-01-15T10:30:00Z'
                    lastUpdateDate: '2026-01-15T10:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /wip/discreteJobs/{wipEntityId}:
    get:
      operationId: getDiscreteJobById
      summary: Retrieve a Specific Discrete Job
      description: Retrieves a WIP discrete job by its entity identifier.
      tags:
      - Work in Process
      security:
      - tokenAuth: []
      - basicAuth: []
      parameters:
      - name: wipEntityId
        in: path
        required: true
        schema:
          type: integer
        example: '500123'
      responses:
        '200':
          description: Discrete job details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DiscreteJob'
              examples:
                Getdiscretejobbyid200Example:
                  summary: Default getDiscreteJobById 200 response
                  x-microcks-default: true
                  value:
                    wipEntityId: '500123'
                    wipEntityName: example_value
                    organizationId: '500123'
                    primaryItemId: '500123'
                    primaryItemNumber: example_value
                    statusType: 10
                    jobType: 10
                    startQuantity: 42.5
                    quantityCompleted: 42.5
                    quantityScrapped: 42.5
                    netQuantity: 42.5
                    scheduledStartDate: '2026-01-15T10:30:00Z'
                    scheduledCompletionDate: '2026-01-15T10:30:00Z'
                    dateReleased: '2026-01-15T10:30:00Z'
                    dateCompleted: '2026-01-15T10:30:00Z'
                    dateClosed: '2026-01-15T10:30:00Z'
                    classCode: example_value
                    bomRevision: example_value
                    routingRevision: example_value
                    description: A sample description.
                    firmPlannedFlag: 10
                    creationDate: '2026-01-15T10:30:00Z'
                    lastUpdateDate: '2026-01-15T10:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /wip/operations:
    get:
      operationId: getWipOperations
      summary: Retrieve Wip Operations
      description: Retrieves work order operation records. Maps to the WIP_OPERATIONS table for tracking operation-level progress.
      tags:
      - Work in Process
      security:
      - tokenAuth: []
      - basicAuth: []
      parameters:
      - name: wipEntityId
        in: query
        description: WIP entity identifier
        schema:
          type: integer
        example: '500123'
      - name: operationSeqNum
        in: query
        description: Operation sequence number
        schema:
          type: integer
        example: 10
      - name: organizationId
        in: query
        description: Organization identifier
        schema:
          type: integer
        example: '500123'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: List of WIP operations
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/WipOperation'
                  totalCount:
                    type: integer
                  hasMore:
                    type: boolean
              examples:
                Getwipoperations200Example:
                  summary: Default getWipOperations 200 response
                  x-microcks-default: true
                  value:
                    items:
                    - wipEntityId: '500123'
                      operationSeqNum: 10
                      organizationId: '500123'
                      departmentId: '500123'
                      departmentCode: example_value
                      operationDescription: example_value
                      scheduledQuantity: 42.5
                      quantityInQueue: 42.5
                      quantityRunning: 42.5
                      quantityCompleted: 42.5
                      quantityScrapped: 42.5
                      firstUnitStartDate: '2026-01-15T10:30:00Z'
                      lastUnitCompletionDate: '2026-01-15T10:30:00Z'
                      countPointType: 10
                      backflushFlag: 10
                    totalCount: 10
                    hasMore: true
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /wip/completions:
    post:
      operationId: completeAssembly
      summary: Complete Wip Assembly
      description: Records WIP assembly completion transactions. Uses the WIP_COMPLETION PL/SQL API to move completed assemblies from WIP into inventory.
      tags:
      - Work in Process
      security:
      - tokenAuth: []
      - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompletionTransaction'
            examples:
              CompleteassemblyRequestExample:
                summary: Default completeAssembly request
                x-microcks-default: true
                value:
                  wipEntityId: '500123'
                  organizationId: '500123'
                  transactionQuantity: 42.5
                  transactionUom: example_value
                  subinventoryCode: example_value
                  locatorId: '500123'
                  transactionDate: '2026-01-15T10:30:00Z'
      responses:
        '201':
          description: Completion transaction recorded
          content:
            application/json:
              schema:
                type: object
                properties:
                  transactionId:
                    type: integer
                  status:
                    type: string
                  message:
                    type: string
              examples:
                Completeassembly201Example:
                  summary: Default completeAssembly 201 response
                  x-microcks-default: true
                  value:
                    transactionId: '500123'
                    status: example_value
                    message: example_value
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /wip/materialTransactions:
    post:
      operationId: issueMaterial
      summary: Issue Material to Wip
      description: Records material issue/return transactions for WIP jobs. Uses the WIP material transaction interface (WIP_MOVE_TXN_INTERFACE).
      tags:
      - Work in Process
      security:
      - tokenAuth: []
      - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MaterialTransaction'
            examples:
              IssuematerialRequestExample:
                summary: Default issueMaterial request
                x-microcks-default: true
                value:
                  wipEntityId: '500123'
                  organizationId: '500123'
                  operationSeqNum: 10
                  inventoryItemId: '500123'
                  transactionQuantity: 42.5
                  transactionUom: example_value
                  transactionType: WIP_ISSUE
                  subinventoryCode: example_value
                  locatorId: '500123'
                  transactionDate: '2026-01-15T10:30:00Z'
      responses:
        '201':
          description: Material transaction recorded
          content:
            application/json:
              schema:
                type: object
                properties:
                  transactionId:
                    type: integer
                  status:
                    type: string
                  message:
                    type: string
              examples:
                Issuematerial201Example:
                  summary: Default issueMaterial 201 response
                  x-microcks-default: true
                  value:
                    transactionId: '500123'
                    status: example_value
                    message: example_value
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    MaterialTransaction:
      type: object
      required:
      - wipEntityId
      - organizationId
      - inventoryItemId
      - transactionQuantity
      - transactionType
      properties:
        wipEntityId:
          type: integer
          description: WIP entity identifier
          example: '500123'
        organizationId:
          type: integer
          description: Organization identifier
          example: '500123'
        operationSeqNum:
          type: integer
          description: Operation sequence number
          example: 10
        inventoryItemId:
          type: integer
          description: Inventory item identifier
          example: '500123'
        transactionQuantity:
          type: number
          format: double
          description: Transaction quantity (positive=issue, negative=return)
          example: 42.5
        transactionUom:
          type: string
          description: Transaction unit of measure
          example: example_value
        transactionType:
          type: string
          description: Transaction type
          enum:
          - WIP_ISSUE
          - WIP_RETURN
          example: WIP_ISSUE
        subinventoryCode:
          type: string
          description: Source/destination subinventory
          example: example_value
        locatorId:
          type: integer
          description: Locator identifier
          example: '500123'
        transactionDate:
          type: string
          format: date-time
          description: Transaction date
          example: '2026-01-15T10:30:00Z'
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            detail:
              type: string
          example: example_value
    DiscreteJobCreate:
      type: object
      required:
      - primaryItemId
      - organizationId
      - startQuantity
      - scheduledStartDate
      - scheduledCompletionDate
      - classCode
      properties:
        wipEntityName:
          type: string
          example: example_value
        primaryItemId:
          type: integer
          example: '500123'
        organizationId:
          type: integer
          example: '500123'
        statusType:
          type: integer
          default: 1
          example: 10
        jobType:
          type: integer
          default: 1
          example: 10
        startQuantity:
          type: number
          format: double
          example: 42.5
        scheduledStartDate:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        scheduledCompletionDate:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        classCode:
          type: string
          example: example_value
        bomRevision:
          type: string
          example: example_value
        routingRevision:
          type: string
          example: example_value
        description:
          type: string
          example: A sample description.
        firmPlannedFlag:
          type: integer
          default: 2
          example: 10
    CompletionTransaction:
      type: object
      required:
      - wipEntityId
      - organizationId
      - transactionQuantity
      properties:
        wipEntityId:
          type: integer
          description: WIP entity identifier
          example: '500123'
        organizationId:
          type: integer
          description: Organization identifier
          example: '500123'
        transactionQuantity:
          type: number
          format: double
          description: Completion quantity
          example: 42.5
        transactionUom:
          type: string
          description: Transaction unit of measure
          example: example_value
        subinventoryCode:
          type: string
          description: Completion subinventory
          example: example_value
        locatorId:
          type: integer
          description: Completion locator
          example: '500123'
        transactionDate:
          type: string
          format: date-time
          description: Transaction date
          example: '2026-01-15T10:30:00Z'
    WipOperation:
      type: object
      properties:
        wipEntityId:
          type: integer
          description: WIP entity identifier
          example: '500123'
        operationSeqNum:
          type: integer
          description: Operation sequence number
          example: 10
        organizationId:
          type: integer
          description: Organization identifier
          example: '500123'
        departmentId:
          type: integer
          description: Department identifier
          example: '500123'
        departmentCode:
          type: string
          example: example_value
        operationDescription:
          type: string
          description: Operation description
          example: example_value
        scheduledQuantity:
          type: number
          format: double
          example: 42.5
        quantityInQueue:
          type: number
          format: double
          description: Quantity in queue
          example: 42.5
        quantityRunning:
          type: number
          format: double
          description: Quantity running
          example: 42.5
        quantityCompleted:
          type: number
          format: double
          description: Quantity completed
          example: 42.5
        quantityScrapped:
          type: number
          format: double
          description: Quantity scrapped
          example: 42.5
        firstUnitStartDate:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        lastUnitCompletionDate:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        countPointType:
          type: integer
          example: 10
        backflushFlag:
          type: integer
          example: 10
    DiscreteJob:
      type: object
      properties:
        wipEntityId:
          type: integer
          description: WIP entity identifier
          example: '500123'
        wipEntityName:
          type: string
          description: Job name/number
          example: example_value
        organizationId:
          type: integer
          description: Organization identifier
          example: '500123'
        primaryItemId:
          type: integer
          description: Primary assembly item identifier
          example: '500123'
        primaryItemNumber:
          type: string
          description: Primary assembly item number
          example: example_value
        statusType:
          type: integer
          description: Job status (1=Unreleased, 3=Released, 4=Complete, 5=Complete-No Charges, 6=On Hold, 7=Cancelled, 12=Closed, 14=Pending Close, 15=Failed Close)
          example: 10
        jobType:
          type: integer
          description: Job type (1=Standard, 3=Non-Standard)
          example: 10
        startQuantity:
          type: number
          format: double
          description: Start quantity
          example: 42.5
        quantityCompleted:
          type: number
          format: double
          description: Quantity completed
          example: 42.5
        quantityScrapped:
          type: number
          format: double
          description: Quantity scrapped
          example: 42.5
        netQuantity:
          type: number
          format: double
          description: Net quantity remaining
          example: 42.5
        scheduledStartDate:
          type: string
          format: date-time
          description: Scheduled start date
          example: '2026-01-15T10:30:00Z'
        scheduledCompletionDate:
          type: string
          format: date-time
          description: Scheduled completion date
          example: '2026-01-15T10:30:00Z'
        dateReleased:
          type: string
          format: date-time
          description: Date released
          example: '2026-01-15T10:30:00Z'
        dateCompleted:
          type: string
          format: date-time
          description: Date completed
          example: '2026-01-15T10:30:00Z'
        dateClosed:
          type: string
          format: date-time
          description: Date closed
          example: '2026-01-15T10:30:00Z'
        classCode:
          type: string
          description: Accounting class code
          example: example_value
        bomRevision:
          type: string
          description: BOM revision
          example: example_value
        routingRevision:
          type: string
          description: Routing revision
          example: example_value
        description:
          type: string
          description: Job description
          example: A sample description.
        firmPlannedFlag:
          type: integer
          description: Firm planned flag (1=Firm, 2=Not Firm)
          example: 10
        creationDate:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        lastUpdateDate:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required or token expired
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    Offset:
      name: offset
      in: query
      description: Number of records to skip for pagination
      schema:
        type: integer
        default: 0
    Limit:
      name: limit
      in: query
      description: Maximum number of records to return
      schema:
        type: integer
        default: 25
        maximum: 500
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication with Oracle EBS username and password
    tokenAuth:
      type: apiKey
      in: cookie
      name: accessToken
      description: Token-based authentication using the ISG login access token