Sales Agreement Product Management Input

Input representation of products and their attributes to create or update in a sales agreement.

JSON Example 

Here’s an example of a request to add a product to a sales agreement:

1{
2  "pricebook2Id": "01sAAC00002tGfhYBE",
3  "salesAgreementProductDetails": [
4    {
5      "product2Id": "01tAAC0000ADt2cYBD",
6      "pricebookEntryId": "01uAAC00000nRggYBE",
7      "initialPlannedQuantity": 10,
8      "salesPrice": 4500
9    }
10  ]
11}

Here’s an example of a request that includes a product attribute:

1{
2  "pricebook2Id": "01sAAC00002tGfhYBE",
3  "salesAgreementProductDetails": [
4    {
5      "product2Id": "01tAAC0000ADt2cYBD",
6      "pricebookEntryId": "01uAAC00000nRggYBE",
7      "initialPlannedQuantity": 10,
8      "salesPrice": 4500,
9      "discountPercentage": 5,
10      "salesAgreementProductAttributeDetails": [
11        {
12          "attributeDefinitionName": "Color",
13          "attributeValue": "Red",
14          "isPriceImpacting": false
15        }
16      ]
17    }
18  ]
19}

Properties 

All request properties are optional in the API schema. To add products, provide at least one salesAgreementProductDetails entry with product2Id, pricebookEntryId, initialPlannedQuantity, and salesPrice.

Note

NameTypeDescriptionRequired or OptionalAvailable Version
pricebook2IdStringThe ID of the price book associated with the sales agreement.Optional60.0
salesAgreementProductDetailsSales Agreement Product Details Input[]The details of the sales agreement product.Optional60.0