---
schema_version: "1"
id: 565112b9e213e2435084c6c6675423853be975358666d7d1ab3dec826d0ccce3
title: TMF622 v5 Use Cases
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/industries-integrations/comms/guides/TMF622/TMF622v5-use-cases.md
canonical_url: https://developer.salesforce.com/docs/industries/communications/guide/TMF622v5-use-cases.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: e10445cfd9e441ddeb38072408b0c4a322e03bfafe25256bff2d5791cec314e5
products:
- Communications Cloud TM Forum API
- Industries Integrations
---
# TMF622 v5 Use Cases
| I want to
| Request Type
| Example URL
|
| ----------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Retrieve and display details of a particular product order.
| [GET by ID](#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](#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](#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](#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](#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](#post)
| _{{orgendpoint}}/services/data/{{version}}/connect/comms/productOrderingManagement/v5/productOrder_ |
## GET by ID
Consider you want to retrieve details of a particular product order.
### Sample URL
`https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/productOrderingManagement/v5/productOrder/00000100`
### Sample Response
```
{
"id": "00000100",
"href": "/connect/comms/customermanagement/${version}/customer/00000100",
"state": "Draft",
"productOrderItem": [
{
"id": "100",
"quantity": 1,
"action": "add",
"productOffering": {
"id": "14277",
"name": "TMF25",
"@type": "ProductOfferingRef"
},
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"role": "Seller",
"partyOrPartyRole": {
"name": "Sample Account",
"@type": "PartyRef"
},
"@type": "RelatedPartyRefOrPartyRoleRef"
}
],
"externalId": [
{
"@type": "ExternalIdentifier",
"owner": "TMF",
"externalIdentifierType": "POnumber",
"id": "456"
}
],
"@type": "ProductOrder"
}
```
## GET List
Consider there are multiple product orders in the system and you want to list all of them.
### Sample URL
`https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/productOrderingManagement/v5/productOrder`
### Sample Response
```
[
{
"id": "00000100",
"href": "/connect/comms/customermanagement/${version}/customer/00000100",
"state": "Draft",
"productOrderItem": [
{
"id": "100",
"quantity": 1,
"action": "add",
"productOffering": {
"id": "14277",
"name": "TMF25",
"@type": "ProductOfferingRef"
},
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"role": "Seller",
"partyOrPartyRole": {
"name": "Sample Account",
"@type": "PartyRef"
},
"@type": "RelatedPartyRefOrPartyRoleRef"
}
],
"externalId": [
{
"@type": "ExternalIdentifier",
"owner": "TMF",
"externalIdentifierType": "POnumber",
"id": "456"
}
],
"@type": "ProductOrder"
}
]
```
## GET List with Fields
Consider you want to retrieve all the active product orders present in the system for selected field values.
### Sample URL
`https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/productOrderingManagement/v5/productOrder?fields=id,state,relatedParty`
### Sample Response
```
[
{
"id": "00000100",
"state": "Draft",
"relatedParty": [
{
"role": "Seller",
"partyOrPartyRole": {
"name": "Sample Account",
"@type": "PartyRef"
},
"@type": "RelatedPartyRefOrPartyRoleRef"
}
]
}
]
```
## GET List with Filters
Consider you want to list all the product orders present in the system based on the filter applied.
#### Sample URL
`https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/productOrderingManagement/v5/productOrder?state=Draft`
#### Sample Response
```
{
"id": "00000100",
"href": "/connect/comms/customermanagement/${version}/customer/00000100",
"state": "Draft",
"productOrderItem": [
{
"id": "100",
"quantity": 1,
"action": "add",
"productOffering": {
"id": "14277",
"name": "TMF25",
"@type": "ProductOfferingRef"
},
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"role": "Seller",
"partyOrPartyRole": {
"name": "Sample Account",
"@type": "PartyRef"
},
"@type": "RelatedPartyRefOrPartyRoleRef"
}
],
"externalId": [
{
"@type": "ExternalIdentifier",
"owner": "TMF",
"externalIdentifierType": "POnumber",
"id": "456"
}
],
"@type": "ProductOrder"
}
```
## GET with Pagination
Consider you want to retrieve list of product orders and apply required pagination query.
### Sample URL
`https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/productOrderingManagement/v5/productOrder?offset=1&pageLimit=1&pageinfo=true`
### Sample Response
```
{
"currentPage": 2,
"totalPageSize": 10,
"recordList": [
{
"id": "00000100",
"href": "/connect/comms/customermanagement/${version}/customer/00000100",
"state": "Draft",
"productOrderItem": [
{
"id": "100",
"quantity": 1,
"action": "add",
"productOffering": {
"id": "14277",
"name": "TMF25",
"@type": "ProductOfferingRef"
},
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"role": "Seller",
"partyOrPartyRole": {
"name": "Sample Account",
"@type": "PartyRef"
},
"@type": "RelatedPartyRefOrPartyRoleRef"
}
],
"externalId": [
{
"@type": "ExternalIdentifier",
"owner": "TMF",
"externalIdentifierType": "POnumber",
"id": "456"
}
],
"@type": "ProductOrder"
}
]
}
```
## POST
Consider you want to create a new product order.
### Sample URL
`https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/productOrderingManagement/v5/productOrder`
### Sample Request
```
{
"description": "Product Order illustration sample",
"priceBookName": "Standard",
"state":"Submitted",
"externalId": [
{
"externalIdentifierType": "POnumber",
"id": "456"
}
],
"requestedCompletionDate": "2019-05-02T08:13:59.506Z",
"requestedStartDate": "2019-05-03T08:13:59.506Z",
"productOrderItem": [
{
"id": "100",
"quantity": 1,
"action": "add",
"productOffering": {
"id": "SL9060",
"name": "SLA: Gold"
},
"product": {
"productCharacteristic": [
{
"name": "GOLD_ATTRIBUTE",
"id": "GOLD_ATTRIBUTE",
"value": "415 279 7439",
"valueType": "string"
}
]
}
}
],
"relatedParty": [
{
"role": "Customer",
"partyOrPartyRole": {
"id": "CC978213",
"name": "GenePoint"
}
}
]
}
```
### Sample Response
```
201 Created
```