Product Offering Price Use Cases

I want to <br> <div style="width:120px"></div>	Request Type <br> <div style="width:290px"></div>	Example URL <br> <div style="width:290px"></div>
Retrieve and display details of a requested product offering price.	GET by ID	{https<nolink>://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice/{ID}<br><br>NOTE:<br>For invalid category ID, you will receive HTTP 404 error.
Based on the provided field values, retrieve and display details of a particular product offering ID.	GET by ID and Fields	{https<nolink>://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice/{ID}?fields=id,name,lifecycleStatus
List all the product offering prices present in the system.	GET List	{https<nolink>://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice
List all the product offering prices present in the system<br>based on the provided field values.	GET List with Fields	{https<nolink>://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice?fields=id,name,lifecycleStatus<br>
List all the product offering prices present in the inventory based on the provided field values and filter applied.	GET List by Fields and Filtering	{https<nolink>://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice?lifecycleStatus=false&fields=id,lifecycleStatus
Limit the number of product offering prices to a maximum of specified limit and<br>display results from the page specified by an offset.	GET List by limit and offset	{https<nolink>://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice?offset=1&limit=2<br>
Create a product offering price.	POST	{https<nolink>://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice<br>
Update a product offering price.	PATCH	{https<nolink>://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice/{ID}<br>
Delete a product offering price.	DELETE	{https<nolink>://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice/{ID}<br>

GET by ID

Consider you want to retrieve details of a product offering price from the inventory. For example, product offering price ID = ab5f8d7a-b852-cce1-fe27-9b2ea7742f6c.

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice/ab5f8d7a-b852-cce1-fe27-9b2ea7742f6c

Sample Response

200 OK
{
"PageInfo": "Page 1 of 1",
"PageSize": 50,
"Result": {
"priceType": "One-time",
"price": {
"value": 10,
"unit": "USD"
},
"id": "ab5f8d7a-b852-cce1-fe27-9b2ea7742f6c",
"description": "Sample description",
"name": "sample name",
"href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCB6EAM",
"lastUpdate": "2023-08-31T19:17:36.000+0000",
"validFor": {
"startDateTime": "2023-07-31T18:30:00.000+0000"
},
"lifecycleStatus": "true"
}
}

GET by ID and Fields

Consider for the product offering price ID = 6c059da5-6be5-6a8b-08f9-422beec29e55, you want to retrieve details of the id, name and lifecycleStatus details in the output.

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice/6c059da5-6be5-6a8b-08f9-422beec29e55?fields=id,name,lifecycleStatus

Sample Response

200 OK
{
"PageInfo": "Page 1 of 1",
"PageSize": 50,
"Result": {
"href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004qzdMAA",
"id": "6c059da5-6be5-6a8b-08f9-422beec29e55",
"name": "a3GDo0000004qzd",
"lifecycleStatus": "false"
}
}

GET List

Consider you want to retrieve details of all the product offering prices in the inventory.

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice

Sample Response

200 OK
{
  "PageInfo": "Page 1 of 8",
  "PageSize": 5,
  "Result": [
    {
      "priceType": "One-time",
      "price": {
        "value": 10.00000,
        "unit": "USD"
      },
      "id": "ab5f8d7a-b852-cce1-fe27-9b2ea7742f6c",
      "description": "sample description",
      "name": "sample name",
      "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCB6EAM",
      "lastUpdate": "2023-08-31T19:17:36.000+0000",
      "validFor": {
        "startDateTime": "2023-07-31T18:30:00.000+0000"
      },
      "lifecycleStatus": "true"
    },
    {
      "priceType": "One-time",
      "price": {
        "value": 100.00000,
        "unit": "EUR"
      },
      "id": "680c0059-8a2b-77a2-b96e-afb57b5951bf",
      "description": "sample description",
      "name": "sample name",
      "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCBBEA2",
      "lastUpdate": "2023-08-31T19:21:34.000+0000",
      "validFor": {
        "startDateTime": "2022-08-31T18:30:00.000+0000"
      },
      "lifecycleStatus": "true"
    },
    {
      "priceType": "One-time",
      "price": {
        "value": 1.00000,
        "unit": "EUR"
      },
      "id": "72027007-33af-4272-342e-453de754bb6e",
      "description": "sample description",
      "name": "sample name",
      "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCBGEA2",
      "lastUpdate": "2023-08-31T19:23:33.000+0000",
      "validFor": {
        "startDateTime": "2019-09-03T18:30:00.000+0000"
      },
      "lifecycleStatus": "true"
    }
  ]
}

GET List with Fields

Consider you want to retrieve all the product offering prices by applying the requested fields.

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice?fields=id,name,lifecycleStatus

Sample Response

200 OK

{
"PageInfo": "Page 1 of 2",
"PageSize": 50,
"Result": [
{
"href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004qzdMAA",
"id": "6c059da5-6be5-6a8b-08f9-422beec29e55",
"name": "sample name",
"lifecycleStatus": "false"
},
{
"href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004rKrMAI",
"id": "5054f7ab-fd0e-16ea-f36f-39de1c5e7be6",
"name": "sample name",
"lifecycleStatus": "false"
}
]
}

GET List by Fields and Filtering

Consider you want to retrieve all the product offering prices by a specified filter.

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice?lifecycleStatus=false&fields=id,lifecycleStatus

Sample Response

200 OK
{
"PageInfo": "Page 1 of 2",
"PageSize": 50,
"Result": [
{
"href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004qzdMAA",
"id": "6c059da5-6be5-6a8b-08f9-422beec29e55",
"lifecycleStatus": "false"
},
{
"href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004rKrMAI",
"id": "5054f7ab-fd0e-16ea-f36f-39de1c5e7be6",
"lifecycleStatus": "false"
}
]
}

GET List by limit and offset

Consider you want to retrieve perform the following.

Limit the number of product offering prices to a maximum of specified limit
Display results from the page specified by an offset

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice?offset=1&limit=2

Sample Response

200 OK

{
"PageInfo": "Page 1 of 46",
"PageSize": 2,
"Result": [
{
"priceType": "One-time",
"price": {
"value": 0
},
"href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004qzdMAA",
"id": "6c059da5-6be5-6a8b-08f9-422beec29e55",
"lastUpdate": "2023-07-26T05:53:58.000+0000",
"name": "sample name",
"lifecycleStatus": "true"
},
{
"priceType": "One-time",
"price": {
"value": 0
},
"href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004rKrMAI",
"id": "5054f7ab-fd0e-16ea-f36f-39de1c5e7be6",
"lastUpdate": "2023-07-26T05:53:58.000+0000",
"name": "sample name",
"lifecycleStatus": "true"
}
]
}

POST

Consider you want to create a new product offering price.

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/productOfferingPrice

Sample Request

{
"name" : "demo pricing",
"description": "This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.",
"validFor": {
"startDateTime": "2020-09-22T00:00:00Z",
"endDateTime": "2023-09-22T00:00:00Z"
},
"lifecycleStatus": "Active",
"priceType": "Recurring",
"recurringChargePeriodType": "Monthly",
"price": {
"unit": "USD",
"value": 50
},
"productOfferingTerm": [
{
"name": "12 Month",
"description": "12 month contract",
"duration": {
"amount": 12,
"units": "Month"
},
"validFor": {
"startDateTime": "2020-09-22T16:42:23.0Z",
"endDateTime": "2023-09-22T00:00:00.0Z"
}
}
]
}

Sample Response

200 OK
{
  "productOfferingTerm": [
    {
      "href": "/services/data/v58.0/sobjects/vlocity_cmt__Promotion__c/a3T5e000000tvEVEAY",
      "@type": "ProductOfferingTerm",
      "validFor": {
        "startDateTime": "2020-09-22T16:42:23.000+0000",
        "endDateTime": "2023-09-22T00:00:00.000+0000"
      },
      "duration": {
        "units": "Month",
        "amount": 12
      },
      "description": "12 month contract",
      "name": "12 Month"
    }
  ],
  "lifecycleStatus": "true",
  "validFor": {
    "endDateTime": "2023-09-22T00:00:00.000+0000",
    "startDateTime": "2020-09-22T00:00:00.000+0000"
  },
  "lastUpdate": "2023-09-27T08:02:09.000+0000",
  "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCZSEA2",
  "name": "demo pricing",
  "description": "This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.",
  "id": "4a5dbea2-6c43-4a63-8b8a-cde4b5085c57",
  "price": {
    "unit": "USD",
    "value": 50
  },
  "priceType": "Recurring",
  "recurringChargePeriodType": "Monthly"
}

PATCH

Consider for the product offering price ID = 4a5dbea2-6c43-4a63-8b8a-cde4b5085c57 you want to update first level attributes and sub-resources.

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice/4a5dbea2-6c43-4a63-8b8a-cde4b5085c57

Sample Request

{
"description": "UPDATED - This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.",
"name": "demo pricing",
"validFor": {
"startDateTime": "2020-09-22T00:00:00.000+0000",
"endDateTime": "2023-09-22T00:00:00.000+0000"
},
"priceType": "recurring",
"priceType":"monthly",
"lifecycleStatus":"false",
"recurringChargePeriodType": "monthly",
"price": {
"unit": "USD",
"value": 50
}
}

Sample Response

{
  "productOfferingTerm": [
    {
      "href": "/services/data/v58.0/sobjects/vlocity_cmt__Promotion__c/a3T5e000000tvEVEAY",
      "@type": "ProductOfferingTerm",
      "validFor": {
        "startDateTime": "2020-09-22T16:42:23.000+0000",
        "endDateTime": "2023-09-22T00:00:00.000+0000"
      },
      "duration": {
        "units": "Month",
        "amount": 12
      },
      "description": "12 month contract",
      "name": "12 Month"
    }
  ],
  "lifecycleStatus": "true",
  "validFor": {
    "endDateTime": "2023-09-22T00:00:00.000+0000",
    "startDateTime": "2020-09-22T00:00:00.000+0000"
  },
  "lastUpdate": "2023-09-27T08:02:09.000+0000",
  "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCZSEA2",
  "name": "demo pricing",
  "description": "UPDATED - This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.",
  "id": "4a5dbea2-6c43-4a63-8b8a-cde4b5085c57",
  "price": {
    "unit": "USD",
    "value": 50
  },
  "priceType": "Recurring",
  "recurringChargePeriodType": "Monthly"
}

DELETE

Consider you want to delete a product offering price ID: 3830.

Sample URL

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/productOffering/3830

Sample Response

204 No content