Open APIs

 View Only
  • 1.  Cancel a Pending Product Order

    Posted Jun 15, 2023 10:33

    Hi,

    There is an use case to cancel a pending product order (a device is pending to ship, or order still in processing state).  My understanding is we should use POST /productOrder to create a Product Order on this cancel action.

    Is there any suggestion on the cancel order payload?  

    My first stab is below, is it a correct approach?

    {

                    "requestedStartDate": "2023-06-15T13:27:03.074Z",

                    "billingAccount": {

                                    "id": "string",

                    },

                    "productOrderItem": [

                                    {

                                                    "quantity": 1,

                                                    "action": "cancel",                                          

                                                    "productOrderItemRelationship": [

                                                                    {

                                                                                    "id": "<order id to be chancel>",

                                                                                    "relationshipType": "targets",

                                                                    }

                                                    ]                                             

                                    }

                    ]

                   

    }



    ------------------------------
    Keven Chan
    Rogers Communications Inc.
    ------------------------------


  • 2.  RE: Cancel a Pending Product Order

    Posted Jun 15, 2023 10:51

    Hello Keven

    I am assuming this is a question about TMF 622 version 4.

    My understanding of cancellation is that the task pattern is used for this and that there is a specific cancel product order resource for this purpose.

    So you create a cancel product resource asking that a cancellation of an order be considered and if possible put into action.

    The request looks like this.



    ------------------------------
    Derrick Evans
    BT Group plc
    ------------------------------



  • 3.  RE: Cancel a Pending Product Order

    Posted Jun 15, 2023 11:03

    Thanks for the pointer, i wasn't aware of this API.  It makes very much sense now!



    ------------------------------
    Keven Chan
    Rogers Communications Inc.
    ------------------------------