Open APIs

 View Only

  • 1.  Usage of characteristics and relationship within Order API TM622

    TM Forum Member
    Posted Oct 30, 2024 05:35
    Edited by Ilyas Premji Nov 05, 2024 05:29

    Hi,

    As part of retrieving the order details(TMF622) there are 2 below use cases for which we need guidance

    1. we need to pass on additional characteristics on the promotion/discount characteristic as part of order retrieval. Can we add characteristic as subresource for priceAlteration priceAlterationCharacteristic  
    2. We need fulfilment status to be sent back at order as well as order item level in certain cases. We think ResourceRelationship can be used by adding resourceRelationShip, resourceRelationshipCharacteristic sub-resource in productOrder and productOrderItem. Can this be done.

    Any guidelines when to use and when not to use characteristic and resourceRelationship entity 

    Can you please help here



    ------------------------------
    Regards,
    Sukhada Karandikar
    Telstra Corporation
    ------------------------------



  • 2.  RE: Usage of characteristics and relationship within Order API TM622

    TM Forum Member
    Posted Nov 05, 2024 21:55

    Hi Sukhada

    For (1), please can you provide an example of the fields/characteristics that you propose to add to the priceAlteration?

    For (2), there is already an order relationship within the TMF622 Product Ordering API.  This allows you to create a relationship to the respective Service and Resource Orders as required.  See the diagram from SID and the API relationship below...



    ------------------------------
    Dan d'Albuquerque
    Individual
    ------------------------------

    Original Message


  • 3.  RE: Usage of characteristics and relationship within Order API TM622

    TM Forum Member
    Posted Nov 05, 2024 22:56

    Hi Dan,

    Thanks for the reply. Please help with the below

    For (1), please can you provide an example of the fields/characteristics that you propose to add to the priceAlteration?

      example characteristics:

    "name": "promoCode",
                      "value": "PR-SUB$OFF-BTL05FOR12",
                      "valueType": "String"
                    },
                    {
                      "name": "manualAdjustmentTypeCode",
                      "value": "StaffDiscount",
                      "valueType": "String"

                      }

    For (2), there is already an order relationship within the TMF622 Product Ordering API.  This allows you to create a relationship to the respective Service and Resource Orders as required.  See the diagram from SID and the API relationship below...

          This orderitem relationship is being used, however where can i specific what's the status of fulfilment for the service or resource item. also order relationship is available from v5. I want to pass this information in the Get OrderAPI response. 

    Regards,

    Sukhada



    ------------------------------
    Sukhada Karandikar
    Telstra Corporation
    ------------------------------

    Original Message


  • 4.  RE: Usage of characteristics and relationship within Order API TM622

    TM Forum Member
    Posted Nov 05, 2024 23:46

    Hi Sukhada

     

    There is already a JIRA to add the isPromotion and promotionCode concrete fields to the ProductOffering entity.  As you are proposing to have a single offering with multiple promotionCodes/POPs, it makes sense to also add the promotionCode to the PriceAlteration entity as well.  I will update the JIRA accordingly.

     

    For the staff discount, have you considered using the polymorphism pattern rather than the "manualAdjustmentTypeCode" that you are proposing?  SID already proposes various types of price alteration.

     

     

    For the status of the service/resource inventory instances, I am presuming you want to get all the fulfilment status back in the order API, rather than querying the inventories?  This requirement has popped up on the community before, so I will open a JIRA so that the architecture team can discuss the best way forward.

     




    Original Message