openapi: 3.0.3
info:
  title: Oracle Integration Developer Adapters B2B Documents API
  description: Developer API for Oracle Integration 3 providing day-to-day management of integrations, connections, packages, libraries, lookups, certificates, scheduled integrations, monitoring, B2B trading partner operations, and rapid adapter building.
  version: 1.0.0
  contact:
    name: Oracle Integration Support
    email: oracle-integration-support@oracle.com
    url: https://www.oracle.com/support/
  license:
    name: Oracle Terms of Service
    url: https://www.oracle.com/legal/terms.html
  x-generated-from: documentation
  x-last-validated: '2026-04-18'
servers:
- url: https://{instance}.integration.ocp.oraclecloud.com
  description: Oracle Integration Cloud Instance
  variables:
    instance:
      default: myinstance
      description: Oracle Integration instance name
security:
- oauth2: []
- basicAuth: []
tags:
- name: B2B Documents
  description: B2B document customization and schema management.
paths:
  /ic/api/b2b/v1/b2bdocuments:
    get:
      operationId: listB2bDocuments
      summary: Oracle Integration List B2B Documents
      description: Retrieve a list of all B2B documents.
      tags:
      - B2B Documents
      parameters:
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          description: B2B documents retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/B2BDocumentList'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createB2bDocument
      summary: Oracle Integration Create B2B Document
      description: Create a new B2B document.
      tags:
      - B2B Documents
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/B2BDocumentCreate'
      responses:
        '201':
          description: B2B document created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/B2BDocument'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ic/api/b2b/v1/b2bdocuments/{documentId}:
    get:
      operationId: getB2bDocument
      summary: Oracle Integration Get B2B Document
      description: Retrieve a specific B2B document.
      tags:
      - B2B Documents
      parameters:
      - name: documentId
        in: path
        required: true
        description: B2B document identifier.
        schema:
          type: string
      responses:
        '200':
          description: B2B document details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/B2BDocument'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateB2bDocument
      summary: Oracle Integration Update B2B Document
      description: Update an existing B2B document.
      tags:
      - B2B Documents
      parameters:
      - name: documentId
        in: path
        required: true
        description: B2B document identifier.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/B2BDocumentCreate'
      responses:
        '200':
          description: B2B document updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/B2BDocument'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteB2bDocument
      summary: Oracle Integration Delete B2B Document
      description: Delete a B2B document.
      tags:
      - B2B Documents
      parameters:
      - name: documentId
        in: path
        required: true
        description: B2B document identifier.
        schema:
          type: string
      responses:
        '204':
          description: B2B document deleted.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ic/api/b2b/v1/schemas:
    get:
      operationId: listB2bSchemas
      summary: Oracle Integration List B2B Schemas
      description: Retrieve a list of all B2B schemas.
      tags:
      - B2B Documents
      responses:
        '200':
          description: B2B schemas retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/B2BSchemaList'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ic/api/b2b/v1/standards:
    get:
      operationId: listB2bStandards
      summary: Oracle Integration List B2B Document Standards
      description: Retrieve all B2B document standards.
      tags:
      - B2B Documents
      responses:
        '200':
          description: B2B standards retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/B2BStandardList'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          description: Error type URI.
          example: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
        title:
          type: string
          description: Short error title.
          example: Bad Request
        detail:
          type: string
          description: Detailed error message.
          example: Invalid connection identifier format.
        status:
          type: integer
          description: HTTP status code.
          example: 400
    B2BStandardList:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                example: X12
              name:
                type: string
                example: ANSI ASC X12
              versions:
                type: array
                items:
                  type: string
                example:
                - '004010'
                - '005010'
    B2BDocument:
      type: object
      properties:
        id:
          type: string
          description: B2B document identifier.
          example: '500789'
        name:
          type: string
          description: Document name.
          example: Purchase Order 850
        standard:
          type: string
          description: B2B document standard.
          example: X12
        version:
          type: string
          description: Document version.
          example: '005010'
        transactionType:
          type: string
          description: Transaction type code.
          example: '850'
        direction:
          type: string
          description: Document direction.
          enum:
          - INBOUND
          - OUTBOUND
          example: INBOUND
    B2BSchemaList:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                example: '600123'
              name:
                type: string
                example: X12_005010_850
              standard:
                type: string
                example: X12
    B2BDocumentList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/B2BDocument'
        totalResults:
          type: integer
          example: 12
        hasMore:
          type: boolean
          example: false
    B2BDocumentCreate:
      type: object
      properties:
        name:
          type: string
          description: Document name.
          example: Invoice 810
        standard:
          type: string
          description: B2B standard.
          example: X12
        version:
          type: string
          description: Standard version.
          example: '005010'
        transactionType:
          type: string
          description: Transaction type.
          example: '810'
  responses:
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Bad request - invalid input.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required or invalid credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    limitParam:
      name: limit
      in: query
      description: Maximum number of items to return.
      schema:
        type: integer
        default: 20
        example: 20
    offsetParam:
      name: offset
      in: query
      description: Number of items to skip before returning results.
      schema:
        type: integer
        default: 0
        example: 0
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication via Oracle Identity Cloud Service (IDCS).
      flows:
        authorizationCode:
          authorizationUrl: https://{idcs-url}/oauth2/v1/authorize
          tokenUrl: https://{idcs-url}/oauth2/v1/token
          scopes:
            urn:opc:resource:consumer::all: Full access to Oracle Integration APIs
    basicAuth:
      type: http
      scheme: basic
      description: Basic authentication with Oracle Integration credentials.