Product Offering Price Use Cases

I want to	Request Type	Example URL
Retrieve and display details of a requested product offering price.	GET by ID	{https://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice/{ID} NOTE: 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://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://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice
List all the product offering prices present in the system based on the provided field values.	GET List with Fields	{https://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice?fields=id,name,lifecycleStatus
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://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 display results from the page specified by an offset.	GET List by limit and offset	{https://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice?offset=1&limit=2
Create a product offering price.	POST	{https://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice
Update a product offering price.	PATCH	{https://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice/{ID}
Delete a product offering price.	DELETE	{https://MyDomainLoginUrl}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOfferingPrice/{ID}

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

1200 OK
2{
3"PageInfo": "Page 1 of 1",
4"PageSize": 50,
5"Result": {
6"priceType": "One-time",
7"price": {
8"value": 10,
9"unit": "USD"
10},
11"id": "ab5f8d7a-b852-cce1-fe27-9b2ea7742f6c",
12"description": "Sample description",
13"name": "sample name",
14"href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCB6EAM",
15"lastUpdate": "2023-08-31T19:17:36.000+0000",
16"validFor": {
17"startDateTime": "2023-07-31T18:30:00.000+0000"
18},
19"lifecycleStatus": "true"
20}
21}

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

1200 OK
2{
3"PageInfo": "Page 1 of 1",
4"PageSize": 50,
5"Result": {
6"href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004qzdMAA",
7"id": "6c059da5-6be5-6a8b-08f9-422beec29e55",
8"name": "a3GDo0000004qzd",
9"lifecycleStatus": "false"
10}
11}

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

1200 OK
2{
3  "PageInfo": "Page 1 of 8",
4  "PageSize": 5,
5  "Result": [
6    {
7      "priceType": "One-time",
8      "price": {
9        "value": 10.00000,
10        "unit": "USD"
11      },
12      "id": "ab5f8d7a-b852-cce1-fe27-9b2ea7742f6c",
13      "description": "sample description",
14      "name": "sample name",
15      "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCB6EAM",
16      "lastUpdate": "2023-08-31T19:17:36.000+0000",
17      "validFor": {
18        "startDateTime": "2023-07-31T18:30:00.000+0000"
19      },
20      "lifecycleStatus": "true"
21    },
22    {
23      "priceType": "One-time",
24      "price": {
25        "value": 100.00000,
26        "unit": "EUR"
27      },
28      "id": "680c0059-8a2b-77a2-b96e-afb57b5951bf",
29      "description": "sample description",
30      "name": "sample name",
31      "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCBBEA2",
32      "lastUpdate": "2023-08-31T19:21:34.000+0000",
33      "validFor": {
34        "startDateTime": "2022-08-31T18:30:00.000+0000"
35      },
36      "lifecycleStatus": "true"
37    },
38    {
39      "priceType": "One-time",
40      "price": {
41        "value": 1.00000,
42        "unit": "EUR"
43      },
44      "id": "72027007-33af-4272-342e-453de754bb6e",
45      "description": "sample description",
46      "name": "sample name",
47      "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCBGEA2",
48      "lastUpdate": "2023-08-31T19:23:33.000+0000",
49      "validFor": {
50        "startDateTime": "2019-09-03T18:30:00.000+0000"
51      },
52      "lifecycleStatus": "true"
53    }
54  ]
55}

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

1200 OK
2
3{
4"PageInfo": "Page 1 of 2",
5"PageSize": 50,
6"Result": [
7{
8"href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004qzdMAA",
9"id": "6c059da5-6be5-6a8b-08f9-422beec29e55",
10"name": "sample name",
11"lifecycleStatus": "false"
12},
13{
14"href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004rKrMAI",
15"id": "5054f7ab-fd0e-16ea-f36f-39de1c5e7be6",
16"name": "sample name",
17"lifecycleStatus": "false"
18}
19]
20}

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

1200 OK
2{
3"PageInfo": "Page 1 of 2",
4"PageSize": 50,
5"Result": [
6{
7"href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004qzdMAA",
8"id": "6c059da5-6be5-6a8b-08f9-422beec29e55",
9"lifecycleStatus": "false"
10},
11{
12"href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004rKrMAI",
13"id": "5054f7ab-fd0e-16ea-f36f-39de1c5e7be6",
14"lifecycleStatus": "false"
15}
16]
17}

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

1200 OK
2
3{
4"PageInfo": "Page 1 of 46",
5"PageSize": 2,
6"Result": [
7{
8"priceType": "One-time",
9"price": {
10"value": 0
11},
12"href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004qzdMAA",
13"id": "6c059da5-6be5-6a8b-08f9-422beec29e55",
14"lastUpdate": "2023-07-26T05:53:58.000+0000",
15"name": "sample name",
16"lifecycleStatus": "true"
17},
18{
19"priceType": "One-time",
20"price": {
21"value": 0
22},
23"href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3GDo0000004rKrMAI",
24"id": "5054f7ab-fd0e-16ea-f36f-39de1c5e7be6",
25"lastUpdate": "2023-07-26T05:53:58.000+0000",
26"name": "sample name",
27"lifecycleStatus": "true"
28}
29]
30}

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

1{
2"name" : "demo pricing",
3"description": "This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.",
4"validFor": {
5"startDateTime": "2020-09-22T00:00:00Z",
6"endDateTime": "2023-09-22T00:00:00Z"
7},
8"lifecycleStatus": "Active",
9"priceType": "Recurring",
10"recurringChargePeriodType": "Monthly",
11"price": {
12"unit": "USD",
13"value": 50
14},
15"productOfferingTerm": [
16{
17"name": "12 Month",
18"description": "12 month contract",
19"duration": {
20"amount": 12,
21"units": "Month"
22},
23"validFor": {
24"startDateTime": "2020-09-22T16:42:23.0Z",
25"endDateTime": "2023-09-22T00:00:00.0Z"
26}
27}
28]
29}

Sample Response

1200 OK
2{
3  "productOfferingTerm": [
4    {
5      "href": "/services/data/v58.0/sobjects/vlocity_cmt__Promotion__c/a3T5e000000tvEVEAY",
6      "@type": "ProductOfferingTerm",
7      "validFor": {
8        "startDateTime": "2020-09-22T16:42:23.000+0000",
9        "endDateTime": "2023-09-22T00:00:00.000+0000"
10      },
11      "duration": {
12        "units": "Month",
13        "amount": 12
14      },
15      "description": "12 month contract",
16      "name": "12 Month"
17    }
18  ],
19  "lifecycleStatus": "true",
20  "validFor": {
21    "endDateTime": "2023-09-22T00:00:00.000+0000",
22    "startDateTime": "2020-09-22T00:00:00.000+0000"
23  },
24  "lastUpdate": "2023-09-27T08:02:09.000+0000",
25  "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCZSEA2",
26  "name": "demo pricing",
27  "description": "This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.",
28  "id": "4a5dbea2-6c43-4a63-8b8a-cde4b5085c57",
29  "price": {
30    "unit": "USD",
31    "value": 50
32  },
33  "priceType": "Recurring",
34  "recurringChargePeriodType": "Monthly"
35}

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

1{
2"description": "UPDATED - This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.",
3"name": "demo pricing",
4"validFor": {
5"startDateTime": "2020-09-22T00:00:00.000+0000",
6"endDateTime": "2023-09-22T00:00:00.000+0000"
7},
8"priceType": "recurring",
9"priceType":"monthly",
10"lifecycleStatus":"false",
11"recurringChargePeriodType": "monthly",
12"price": {
13"unit": "USD",
14"value": 50
15}
16}

Sample Response

1{
2  "productOfferingTerm": [
3    {
4      "href": "/services/data/v58.0/sobjects/vlocity_cmt__Promotion__c/a3T5e000000tvEVEAY",
5      "@type": "ProductOfferingTerm",
6      "validFor": {
7        "startDateTime": "2020-09-22T16:42:23.000+0000",
8        "endDateTime": "2023-09-22T00:00:00.000+0000"
9      },
10      "duration": {
11        "units": "Month",
12        "amount": 12
13      },
14      "description": "12 month contract",
15      "name": "12 Month"
16    }
17  ],
18  "lifecycleStatus": "true",
19  "validFor": {
20    "endDateTime": "2023-09-22T00:00:00.000+0000",
21    "startDateTime": "2020-09-22T00:00:00.000+0000"
22  },
23  "lastUpdate": "2023-09-27T08:02:09.000+0000",
24  "href": "/services/apexrest/vlocity_cmt/tmforum/productopenapi/v1/priceListEntry/a3C5e000000jCZSEA2",
25  "name": "demo pricing",
26  "description": "UPDATED - This pricing describes the recurring charge for a firewall service that can be deployed in business customer premise.",
27  "id": "4a5dbea2-6c43-4a63-8b8a-cde4b5085c57",
28  "price": {
29    "unit": "USD",
30    "value": 50
31  },
32  "priceType": "Recurring",
33  "recurringChargePeriodType": "Monthly"
34}

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

1204 No content