GET api/OpportunityProducts

Get all products linked to Opportunities with an optional filter. Supported Headers: SelectField, Filter, Sort, SortDesc

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of OpportunityProduct

Name	Type	Additional information
Total	decimal number	None.
Quantity	decimal number	None.
OpportunityID	globally unique identifier	None.
ProductID	globally unique identifier	None.
OpportunityProductID	globally unique identifier	None.
CreateDate	date	None.
EditDate	date	None.
Discount	decimal number	None.
Price	decimal number	None.
ItemNumber	string	None.
Name	string	None.
Cost	decimal number	None.
DiscountPrice	decimal number	None.
CustomFields	Dictionary of string [key] and Object [value]	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Total": 1.0,
    "Quantity": 2.0,
    "OpportunityID": "a182f2cd-50af-4ecb-9123-fb0efdb3ccff",
    "ProductID": "bd633b91-6ebd-46ac-8c95-d2f3e5854201",
    "OpportunityProductID": "afb81b16-3abc-480c-ac5f-3a20ebd7f8c0",
    "CreateDate": "2024-05-04T14:37:56Z",
    "EditDate": "2024-05-04T14:37:56Z",
    "Discount": 7.0,
    "Price": 8.0,
    "ItemNumber": "sample string 9",
    "Name": "sample string 10",
    "Cost": 11.0,
    "DiscountPrice": 12.0,
    "CustomFields": {
      "sample string 1": {},
      "sample string 3": {}
    }
  },
  {
    "Total": 1.0,
    "Quantity": 2.0,
    "OpportunityID": "a182f2cd-50af-4ecb-9123-fb0efdb3ccff",
    "ProductID": "bd633b91-6ebd-46ac-8c95-d2f3e5854201",
    "OpportunityProductID": "afb81b16-3abc-480c-ac5f-3a20ebd7f8c0",
    "CreateDate": "2024-05-04T14:37:56Z",
    "EditDate": "2024-05-04T14:37:56Z",
    "Discount": 7.0,
    "Price": 8.0,
    "ItemNumber": "sample string 9",
    "Name": "sample string 10",
    "Cost": 11.0,
    "DiscountPrice": 12.0,
    "CustomFields": {
      "sample string 1": {},
      "sample string 3": {}
    }
  }
]