The input for historical product quantities. Includes the customer account ID, order specification, and optional filters.
JSON example
{
"customerAccountId": "001RM000004Wk8xYAC",
"orderSpecId": "0OSRM00000004Cx2AAE",
"operationType": "avg",
"orderStatuses": ["Activated"],
"orderItemSpecIds": ["0OSRM00000004Cx2AAE"],
"includeProductDetails": true
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
customerAccountId |
String | The ID of the customer account. | Required | 68.0 |
includeProductDetails |
Boolean | If true, retrieves full product details from Configure, Price, Quote (CPQ) Product Discovery and includes them in the productDetails field. The default value is false. | Optional | 68.0 |
operationType |
String | The aggregation operation used to calculate product quantities across multiple orders. Determines how quantity is calculated when a product appears in multiple orders. Valid values are sum, avg, min, and max. The default value is avg. | Optional | 68.0 |
orderItemSpecIds |
String[] | An optional list of order item specification IDs to filter order items by. Only items that match these specifications are included in recommendations. | Optional | 68.0 |
orderSpecId |
String | The ID of the order specification that defines the lookback period and order template. | Required | 68.0 |
orderStatuses |
String[] | An optional list of order statuses to filter by, such as Draft or Activated. If no status is specified, all statuses are included. | Optional | 68.0 |