TMF622 v5 Use Cases
| I want to | Request Type | Example URL |
|---|---|---|
| Retrieve and display details of a particular product order. | GET by ID | {{orgendpoint}}/services/data/{{version}}/connect/comms/productOrderingManagement/v5/productOrder/{orderNumber} NOTE: For invalid case ID, you will receive HTTP 404 error. |
| List all the product orders present in the system. | GET List | {{orgendpoint}}/services/data/{{version}}/connect/comms/productOrderingManagement/v5/productOrder |
| List all the product orders present in the system based on the provided field values. | GET List with Fields | {{orgendpoint}}/services/data/{{version}}/connect/comms/productOrderingManagement/v5/productOrder?fields=id,state,relatedParty NOTE: The requested fields will be part of output, if they have value. |
| List all the product orders present in the system based on the filter applied. | GET List with Filters | {{orgendpoint}}/services/data/{{version}}/connect/comms/productOrderingManagement/v5/productOrder?state=Draft NOTE: The requested fields will be part of output, if they have value. |
| List product orders, limit the number of product orders to a maximum of specified limit, and display results from the page specified by offset. | GET with Pagination | {{orgendpoint}}/services/data/{{version}}/connect/comms/productOrderingManagement/v5/productOrder?offset=1&pageLimit=1&pageinfo=true |
| Create a new product order by providing the required details. | POST | {{orgendpoint}}/services/data/{{version}}/connect/comms/productOrderingManagement/v5/productOrder |
Consider you want to retrieve details of a particular product order.
https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/productOrderingManagement/v5/productOrder/00000100
Consider there are multiple product orders in the system and you want to list all of them.
https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/productOrderingManagement/v5/productOrder
Consider you want to retrieve all the active product orders present in the system for selected field values.
https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/productOrderingManagement/v5/productOrder?fields=id,state,relatedParty
Consider you want to list all the product orders present in the system based on the filter applied.
https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/productOrderingManagement/v5/productOrder?state=Draft
Consider you want to retrieve list of product orders and apply required pagination query.
https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/productOrderingManagement/v5/productOrder?offset=1&pageLimit=1&pageinfo=true
Consider you want to create a new product order.
https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/productOrderingManagement/v5/productOrder