Product Offering Use Cases

I want to
property
Request Type
property
Example URL
property
Retrieve and display details of a requested product offering.GET by ID{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOffering/{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://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOffering/{ID}?fields=name,description,isBundle
List all the product offerings present in the system.GET List{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOffering
List all the product offerings present in the system
based on the provided field values.
GET List with Fields{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOffering?fields=name,description,isBundle
List all the product offerings present in the inventory based on the provided field values and filter applied.GET List by Fields and Filtering{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOffering?lifecycleStatus=Active&fields=lifecycleStatus,name,description
Limit the number of product offering to a maximum of specified limit and
display results from the page specified by an offset.
GET List by limit and offset{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOffering?offset=1&limit=2
Create a product offering.POST{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOffering
Update a product offering.PATCH{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOffering/{ID}
Delete a product offering.DELETE{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOffering/{ID}

Consider you want to retrieve details of a product offering from the inventory. For example, product offering ID = 0b1a75ff-f9ee-2547-2c57-e2f27b860356.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOffering/0b1a75ff-f9ee-2547-2c57-e2f27b860356

Consider you want to retrieve details of the product offer ID = 0b1a75ff-f9ee-2547-2c57-e2f27b860356 and get the name, description and isBundle details in the output.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOffering/0b1a75ff-f9ee-2547-2c57-e2f27b860356?fields=name,description,isBundle

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

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

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

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

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

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

Consider you want to retrieve perform the following.

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

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

Consider you want to create a new product offering.

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

Consider for the product offer ID = 1f00a691-650f-ce61-d3f3-53b6f988cb9c you want to update first level attributes and sub-resources.

https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/apexrest/{namespace}/tmforum/productopenapi/v1/productOffering/1f00a691-650f-ce61-d3f3-53b6f988cb9c

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

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