Open APIs

  • 1.  Promotions API - access to early adoption space

    TM Forum Member
    Posted Oct 15, 2021 09:55
    Hi,

    I am currently looking into using OpenAPIs to model a transition from a legacy discount systems into one conforming to OpenAPI standards.

    I have come across the post from 2017 mentioning ongoing work on the Promotion API by Huawei. Apparently the spec and other files on promotion API should be accessible on a confluence page: https://projects.tmforum.org/wiki/pages/viewpage.action?pageId=79987286, but I have no access to it. I tried to follow the advise on this post: https://engage.tmforum.org/communities/community-home/digestviewer/viewthread?GroupId=31&MessageKey=0012afd7-ddb7-4d12-9a2d-18756cf77184&CommunityKey=d543b8ba-9d3a-4121-85ce-5b68e6c31ce5&tab=digestviewer, but the this link redirects to main tmforum page.

    Can you advise how can look into the current state of this OpenAPI? I am trying to verify whether this would be the suitable API to use for the below requirements:
    • product instances have sub-products representing a discount (either a promotion or reduction - good will gesture discount if you like) 
    • the discount sub-product can only be applied to an existing active product
    • until the parent product gets activated (inserted into billing system) we need to store the promotion details in the pending state so they can be applied when the product activates
    • there needs to be a way to see a combined view of active and pending discounts  


    ------------------------------
    Sebastian Marek
    BT Group plc
    ------------------------------


  • 2.  RE: Promotions API - access to early adoption space

    TM Forum Member
    Posted Oct 17, 2021 05:12
    Hi Sebastian

    The old (release 17.0) materials for Promotion API are available on this page: https://projects.tmforum.org/wiki/display/API/Open+API+Table+-+Historic
    The new materials are mostly not ready, although a Swagger has been published at the early access page: https://projects.tmforum.org/wiki/pages/viewpage.action?pageId=128855518

    I suggest you take a look at the materials and see if your questions are answered. If not, feel free to come back and hopefully someone will try to help you.

    ------------------------------
    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: Promotions API - access to early adoption space

    TM Forum Member
    Posted Oct 18, 2021 03:07
    Stop-press - additional assets for Promotion API were just released for member comment (pre-production), they are still not listed in early access page, but links are here:
    https://www.tmforum.org/resources/specification/tmf671-promotion-api-user-guide-v4-1-0/
    https://www.tmforum.org/resources/specification/tmf671b-promotion-api-conformance-profile-v4-1-0/
    Hope these materials will assist you

    ------------------------------
    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.
    ------------------------------



  • 4.  RE: Promotions API - access to early adoption space

    TM Forum Member
    Posted Oct 19, 2021 04:54
    Hi Jonathan,

    Thank you for your reply.

    I realised I am probably not after promotion API, as this seems to be focused more on the promotion management side. What I am actually after is the execution that follows, so the process to get the promotion/discount applied to customer account. These is the situation I am being faced with:
    • product instances have sub-products representing a discount with a negative value (either a promotion or reduction - good will gesture discount if you like) 
    • the discount sub-product can only be applied to an existing active product
    • until the parent product gets activated (inserted into billing system) we need to store the promotion details in the pending state so they can be applied when the product activates
    • there needs to be a way to see a combined view of active and pending discounts 
    I went through a few of existing Open APIs, but so far I could not find anything.

    Regards

    ------------------------------
    Sebastian Marek
    BT Group plc
    ------------------------------



  • 5.  RE: Promotions API - access to early adoption space

    TM Forum Member
    Posted Oct 27, 2021 07:43
    Hi Sebastian
    The Product Inventory API (TMF637) is what gives you a complete picture of what the customer has. It gives you the Products and Product Prices.
    Note that TMF Open APIs are non-opinionated - they don't include business rules. It's up to you to decide, based on examination of the inventory, how to deal e.g. with possible violations of promotion conditions and to generate relevant orders to revoke promotion.
    Hope it helps

    ------------------------------
    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.
    ------------------------------