Product Specification Use Cases

I want to
Request Type
Example URL
Retrieve and display details of a requested product specification.GET by ID{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productSpecification/{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 specification ID.GET by ID and Fields{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productSpecification/{ID}?fields=name,description,isBundle
List all the product specifications present in the system.GET List{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productSpecification
List all the product specifications present in the system
based on the provided field values.		GET List with Fields{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productSpecification?fields=name,description,isBundle
List all the product specifications 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/productSpecification?fields=name,description,isBundle&isBundle=false
Limit the number of product specification 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/productSpecification?limit=2&offset=2
Create a product specification.POST{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productSpecification
Update a product specification.PATCH{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productSpecification/{ID}
Delete a product specification.DELETE{https://yourInstance.salesforce.com}/services/apexrest/{namespace}/tmforum/productopenapi/v1/productSpecification/{ID}

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

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

Consider you want to retrieve details of the product specification ID = f58d3bce-e229-74c5-6a4c-40aa68714c53 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/productSpecification/f58d3bce-e229-74c5-6a4c-40aa68714c53?fields=name,description,isBundle

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

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

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

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

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

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

Consider you want to retrieve perform the following.

  • Limit the number of product specifications 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/productSpecification?offset=1&limit=2

Consider you want to create a new product specification.

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

Consider for the product offer ID = f58d3bce-e229-74c5-6a4c-40aa68714c53 you want to update first level attributes and sub-resources.

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/productSpecification/3830