Open APIs

Expand all | Collapse all

Customer's Product inventory

  • 1.  Customer's Product inventory

    Posted Jul 12, 2021 04:08
    Hi All,
    What API would be used to get customer's product inventory from a CRM? I believe it would be TMF637 Product Inventory? Looking at the API Specification, there is
    List products - Which is to get all the products from the inventory and we can specify which fields we are interested .
    Retrieve product - To get the detail about a product from the inventory using Product.id as input.

    How do we get list of products that the customer has against his Billing Account for example?

    ------------------------------
    Saravana Kumar Perumal Swamy
    BT Group plc
    ------------------------------


  • 2.  RE: Customer's Product inventory

    TM Forum Member
    Posted Jul 12, 2021 04:46
    HI Saravana
    First, let me relate to your question - there is no guarantee that the product inventory will come from a CRM system. The TMF Open APIs do not make any assumptions about implementation or deployment architecture.
    You are correct, you would use TMF637.
    To understand which products are paid for by a particular billing account, you would need to use the list operation (GET without ID), and provide an appropriate filter expression to find the products whose productPrices are charged to the billing account. Something like an inclusive join between
    billingAccount.id=<billingaccountID>
    productPrice.billingAccount.id=<billingaccountID>

    Of course, you need to ensure that your implementation will support this filter.
    A json path filter might also be used, if your implementation supports that, refer to the design guidelines TMF630 for more details.

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



  • 3.  RE: Customer's Product inventory

    Posted Jul 12, 2021 07:27
    Thanks Jonathan. This is useful as always. Just another query, how do I filter with relatedParty.id where @referredType is Individual? Given relatedParty is a list it can have many objects representing organization or individual.

    ------------------------------
    Saravana Kumar
    ------------------------------



  • 4.  RE: Customer's Product inventory

    TM Forum Member
    Posted Jul 12, 2021 09:31
    Hi Saravana
    Thanks for the compliment :)
    I'm not sure I understand the problem - if you have the ID of the related party (or related party role) you would just use this in the query params, something like
    filter="relatedParty.id==<theID>"
    The fact that a product has a list of related parties does not make a difference.
    If it is important to you the role being played by the party, you could add a join such as relatedParty.role=<role> (e.g. customer).

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