Oracle Retail Suppliers API

Supplier management

OpenAPI Specification

oracle-retail-suppliers-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Oracle Retail Merchandising Foundation Cloud Service Fulfillment Suppliers API
  description: Oracle Retail Merchandising Foundation Cloud Service (RMFCS) provides REST APIs for managing merchandise hierarchies, item setup, purchase orders, cost management, supplier management, and inventory transactions across omnichannel retail operations.
  version: 26.1.0
  contact:
    name: Oracle Retail Support
    url: https://support.oracle.com
  license:
    name: Oracle Technology Network License
    url: https://www.oracle.com/legal/terms/
servers:
- url: https://{host}/MerchServices/MerchRes/v1
  description: Oracle Retail Merchandising REST API
  variables:
    host:
      default: retail.example.com
      description: RMFCS hostname
security:
- oauth2: []
tags:
- name: Suppliers
  description: Supplier management
paths:
  /suppliers:
    get:
      operationId: listSuppliers
      summary: List suppliers
      description: Returns supplier master data including contact and payment terms.
      tags:
      - Suppliers
      parameters:
      - name: status
        in: query
        schema:
          type: string
          enum:
          - A
          - I
      - name: offset
        in: query
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        schema:
          type: integer
          default: 100
      responses:
        '200':
          description: Supplier list
          content:
            application/json:
              schema:
                type: object
                properties:
                  suppliers:
                    type: array
                    items:
                      $ref: '#/components/schemas/Supplier'
                  totalCount:
                    type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Supplier:
      type: object
      description: A merchandise supplier
      properties:
        supplier:
          type: integer
          description: Supplier number
        supplierName:
          type: string
          description: Supplier name
        status:
          type: string
          enum:
          - A
          - I
          description: A=Active, I=Inactive
        primaryContactName:
          type: string
        primaryPhone:
          type: string
        primaryEmail:
          type: string
          format: email
        remitAddress:
          type: string
        remitCity:
          type: string
        remitState:
          type: string
        remitCountry:
          type: string
          maxLength: 3
        remitZip:
          type: string
        currencyCode:
          type: string
          maxLength: 3
        paymentTerms:
          type: string
        freightTerms:
          type: string
        createDatetime:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type: array
          items:
            type: string
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://identity.oraclecloud.com/oauth2/v1/token
          scopes:
            retail.read: Read retail data
            retail.write: Write retail data