Open APIs

 View Only
  • 1.  digital product ordering

    Posted Jun 13, 2023 15:03

    hi, we are new for TM Forum, 

    we are using (our API) for purchase digital product, from order management system, we tried to map our API (below) with TMF 622 as shown below: 

    our API: 

    Field Name 

    Type 

    Mandatory 

    Expected Value 

    Description 

    channel 

    Integer 

    Yes 

     

    Subscription channel 

    origin_node_type 

    String 

    Yes 

     

    sub channel id 

    operation_name 

    String 

    Yes 

    subscribe 

    Action type 

    product_id 

    String 

    Yes 

    6 

    product id 

    msisdn 

    String 

    Yes 

    Subscriber number 

    Valid subscriber number 

    extra_data 

    Array of JSON values 

    Yes 

     

     

     

    Extra Parameter 

    Type 

    Mandatory 

    Expected Value 

    Description 

    sub_product_name 

    String 

    Yes 

    bundle1-bundle7 

     

    payment_method 

    Integer 

    No 

    1: deduct fee from main account. 

    2: deduct fee from dealer. 

    Default value is 1 [main account] 

    Range 1-9. Refer to section 4.4 

    charged_number 

    String 

    Conditional   

    Charged number 

    Mandatory when payment_method=2 [Dealer] 

     

    our request: 

    { 

       "channel": 20, 

       "origin_node_type": "ODP", 

       "operation_name": "subscribe", 

       "product_id": "6", 

       "msisdn": "77XXXX", 

       "extra_data": [{ 

           "sub_product_name": "bundle1", 

           "payment_method":2, 

          "charged_number":"77YYYYY" 

       }] 

    } 

    Mapped TMF622 request: 

    { 
      "relatedChannel": [ 
        { 
          "id": "6", 
          "name": "online channel" 
        } 
      ], 
      "OrderItem":  
        { 
          "id": "6", 
          "action": "subscribe", 
          "payment": [ 
            { 
              "id": "2", 
              "name": "Cash payment for access fee" 
            } 
          ], 
          "product": { 
            "productCharacteristic": [ 
              { 
                "name": "TEL_MSISDN", 
                "valueType": "string", 
                "value": "07708193467" 
              }, 
               { 
                "name": "origin_node_type", 
                "valueType": "string", 
                "value": "ODP" 
              } 
            ], 
            "productSpecification": { 
              "id": "14307", 
              "name": "bundle1" 
            } 
          }, 
     
          "billingAccount": { 
            "id": "1513", 
            "name": "07708193466" 
          }, 

     

          "@type": "OrderItem" 
        } 
      , 
      "@type": "ProductOrder" 
    } 

    We need your support to verify our mapping, and is TMF622 the best fit API?  

    And if we want to retrieve all transactions that are done by specific customer what is the suitable API? 

     

    <quillbot-extension-portal></quillbot-extension-portal>



    ------------------------------
    zaina itriq
    TO BE VERIFIED
    ------------------------------


  • 2.  RE: digital product ordering

    Posted Jun 13, 2023 15:06

    Welcome Zaina to TMF - hope you get great value from the Open APIs.

    TMF622 is the API you need, there isn't another suitable one.

    At a quick glance, your mapping appears reasonable.

    Good luck 



    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------



  • 3.  RE: digital product ordering

    Posted Jun 15, 2023 06:47

    thank you for your response, 

    what about retrieving all transactions that are done by specific customer what is the suitable API? 

    <quillbot-extension-portal></quillbot-extension-portal>



    ------------------------------
    zaina itriq
    TO BE VERIFIED
    ------------------------------