{
  "opencollection": "1.0.0",
  "info": {
    "name": "MTN Product API",
    "version": "3.0.9"
  },
  "items": [
    {
      "info": {
        "name": "products",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View product Catalog",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/products",
            "headers": [
              {
                "name": "credentials",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "nodeId",
                "value": "",
                "type": "query",
                "description": "3rd party assigned unique id"
              },
              {
                "name": "productProviderId",
                "value": "",
                "type": "query",
                "description": "This is the id of the service provider"
              },
              {
                "name": "category",
                "value": "",
                "type": "query",
                "description": "Category of the product to be fetched from that catalogue"
              },
              {
                "name": "subCategory",
                "value": "",
                "type": "query",
                "description": "This can be any of the sub category of the category entered. This may be require only if the category is passed."
              },
              {
                "name": "requestType",
                "value": "",
                "type": "query",
                "description": "This determines the type of request being send. In callertunes, it holds the SOAP Action"
              },
              {
                "name": "autoRenewal",
                "value": "",
                "type": "query",
                "description": "Specify if the product should be auto renewal or not"
              },
              {
                "name": "serviceClass",
                "value": "",
                "type": "query",
                "description": "Specify the class of service"
              },
              {
                "name": "offerName",
                "value": "",
                "type": "query",
                "description": "Specify the offer name to be searched"
              }
            ]
          },
          "docs": "Retrieves the Catalog of Products available to a 3PP identified by the nodeId."
        },
        {
          "info": {
            "name": "View product Catalog.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/products/:customerId",
            "headers": [
              {
                "name": "credentials",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of the customer. It could be MSISDN, email address, or any other customer identifier"
              },
              {
                "name": "nodeId",
                "value": "",
                "type": "query",
                "description": "3rd party assigned unique id"
              },
              {
                "name": "offerType",
                "value": "",
                "type": "query"
              },
              {
                "name": "filterByMABand",
                "value": "",
                "type": "query",
                "description": "When TRUE, The API shall return only the products that falls within the MSISDN main account balance band."
              },
              {
                "name": "category",
                "value": "",
                "type": "query",
                "description": "Category of the product to be fetched from that catalogue"
              },
              {
                "name": "subCategory",
                "value": "",
                "type": "query",
                "description": "This can be any of the sub category of the category entered. This may be require only if the category is passed."
              },
              {
                "name": "productRef",
                "value": "",
                "type": "query",
                "description": "This is an external reference number or product code which most have been generated by the provider or consumer"
              },
              {
                "name": "channel",
                "value": "",
                "type": "query"
              },
              {
                "name": "productProviderId",
                "value": "",
                "type": "query",
                "description": "This is the identifier for the backend system expected to fullfil the request"
              },
              {
                "name": "pref language",
                "value": "",
                "type": "query",
                "description": "The language in which the response is required"
              },
              {
                "name": "offerQuantity",
                "value": "",
                "type": "query",
                "description": "For Bulk SMS product, this is the number of SMS to get a price quote for."
              },
              {
                "name": "autoRenewal",
                "value": "",
                "type": "query",
                "description": "Specify if the product should be auto renewal or not"
              },
              {
                "name": "serviceClass",
                "value": "",
                "type": "query",
                "description": "Specify the class of service"
              },
              {
                "name": "offerName",
                "value": "",
                "type": "query",
                "description": "Specify the offer name to be searched"
              }
            ]
          },
          "docs": "Retrieves the Catalog of Products available to a customer identified by customerId, out of the catalog of products available to a 3PP identified by nodeId."
        },
        {
          "info": {
            "name": "Retrieve the details of a given product - Query bundle price",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/products/:customerId/:productId",
            "headers": [
              {
                "name": "credentials",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of the customer. It could be MSISDN, email address, or any other customer identifier"
              },
              {
                "name": "productId",
                "value": "",
                "type": "path",
                "description": "ID of the product"
              },
              {
                "name": "promotionCode",
                "value": "",
                "type": "query",
                "description": "Promotion code assigned to product"
              },
              {
                "name": "transactionId",
                "value": "",
                "type": "query",
                "description": "Transaction ID"
              }
            ]
          },
          "docs": "Retrieve the details of a given product, most especially it's price. If nodeId is passed to this request, the returned price will be the price of the product as listed with the 3PP identified by nodeId."
        },
        {
          "info": {
            "name": "Check the eligibility of a customer to buy a product",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/products/:customerId/eligibility/:productId",
            "headers": [
              {
                "name": "credentials",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of the customer. It could be MSISDN, email address, or any other customer identifier"
              },
              {
                "name": "productId",
                "value": "",
                "type": "path",
                "description": "ID of the product"
              },
              {
                "name": "nodeId",
                "value": "",
                "type": "query",
                "description": "3rd party assigned unique id. iname of the 3PPs which can call these service and must be whitelisted first"
              },
              {
                "name": "clientTransactionId",
                "value": "",
                "type": "query",
                "description": "Client generated Id to include for tracing requests"
              },
              {
                "name": "viewType",
                "value": "",
                "type": "query",
                "description": "The view requested"
              },
              {
                "name": "targetSystem",
                "value": "",
                "type": "query",
                "description": "The target system"
              },
              {
                "name": "registrationChannel",
                "value": "",
                "type": "query",
                "description": "Channel making request"
              },
              {
                "name": "productType",
                "value": "",
                "type": "query",
                "description": "Type of product"
              },
              {
                "name": "productCategory",
                "value": "",
                "type": "query",
                "description": "Type of category"
              }
            ]
          },
          "docs": "Check customer eligibility for product"
        },
        {
          "info": {
            "name": "Blacklist the customer to consume a product",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/products/:customerId/blacklist/:productId",
            "headers": [
              {
                "name": "transactionId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of the customer. It could be MSISDN, email address, or any other customer identifier"
              },
              {
                "name": "productId",
                "value": "",
                "type": "path",
                "description": "ID of the product"
              },
              {
                "name": "targetSystem",
                "value": "",
                "type": "query",
                "description": "The target system"
              }
            ]
          },
          "docs": "Blacklist customer for product/service"
        },
        {
          "info": {
            "name": "Make a customer dormant in relation to a to a product",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/products/:customerId/dormant",
            "headers": [
              {
                "name": "transactionId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "ID of the customer. It could be MSISDN, email address, or any other customer identifier"
              },
              {
                "name": "targetSystem",
                "value": "",
                "type": "query",
                "description": "The target system"
              }
            ]
          },
          "docs": "Make a customer dormant for product/service"
        },
        {
          "info": {
            "name": "Get product Category",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/products/:customerId/category",
            "headers": [
              {
                "name": "targetSystem",
                "value": ""
              },
              {
                "name": "transactionId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "Customer Msisdn. The format must be E.123 e.g 2349062058464"
              },
              {
                "name": "productType",
                "value": "",
                "type": "query",
                "description": "Specify the type of product request. e.g CVMoffer(Customer Value Management) is a Flytxt product."
              },
              {
                "name": "nodeId",
                "value": "",
                "type": "query",
                "description": "Third parties unique identifier. Can also be called channelId or iname"
              }
            ]
          },
          "docs": "View the list of products Category for a subscriber."
        },
        {
          "info": {
            "name": "Get list of eligible Offers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/products/:customerId/eligible",
            "headers": [
              {
                "name": "targetSystem",
                "value": ""
              },
              {
                "name": "credentials",
                "value": ""
              },
              {
                "name": "transactionId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "Customer Msisdn. The format must be E.123 e.g 2349062058464"
              },
              {
                "name": "productType",
                "value": "",
                "type": "query",
                "description": "Specify the type of product request. e.g CVMoffer(Customer Value Management) is a Flytxt product."
              },
              {
                "name": "appCpid",
                "value": "",
                "type": "query",
                "description": "Id of the product to fetch."
              },
              {
                "name": "category",
                "value": "",
                "type": "query",
                "description": "Type of offer to fetch."
              },
              {
                "name": "subCategory",
                "value": "",
                "type": "query"
              },
              {
                "name": "nodeId",
                "value": "",
                "type": "query",
                "description": "Third parties unique identifier. Can also be called channelId or iname"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The total number of offers to retrieve"
              }
            ]
          },
          "docs": "View the list of eligible products offers applicable for a subscriber."
        },
        {
          "info": {
            "name": "List or find ProductOffering objects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/products/productOffering",
            "headers": [
              {
                "name": "transactionId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "senderId",
                "value": "",
                "type": "query",
                "description": "Provide the channel information"
              },
              {
                "name": "topOffers",
                "value": "",
                "type": "query",
                "description": "If true is populated on this field, the service will return all the products where topOffers = true."
              },
              {
                "name": "yelloTraderId",
                "value": "",
                "type": "query",
                "description": "Either one or multiple yelloTraderIds (deal code) separated with comma can be passed to fetch the offers associated. example - 2020710 CT 00350,2019711 CT 00351,2019713 CT 00352"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Requested number of resources to be provided in response"
              }
            ]
          },
          "docs": "This operation list or find ProductOffering entities"
        },
        {
          "info": {
            "name": "List of roaming ProductOffering objects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/products/productOffering/roaming",
            "headers": [
              {
                "name": "transactionId",
                "value": ""
              },
              {
                "name": "x-origin-channelId",
                "value": ""
              },
              {
                "name": "targetSystem",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "productName",
                "value": "",
                "type": "query",
                "description": "Provide the product name"
              },
              {
                "name": "countryCode",
                "value": "",
                "type": "query",
                "description": "Provide the country code of the subscriber"
              },
              {
                "name": "subscriberType",
                "value": "",
                "type": "query",
                "description": "Provide the subscriber type"
              }
            ]
          },
          "docs": "This operation list or find all the roaming bundles that are available for the country and subscriber type"
        },
        {
          "info": {
            "name": "List or find ProductCatalogue objects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/products/:id/comvCatalogue",
            "headers": [
              {
                "name": "transactionId",
                "value": ""
              },
              {
                "name": "countryCode",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Provide the service information"
              }
            ]
          },
          "docs": "This operation list or find ProductCatalogue entities"
        },
        {
          "info": {
            "name": "productConfiguration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/products/productConfiguration/:id",
            "headers": [
              {
                "name": "transactionId",
                "value": ""
              },
              {
                "name": "cookie",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "nodeId",
                "value": "",
                "type": "query",
                "description": "Third parties unique identifier. Can also be called channelId"
              },
              {
                "name": "siteId",
                "value": "",
                "type": "query",
                "description": "ATG is capable of handling multisite operations. Each site can have different catalog data, pricelist etc. This parameter indicates which site the response must be given. Sample values  MTNSite, OnlineStore, EBU_CC, EBU_SME"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "This parameter represnts the DEP serviceId which must be queried"
              }
            ]
          },
          "docs": "product Configuration of items"
        },
        {
          "info": {
            "name": "Get All Type of balance for a subscriber product",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/products/:customerId/productCheckBalance",
            "headers": [
              {
                "name": "transactionId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "Customer Msisdn. The format must be E.123 e.g 2319062058464"
              },
              {
                "name": "productType",
                "value": "",
                "type": "query",
                "description": "Specify the type of product request. e.g Normal product."
              },
              {
                "name": "appCpid",
                "value": "",
                "type": "query",
                "description": "appId of the product to fetch."
              },
              {
                "name": "productId",
                "value": "",
                "type": "query",
                "description": "Id of the product to fetch."
              },
              {
                "name": "nodeId",
                "value": "",
                "type": "query",
                "description": "Third parties unique identifier. Can also be called channelId or iname"
              }
            ]
          },
          "docs": "View the list of all types of product balances for a subscriber."
        }
      ]
    }
  ],
  "bundled": true
}