Get Offers for Asset Invocable Action

Use this action to get a list of offers for an asset in a cart. Offers are modeled as products in Salesforce. For example, a sales rep can use this action to get a list of offers for customer who wants to know all the offers available for replacing one offer at a time on a broadband plan.

Required Editions

Available in: Lightning Experience
Available in: Enterprise, Unlimited, and Developer Editions

Industries CPQ API Used to Invoke Get Offers for Asset Invocable Action

  • getCartsTargetOffers
  • assetToOrder
  • assetToQuote

Input Values

Parameter description data type
cartId Optional. The ID of the quote or order record that you want to retrieve offers for. String
objectType Optional. The type of order record that you want to retrieve offers for. String
accountId Optional. The ID of the account record that you want to associate with the quote or order. String
assetIds Optional. The asset ID used for asset-to-order or asset-to-quote operation, separated by commas. String
OpportunityId Optional. The ID of the opportunity that you want to associate with the quote. String
requestDateTime Optional. The date and time when you place the request to retrieve offers for the order in GMT format. String
fields Optional. The list of fields that you want to retrieve, separated by commas. Boolean
noFilteredResponse Optional. A Boolean value that indicates whether to provide the response without filtering. The default value is false. String

Output Values

Parameter description data type
cartId The ID of the quote or order record for which offers were retrieved. String
offers A JSON string that includes the details of the offers retrieved for the cart. List of String
error An error that's encountered during the execution of the action. String

Example

JSON Request

{ 
  "accountId": "001Dn00000BeDH0IAN",
  "assetIds": "02iDn000008r1AVIAY",
  "objectType": "Order"
}

JSON Response Body

{
  "offers": [
    {
      "hasChildren": false,
      "ProductCode": {
        "value": "TEST_OBJECT"
      },
      "IsActive": {
        "value": true
      },
      "Id": {
        "value": "01uDn000005iJCZIA2",
        "label": "Price Book Entry ID"
      },
      "defaultQuantity": 1,
      "UnitPrice": {
        "value": "TEST",
        "label": "List Price"
      },
      "Product2": {
        "Name": "TESTObject",
        "Id": "01tDn000006LEYSIA4"
      }
    }
  ],
  "cartId": "801Dn000000vRGGIA2"
}