Pipeliner CRM Cloud API

Retrieving Products from Opportunities

In Pipeliner CRM, you can add products/services that your organization offers for facilitating your team to select products, their quantities and pricing for prospective sales (Opportunities). In addition, your team can add specific custom information against each selected Product.

Note: For information about creating Products and adding them to Opportunities in the Pipeliner CRM user interface, see Setting up Products, Product Line Items and Pricing for use in Opportunities.

After you have created a Product and linked it to an Opportunity, you can use the Pipeliner APIs to retrieve the product details from Opportunities.

To retrieve Products from Opportunities, perform the following tasks:

  1. Fetch a list of all Opportunity and Product Relations
  2. Fetch the details of a particular Opportunity and Product Relation
  3. Fetch the details of a particular Product associated with an Opportunity

Fetching a list of all Opportunity and Product Relations

The following section of this tutorial explains how you retrieve the Products associated with an Opportunity by first fetching a list of all the Opportunity and Product Relations.

Endpoint name: OpptyProductRelations

This endpoint uses the GET method to fetch the list of all the Opportunity and Product Relations.

Request URL Syntax

Copy to Clipboard

Note: To learn more about how to obtain the Service URL and Space ID details, see the Authentication tutorial.

Example Request URL

Copy to Clipboard

Example Response Body

Copy to Clipboard

Note: In the response body, note the parameters, such as id, indicating the ID of an individual Opportunity Product Relation entity. You can use this ID to fetch the details of a particular Opportunity Product Relation entity.

Fetching the details of a particular Opportunity and Product Relation entity

Identify the Opportunity and Relation entity whose details you want to fetch. The following section of this tutorial explains how you can fetch the details of a particular Opportunity and Product Relation entity.

Request URL Syntax

Copy to Clipboard

Example Request URL

Copy to Clipboard

Example Response Body

Copy to Clipboard

In the response body, note the parameters, such as product_id, which you can use to fetch the details of a particular Product and view its association with one or more Opportunities.

Fetching the details of a particular Product

Identify the product_id using which you want to fetch the details of a particular Product. The following section of this tutorial explains how you can fetch the details of a particular Product.

Endpoint name: Products.get

This endpoint uses the GET method to fetch the details of a particular Product.

Request URL Syntax

Copy to Clipboard

Example Request URL

Copy to Clipboard

Example Response Body

Copy to Clipboard

In the response body, note that the value of the parameter, oppty_product_relation_type_id, matches with the value of the oppty_product_relation_type_id parameter in the response body for a particular Opportunity Product Relation entity. This indicates the association of a Product with an Opportunity.