TMF622 v5 Use Cases

I want to<br> <div style="width:230px"></div>	Request Type<br> <div style="width:150px"></div>	Example URL<br> <div style="width:190px"></div>
Retrieve and display details of a particular product order.<br>	GET by ID	{{orgendpoint}}/services/data/{{version}}/connect/comms/productOrderingManagement/v5/productOrder/{orderNumber}<br><br>NOTE: <br>For invalid case ID, you will receive HTTP 404 error.<br>
List all the product orders present in the system.<br>	GET List<br>	{{orgendpoint}}/services/data/{{version}}/connect/comms/productOrderingManagement/v5/productOrder
List all the product orders present in the system based on the provided field values. <br>	GET List with Fields<br>	{{orgendpoint}}/services/data/{{version}}/connect/comms/productOrderingManagement/v5/productOrder?fields=id,state,relatedParty<br><br>NOTE: <br>The requested fields will be part of output, if they have value.<br>
List all the product orders present in the system based on the filter applied.<br>	GET List with Filters<br>	{{orgendpoint}}/services/data/{{version}}/connect/comms/productOrderingManagement/v5/productOrder?state=Draft<br><br>NOTE: <br>The requested fields will be part of output, if they have value.<br>
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<br>	{{orgendpoint}}/services/data/{{version}}/connect/comms/productOrderingManagement/v5/productOrder?offset=1&pageLimit=1&pageinfo=true<br>
Create a new product order by providing the required details.<br>	POST<br>	{{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.<br>

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