MTN Group Product API

openapi: 3.2.0
info:
  title: TMF637- Inventory Management Product API
  description: '**TMF API Reference : TMF 637 - Product Inventory Management**


    '
  version: 4.0.0
servers:
- url: https://serverRoot/tmf-api/productInventory/v4/
security:
- ApiKeyAuth: []
- OAuth2: []
tags:
- name: product
paths:
  /product:
    get:
      operationId: listProduct
      summary: List or find Product objects
      description: This operation list or find Product entities
      tags:
      - product
      parameters:
      - name: customerNodeId
        description: Identifier of the customer. SV_MAPPING:CUSTOMER_NODE_TRE_V.CUSTOMER_NODE_ID
        required: false
        in: query
        schema:
          type: string
      - name: planName
        description: Identifier of the offer display name. SV_MAPPING:PRODUCT_NSTANCE_TRE_V.PRODUCT_OFFER_DISPLAY_NAME. Default to All. Supports comma separated list of values
        required: false
        in: query
        schema:
          type: string
      - name: offerIds
        description: Identifier of the offer id. SV_MAPPING:PRODUCT_OFFER_TRE_V.PRODUCT_OFFER_ID. Supports comma separated list of values
        required: false
        in: query
        schema:
          type: string
      - name: serviceName
        description: Identifier of the service name. SV_MAPPING:SERVICE_TRE_V.SERVICE_NAME. Support wildcard. If wildcard is provided, then 'LIKE' SQL operator is enforced by the API, otherwise '=' is used.
        required: false
        in: query
        schema:
          type: string
      - name: subscriberName
        description: Identifier of the subscriber name. SV_MAPPING:PERSON_TRE_V.OFFICIAL_NAME. Support wildcard. If wildcard is provided, then 'LIKE' SQL operator is enforced by the API, otherwise '=' is used.
        required: false
        in: query
        schema:
          type: string
      - name: subscriptionStatus
        description: SV_MAPPING:PRODUCT_INSTANCE_TRE_V.PRODUCT_INSTANCE_STATUS_CODE. Refer to RT perestapi.imp.PRODUCT_INSTANCE_STATUS. Default to All
        required: false
        in: query
        schema:
          type: string
      - name: includeStatus
        description: 'Filter for base product instances status. If set to ''All'', all instances will be returned regardless the status. If set to ''Cancelled'', only all Cancelled, Moved and Upgraded status instances will be included in the main query. If set to Non-Cancelled, then all instances will be included in the main query except for Cancelled, Moved and Upgraded status instances. Default is set to ''All''. SV_MAPPING: RT perestapi.INCLUDE_STATUS'
        required: false
        in: query
        x-refdata-source: RT-perestapi.INCLUDE_STATUS
        schema:
          type: string
      - name: sortKey
        description: To sort the response based on sortKey. Possible values - validFor. These values are retrieved from RT perestapi.imp.product.SORT_KEY
        required: false
        in: query
        schema:
          type: string
      - name: sortOrder
        description: To sort the response based on sort order. Possible value ascending, descending. Default to descending if sortKey is provided.
        required: false
        in: query
        schema:
          type: string
      - name: offset
        description: Requested index for start of resources to be provided in response. Default to 0
        required: false
        in: query
        schema:
          type: integer
          format: int64
      - name: limit
        description: Requested number of resources to be provided in response. Default to configuration item API_CONFIGURATION1.DEFAULT_MAX_ROWS
        required: false
        in: query
        schema:
          type: integer
          format: int64
      - name: scn
        description: Oracle system change number used for data read consistency. Default to emtpy string if configuration item API_CONFIGURATION1.USE_FLASHBACK is not ON
        required: false
        in: query
        schema:
          type: string
      - name: fields
        description: Comma-separated properties to provide in response
        required: false
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
          headers:
            X-Result-Count:
              description: Actual number of items returned in the response body
              schema:
                type: integer
            X-Total-Count:
              description: Total number of items matching criteria
              schema:
                type: integer
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Product'
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: Method Not allowed
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
  /product/{id}:
    get:
      operationId: retrieveProduct
      summary: Retrieves a Product by ID
      description: This operation retrieves a Product entity. Attribute selection is enabled for all first level attributes.
      tags:
      - product
      parameters:
      - name: id
        description: Identifier of the Product
        required: true
        in: path
        schema:
          type: string
      - name: fields
        description: Comma-separated properties to provide in response
        required: false
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Product'
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '405':
          description: Method Not allowed
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Conflict
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    RelatedParty:
      type: object
      description: Related Entity reference. A related party defines party or party role linked to a specific entity.
      required:
      - '@referredType'
      - id
      properties:
        id:
          type: string
          description: Unique identifier of a related entity.
        href:
          type: string
          description: Reference of the related entity.
        name:
          type: string
          description: Name of the related entity.
        role:
          type: string
          description: Role played by the related party
        '@baseType':
          type: string
          description: When sub-classing, this defines the super-class
        '@schemaLocation':
          type: string
          format: uri
          description: A URI to a JSON-Schema file that defines additional attributes and relationships
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class entity name
        '@referredType':
          type: string
          description: The actual type of the target instance when needed for disambiguation.
    Price:
      type: object
      description: Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.
      properties:
        percentage:
          type: number
          format: float
          description: Percentage to apply for ProdOfferPriceAlteration
        tax:
          type: array
          items:
            $ref: '#/components/schemas/TaxItem'
          description: An amount of money levied on the price of a Product by a legislative body.
        priceCharacteristic:
          type: array
          items:
            $ref: '#/components/schemas/Characteristic'
          description: Additional attributes that describe price.
        taxRate:
          type: number
          format: float
          description: Tax rate
        dutyFreeAmount:
          $ref: '#/components/schemas/Money'
          description: All taxes excluded amount (expressed in the given currency)
        taxIncludedAmount:
          $ref: '#/components/schemas/Money'
          description: All taxes included amount (expressed in the given currency)
        '@baseType':
          type: string
          description: When sub-classing, this defines the super-class
        '@schemaLocation':
          type: string
          format: uri
          description: A URI to a JSON-Schema file that defines additional attributes and relationships
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class entity name
    UsageConsumptionGroup:
      type: object
      description: Group of relevant entitlements and their consumption details at any give point in time.
      properties:
        id:
          type: string
          description: Entitlement context code ID. SV_MAPPING:ENTITLEMENT_TYPE_TRE_V.CONTEXT_CODE-PRODUCT_INSTANCE_TRE_V.PRODUCT_INSTANCE_ID-Shareable DA ID
        context:
          type: string
          description: 'Entitlement context code name. SV_MAPPING:ENTITLEMENT_TYPE_TRE_V.CONTEXT_CODE. Refer to RT Entitlement Type Context e.g.: Customer, Customer Node and Service'
        shareable:
          type: string
          description: '''Yes''/''No''. SV_MAPPING:RT YES_NO. For customer and customer node always ''Yes''. For service context, if ENTITLEMENT_TRE_V.SUB_CATEGORY = SHAREABLE then ''Yes'', otherwise ''No'''
        sharePool:
          $ref: '#/components/schemas/SharePool'
          description: Share pool detail if SV_MAPPING:ENTITLEMENT_TRE_V.SUB_CATEGORY = 'SHAREABLE'
        limits:
          type: array
          items:
            $ref: '#/components/schemas/Limits'
          description: Free units consumption limit tracker details for the realizing service
        usageConsumptionList:
          type: array
          items:
            $ref: '#/components/schemas/UsageConsumption'
          description: Describe the list of entitlements details within the same context or same shared pool. !!!OOS(For shared pooling, the entitlments could be contributed by other services at which the source service name can be found in entitlement characteristic details.)
        '@baseType':
          type: string
          description: 'When sub-classing, this defines the sub-class entity name, Fixed Value (populated only for counter entitlements as of now): Milestone; null for every other case'
          x-refdata-source: RT-perestapi.BASE_TYPE
    ProductTerm:
      type: object
      description: Description of a productTerm linked to this product. This represent a commitment with a duration
      properties:
        id:
          type: string
          description: SV_MAPPING:Unique identifier of the productOfferingTerm. Contract -> offerId-productId-entitlementCategoryCode-productInstanceId
        description:
          type: string
          description: Description of the productTerm
        name:
          type: string
          description: Name of the productTerm
        duration:
          $ref: '#/components/schemas/Quantity'
          description: Duration of the productTerm
        validFor:
          $ref: '#/components/schemas/TimePeriod'
          description: productTerm validity period
        productTermCharacteristic:
          type: array
          items:
            $ref: '#/components/schemas/ProductTermCharacteristic'
          description: A characteristic quality or distinctive feature of a product term like Contract Status, Document Required, Cancellation Reason and Initiate Renewal
        '@baseType':
          type: string
          description: When sub-classing, this defines the super-class
        '@schemaLocation':
          type: string
          format: uri
          description: A URI to a JSON-Schema file that defines additional attributes and relationships
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class entity name
    PriceAlteration:
      type: object
      description: Is an amount, usually of money, that modifies the price charged for an order item.
      required:
      - price
      - priceType
      properties:
        id:
          type: string
          description: unique id of this resource.
        applicationDuration:
          type: integer
          description: Duration during which the alteration applies on the order item price (for instance 2 months free of charge for the recurring charge)
        description:
          type: string
          description: A narrative that explains in detail the semantics of this order item price alteration
        name:
          type: string
          description: Name of the order item price alteration
        priceType:
          type: string
          description: A category that describes the price such as recurring, one time and usage.
        priority:
          type: integer
          description: Priority level for applying this alteration among all the defined alterations on the order item price
        recurringChargePeriod:
          type: string
          description: Could be month, week...
        unitOfMeasure:
          type: string
          description: Could be minutes, GB...
        price:
          $ref: '#/components/schemas/Price'
        productOfferingPrice:
          $ref: '#/components/schemas/ProductOfferingPriceRef'
        '@baseType':
          type: string
          description: When sub-classing, this defines the super-class
        '@schemaLocation':
          type: string
          format: uri
          description: A URI to a JSON-Schema file that defines additional attributes and relationships
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class entity name
    ResourceRef:
      type: object
      required:
      - id
      properties:
        id:
          type: string
          description: Unique identifier of a related entity.
        href:
          type: string
          description: Reference of the related entity.
        name:
          type: string
          description: Name of the resource
        value:
          type: string
          description: 'The resource value that can be used to identify a resource with a public key (e.g.: a tel nr, an msisdn)'
        '@baseType':
          type: string
          description: When sub-classing, this defines the super-class
        '@schemaLocation':
          type: string
          format: uri
          description: A URI to a JSON-Schema file that defines additional attributes and relationships
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class entity name
        '@referredType':
          type: string
          description: The actual type of the target instance when needed for disambiguation.
    AttachmentRefOrValue:
      type: object
      description: An attachment by value or by reference.
      properties:
        id:
          type: string
          description: Unique identifier for this particular attachment. For Product Offer images SV_MAPPING:IMG<ProductOfferId>-(1..n), For Product Offer Help SV_MAPPING:HLP<ProductOfferId>
        attachmentType:
          type: string
          description: Attachment type such as help urls, video, picture. For Product Offer images SV_MAPPING:image, For Product Offer Help SV_MAPPING:document
        name:
          type: string
          description: The name of the attachment. For Product Offer images SV_MAPPING:ImageUrl-(1..n), For Product Offer Help SV_MAPPING:HelpUrl
        url:
          type: string
          description: Uniform Resource Locator, is a web page address (a subset of URI). SV_MAPPING:PRODUCT_OFFER.PRODUCT_OFFER_IMAGE_URLS, PRODUCT_OFFER.PRODUCT_OFFER_HELP_URL
    ProductTermCharacteristicValue:
      type: object
      description: A ProductTermCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductTermCharacteristic object. The values of the attributes in the ProductTermCharacteristicValue object describe the values of the attributes that a corresponding ProductTermCharacteristic object can take on.
      properties:
        value:
          $ref: '#/components/schemas/Any'
          description: A discrete value that the characteristic can take on, or the actual value of the characteristic.
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class entity name
    ServiceStatusType:
      type: string
      description: Service status. SV_MAPPING:SERVICE_TRE_V.SERVICE_STATUS_CODE. Refer to RT perestapi.SERVICE_STATUS_CODE
    ProductSpecificationCharacteristicValue:
      type: object
      description: A ProductSpecificationCharacteristicValue object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a ProductSpecificationCharacteristic object. The values of the attributes in the ProductSpecificationCharacteristicValue object describe the values of the attributes that a corresponding ProductSpecificationCharacteristic object can take on.
      properties:
        value:
          $ref: '#/components/schemas/Any'
          description: A discrete value that the characteristic can take on, or the actual value of the characteristic
        valueType:
          type: string
          description: A kind of value that the characteristic can take on, such as numeric, text and so forth
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class entity name
    BillingAccountRef:
      type: object
      description: BillingAccount reference. A BillingAccount is a detailed description of a bill structure.
      required:
      - id
      properties:
        id:
          type: string
          description: Unique identifier of the billing account
        href:
          type: string
          description: Reference of the billing account
        name:
          type: string
          description: Name of the billing account
        '@baseType':
          type: string
          description: When sub-classing, this defines the super-class
        '@schemaLocation':
          type: string
          format: uri
          description: A URI to a JSON-Schema file that defines additional attributes and relationships
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class entity name
        '@referredType':
          type: string
          description: The actual type of the target instance when needed for disambiguation.
    Any: {}
    CharacteristicRef:
      type: object
      description: Describes a given characteristic of an object or entity through a name/value pair.
      required:
      - name
      - value
      properties:
        name:
          type: string
          description: Name of the characteristic
        valueType:
          type: string
          description: Data type of the value of the characteristic
        value:
          $ref: '#/components/schemas/Any'
          description: The value of the characteristic
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class entity name
    PaginationRef:
      type: object
      description: Query results and paging details.
      properties:
        offset:
          type: integer
          format: int64
          description: Requested index for start of items to be provided in response
        limit:
          type: integer
          format: int64
          description: Requested number of items to be provided in response
        remainingRecords:
          type: integer
          format: int64
          description: Remaining number of items to be fetched
        totalRecords:
          type: integer
          format: int64
          description: Total number of items matching criteria
        scn:
          type: string
          description: Oracle system change number for read consistency
    ProductSpecificationCharacteristic:
      type: object
      description: A characteristic quality or distinctive feature of a ProductSpecification.
      properties:
        id:
          type: string
          description: Identifier of the attribute which identifies characteristic uniquely. Example - Attribute Type Id
        dispSequence:
          type: integer
          format: int64
          description: Sequence or order in which particular attribute is shown on user interface
        configurable:
          type: string
          description: 'If true, the parameter indicates that the ProductSpecificationCharacteristic is configurable/updatable. Only applicable for ProductSpecification with @baseType as Grid/GridWithImage. SV_MAPPING: RT BOOLEAN -> Abbreviation'
        enabled:
          type: string
          description: 'If true, the parameter indicates that the ProductSpecificationCharacteristic is enabled to be supplied/selected at the time of selling. Only applicable for ProductSpecification with @baseType as Grid/GridWithImage. SV_MAPPING: RT BOOLEAN -> Abbreviation'
        name:
          type: string
          description: Name of the ProductSpecificationCharacteristic. Names which can be Recurring Period|Recurring Period Unit|Initial Allocation Amount|Initial Allocation Amount Unit|Recurring Allocation Amount|Recurring Allocation Amount Unit|Validity Period|Validity Period Unit|Warning Period|Warning Period Unit|Delay Period|Delay Period Unit|Shareable|MIN Count|MAX Count|Service Name|VAT ID|National ID|Customer Name
        productSpecCharacteristicValue:
          $ref: '#/components/schemas/ProductSpecificationCharacteristicValue'
          description: SV_MAPPING:ENTITLEMENT_TRE_V.RECURRING_PERIOD|RECURRING_PERIOD_UNIT_CODE|INITIAL_ALLOCATION_AMOUNT|UNIT_OF_MEASURE_COD|RECURRING_ALLOCATION_AMOUNT|UNIT_OF_MEASURE_COD|VALIDITY_PERIOD|VALIDITY_PERIOD_UNIT_CODE|WARNING_PERIOD|WARNING_PERIOD_UNIT_CODE|DELAY_PERIOD|DELAY_PERIOD_UNIT_CODE and PRODUCT_INSTANCE_TRE_V.GENERAL_3|Minimum Count of FnF Supported|Maximum Count of FnF Supported|PRODUCT_INSTANCE_TRE_V.GENERAL_1|FnF Customers' Party's PERSON_TRE_V.GENERAL_10|FnF Customers' Party's PERSON_TRE_V.PRIMARY_IDENTIFIER|FnF Customers' CUSTOMER_NODE_ID.NODE_NAME|Event Sub Type|Time Band'
    Bucket:
      type: object
      description: Describes allocation consumption details
      properties:
        initialQuantity:
          description: SV_MAPPING:ENTITLEMENT_ALLOCATION_TRE_V.INITIAL_AMOUNT
          $ref: '#/components/schemas/Quantity'
        balanceQuantity:
          description: SV_MAPPING:ENTITLEMENT_ALLOCATION_TRE_V.CONSUMED_AMOUNT
          $ref: '#/components/schemas/Quantity'
        consumptionPeriod:
          description: It is from SV_MAPPING:ENTITLEMENT_ALLOCATION_TRE_V.START_DATE to SV_MAPPING:ENTITLEMENT_ALLOCATION_TRE_V.EXPIRY_DATE
          $ref: '#/components/schemas/TimePeriod'
        id:
          type: string
          description: Id of the entitlement allocation. SV_MAPPING:ENTITLEMENT_ALLOCATION_TRE_V.ENTITLEMENT_ALLOCATION_ID
    GeographicAddress:
      type: object
      description: Structured textual way of describing how to find a Property for service installation
      properties:
        street1:
          type: string
          description: 'Line 1, SV_MAPPING: SERVICE_TRE_V.A_LINE_1, SERVICE_TRE_V.B_LINE_1'
        street2:
          type: string
          description: 'Line 2, SV_MAPPING: SERVICE_TRE_V.A_LINE_2, SERVICE_TRE_V.B_LINE_2'
        suburb:
          type: string
          description: 'Suburban, SV_MAPPING: SERVICE_TRE_V.A_SUBURB, SERVICE_TRE_V.B_SUBURB'
        city:
          type: string
          description: 'City, SV_MAPPING: SERVICE_TRE_V.A_CITY, SERVICE_TRE_V.B_CITY'
        postCode:
          type: string
          description: 'Post Code, SV_MAPPING: SERVICE_TRE_V.A_POST_CODE, SERVICE_TRE_V.B_POST_CODE'
        stateOrProvince:
          type: string
          description: 'State, SV_MAPPING: SERVICE_TRE_V.A_STATE, SERVICE_TRE_V.B_STATE'
        country:
          type: string
          description: 'Country, SV_MAPPING: SERVICE_TRE_V.A_COUNTRY, SERVICE_TRE_V.B_COUNTRY'
        addressLine1:
          type: string
          description: 'Address line 1, SV_MAPPING: SERVICE_TRE_V.A_GENERAL_1, SERVICE_TRE_V.B_GENERAL_1'
        geocode:
          type: string
          description: 'Geo Code providing geographical coordinates corresponding to a location, SV_MAPPING: SERVICE_TRE_V.A_GEOCODE, SERVICE_TRE_V.B_GEOCODE'
        buildingId:
          type: string
          description: 'Building Id as used for serviceability. SV_MAPPING: SERVICE_TRE_V.A_GENERAL_2, SERVICE_TRE_V.B_GENERAL_2'
        region:
          type: string
          description: 'Region as used for serviceability. SV_MAPPING: SERVICE_TRE_V.A_GENERAL_5, SERVICE_TRE_V.B_GENERAL_5'
        subDoorNumber:
          type: string
          description: 'Sub Door Number as used for serviceability. SV_MAPPING: SERVICE_TRE_V.A_GENERAL_3, SERVICE_TRE_V.B_GENERAL_3'
        genericAddress:
          type: string
          description: 'Generic Address as used for serviceability. SV_MAPPING: SERVICE_TRE_V.A_GENERAL_4, SERVICE_TRE_V.B_GENERAL_4'
        addressId:
          type: string
          description: 'Address ID of the service address as used for serviceability. SV_MAPPING: SERVICE_HISTORY.A_ADDRESS_ID, SERVICE_HISTORY.B_ADDRESS_ID'
        xpos:
          type: number
          format: float
          description: 'X coordinate of the geographic address, SV_MAPPING: SERVICE_TRE_V.A_XPOS | SERVICE_TRE_V.B_XPOS'
        ypos:
          type: number
          format: float
          description: 'Y coordinate of the geographic address, SV_MAPPING: SERVICE_TRE_V.A_YPOS | SERVICE_TRE_V.B_YPOS'
        '@type':
          type: string
          description: This is used to differentiate service address types as 'A' and 'B'
          x-refdata-source: CM-Address_Type
    Product:
      type: object
      description: A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service(s) and / or resource(s).
      properties:
        pagination:
          description: Query results and paging details.
          $ref: '#/components/schemas/PaginationRef'
        productDetails:
          type: array
          items:
            properties:
              id:
                type: string
                description: Unique identifier of the product
              href:
                type: string
                description: Reference of the product
              description:
                type: string
                description: Is the description of the product. It could be copied from the description of the Product Offering.
              isBundle:
                type: boolean
                description: If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering.
              isCustomerVisible:
                type: boolean
                description: If true, the product is visible by the customer.
              name:
                type: string
                description: Name of the product. It could be the same as the name of the product offering
              orderDate:
                type: string
                format: date-time
                description: Is the date when the product was ordered
              productSerialNumber:
                type: string
                description: Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router.
              startDate:
                type: string
                format: date-time
                description: Is the date from which the product starts
              terminationDate:
                type: string
                format: date-time
                description: Is the date when the product was terminated
              agreement:
                type: array
                items:
                  $ref: '#/components/schemas/AgreementItemRef'
              billingAccount:
                $ref: '#/components/schemas/BillingAccountRef'
              place:
                type: array
                items:
                  $ref: '#/components/schemas/RelatedPlaceRefOrValue'
              product:
                type: array
                items:
                  $ref: '#/components/schemas/ProductRefOrValue'
              productCharacteristic:
                type: array
                items:
                  $ref: '#/components/schemas/Characteristic'
              productOffering:
                $ref: '#/components/schemas/ProductOfferingRef'
              productOrderItem:
                type: array
                items:
                  $ref: '#/components/schemas/RelatedProductOrderItem'
              productPrice:
                type: array
                items:
                  $ref: '#/components/schemas/ProductPrice'
              productRelationship:
                type: array
                items:
                  $ref: '#/components/schemas/ProductRelationship'
              productSpecification:
                $ref: '#/components/schemas/ProductSpecificationRef'
              productTerm:
                type: array
                items:
                  $ref: '#/components/schemas/ProductTerm'
              realizingResource:
                type: array
                items:
                  $ref: '#/components/schemas/ResourceRef'
              realizingService:
                type: array
                items:
                  $ref: '#/components/schemas/ServiceRef'
              relatedParty:
                type: array
                items:
                  $ref: '#/components/schemas/RelatedParty'
              status:
                $ref: '#/components/schemas/ProductStatusType'
                description: Is the lifecycle status of the product.
              '@baseType':
                type: string
                description: When sub-classing, this defines the super-class
              '@schemaLocation':
                type: string
                format: uri
                description: A 

# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mtn-group/refs/heads/main/openapi/mtn-group-product-api-openapi.yml