openapi: 3.0.3
info:
  title: Product Catalog Service
  description: |
    This service allows API Consumers to get details of the products
    and services available for purchasing using Service Ordering API.
  version: '1.0'
servers:
  - url: https://apigw.omantel.om
    variables:
      apiRoot:
        default: https://apigw.omantel.om
        description: API root
      basePath:
        default: /product-catalog-service
        description: Base path for the Product Catalog service
paths:
  /product-catalog-service/ProductManagement/getCatalog:
    get:
      summary: getCatalog
      tags:
        - Get Products
      operationId: getCatalogUsingGET
      security:
        - oAuth2ClientCredentials: []
      parameters:
        - name: catalogId
          in: query
          description: catalogId
          required: true
          style: form
          schema:
            type: string
        - name: channelId
          in: query
          description: channelId
          required: true
          style: form
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            'application/json':
              schema:
                $ref: '#/components/schemas/ProductOfferring'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
components:
  schemas:
    ProductBundleBenefits:
      title: ProductBundleBenefits
      type: object
      properties:
        freeUnitProductId:
          type: string
        freeUnitProductName:
          type: string
        freeUnitProductNameAr:
          type: string
        freeUnitProductType:
          type: string
        freeUnits:
          type: string
        isInternational:
          type: string
        isNational:
          type: string
        isRoaming:
          type: string
        isUnlimited:
          type: string
    ProductCharecteristics:
      title: ProductCharecteristics
      type: object
      properties:
        autoRenewable:
          type: string
        carryForward:
          type: string
        reSubscription:
          type: string
        validity:
          type: string
    ProductOfferring:
      title: ProductOfferring
      type: object
      properties:
        productSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/ProductSpecification'
            exampleSetFlag: false
    ProductPriceSpecification:
      title: ProductPriceSpecification
      type: object
      properties:
        taxAmount:
          type: string
        taxRate:
          type: string
        totalPrice:
          type: string
        totalPriceBz:
          type: string
    ProductSpecification:
      title: ProductSpecification
      type: object
      properties:
        descriptions:
          type: string
        descriptionsAr:
          type: string
        priceSpecification:
          $ref: '#/components/schemas/ProductPriceSpecification'
        productBundleBenefits:
          type: array
          items:
            $ref: '#/components/schemas/ProductBundleBenefits'
            exampleSetFlag: false
        productCharecteristics:
          $ref: '#/components/schemas/ProductCharecteristics'
        productGroup:
          type: string
        productId:
          type: string
        productName:
          type: string
        productNameAr:
          type: string
        productStatus:
          type: string
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://apigw.omantel.om/oauth2/accesstoken
          scopes: {}