{
  "opencollection": "1.0.0",
  "info": {
    "name": "Product Catalog Management",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "catalog",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List or find Catalog objects",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/catalog",
            "headers": [
              {
                "name": "transactionId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "Issellable",
                "value": "",
                "type": "query",
                "description": "ascertains whether the product is sellable or not"
              },
              {
                "name": "category name",
                "value": "",
                "type": "query",
                "description": "name of the product category"
              },
              {
                "name": "lifecycle",
                "value": "",
                "type": "query"
              },
              {
                "name": "business type",
                "value": "",
                "type": "query"
              },
              {
                "name": "depth",
                "value": "",
                "type": "query",
                "description": "used to expand inline referenced entities up to the level specified"
              },
              {
                "name": "market segment",
                "value": "",
                "type": "query",
                "description": "name of the product market segment,e.g individual, Staff"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "fields to be included in the response, name, id, url"
              }
            ]
          },
          "docs": "This operation list or find Catalog entities"
        },
        {
          "info": {
            "name": "Retrieves a 'Catalog' by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/catalog/:id",
            "headers": [
              {
                "name": "transactionId",
                "value": ""
              },
              {
                "name": "countryCode",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifier of the Category"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "name,id,description,businessType,version,productOffering,productOfferingTerm,productOfferingPrice"
              },
              {
                "name": "targetprice",
                "value": "",
                "type": "query",
                "description": "target of the policy to determine pricing, pass pricepolicy for this parameter"
              }
            ]
          },
          "docs": "Retrieves a 'Catalog' by Id"
        }
      ]
    },
    {
      "info": {
        "name": "category",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieves a Category by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/category/:id",
            "headers": [
              {
                "name": "transactionId",
                "value": ""
              },
              {
                "name": "countryCode",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifier of the Category"
              },
              {
                "name": "senderId",
                "value": "",
                "type": "query",
                "description": "Provide the channel information"
              },
              {
                "name": "serviceNumber",
                "value": "",
                "type": "query",
                "description": "Unique identifier. This may be customer msisdn, customer id etc."
              },
              {
                "name": "custom",
                "value": "",
                "type": "query",
                "description": "Reserve for future use. Hold additional filter criteria"
              }
            ]
          },
          "docs": "This operation retrieves a Category entity. Attribute selection is enabled for all first level attributes."
        }
      ]
    },
    {
      "info": {
        "name": "channelService",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieves the dynamic ProductOffering by ID for USSD",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/productOffering/:id/dynamicOffers",
            "headers": [
              {
                "name": "transactionId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifier of the ProductOffering"
              },
              {
                "name": "offerType",
                "value": "",
                "type": "query"
              },
              {
                "name": "offerMenuId",
                "value": "",
                "type": "query",
                "description": "This will be used by 3PP to pass the AuthKey values."
              },
              {
                "name": "validity",
                "value": "",
                "type": "query"
              },
              {
                "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. Subscriber Type can be passed like Prepaid or Postpaid."
              },
              {
                "name": "platform",
                "value": "",
                "type": "query",
                "description": "This flag correlates to the allPlatforms flag in the response. In essence, its a ‘Flag’ indicating which platform the bundles is being requested for. All - Indicates that all bundles should be returned. ‘Self Service’ - Indicates the bundles are being requested for self-service platforms ‘Assisted Sales’ - Indicates the bundles are being requested for assisted sales channels CSR Only"
              },
              {
                "name": "channel",
                "value": "",
                "type": "query",
                "description": "This parameter indicates which channel the response is for. like \"All\", \"IVR\", \"MTNApp\", \"USSD\", \"Portal\""
              },
              {
                "name": "bundleState",
                "value": "",
                "type": "query",
                "description": "When passed in input ,helps to return only the 'Active' or 'Inactive' or 'All' the bundles . Allowed values 'Active' , 'Inactive' and 'All'."
              },
              {
                "name": "subscriberType",
                "value": "",
                "type": "query",
                "description": "The subscriber type associated to the MSISDN entered above. The field can be one of the following values-Converged,Prepaid, MVNO,Contract,Hybrid,EBU,FTTH.The Neon offers will be returned irrespective of the subtye."
              },
              {
                "name": "amount",
                "value": "",
                "type": "query",
                "description": "Specify the balance amount"
              },
              {
                "name": "topSeller",
                "value": "",
                "type": "query",
                "description": "When set to 'Yes' output contains both the top selling and regular bundles. When set to 'No' the output contains only the regular bundles. When set to 'All' returns both the top selling and regular bundles .Allowed values 'Yes','No','All'"
              },
              {
                "name": "purchaseMedium",
                "value": "",
                "type": "query",
                "description": "When passed in input ,helps to return only the matched bundles.Suppose if user tries to buy via Airtime this parameter takes value as 'Airtime' and those applicable bundles are returned.Allowed values 'Card','Airtime','Momo','Loyalty' and 'All'."
              },
              {
                "name": "pricePlanId",
                "value": "",
                "type": "query",
                "description": "The priceplan ID associated to the MSISDN entered above. Bundles that are not applicable to this price plan are excluded from the response based on this parameter and also bundles only applicable for the price plan is returned."
              },
              {
                "name": "suburb",
                "value": "",
                "type": "query",
                "description": "Specify the suburb of the customer"
              },
              {
                "name": "city",
                "value": "",
                "type": "query",
                "description": "Specify the city of the customer"
              },
              {
                "name": "province",
                "value": "",
                "type": "query",
                "description": "Specify the province of the customer"
              }
            ]
          },
          "docs": "This operation retrieves a ProductOffering entity. Attribute selection is enabled for all first level attributes."
        }
      ]
    }
  ],
  "bundled": true
}