Revenue Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with Revenue Cloud Developer Resources
Product Catalog Management
Salesforce Pricing
Product Configurator
Product Configurator Standard Objects
Product Configurator Business APIs
Resources
Request Bodies
Configuration Get Instance Input
Configuration Load Instance Input
Configuration Save Input
Configuration Update Input
Configuration Save Instance Input
Configuration Set Instance Input
Configurator Add Nodes Input
Configurator Added Node Input
Configurator Delete Nodes Input
Configurator Deleted Node Input
Configurator Input
Configurator Options Input
Configurator Update Nodes Input
Configurator Updated Node Input
Product Quantity Set Configurator Input
User Context Input
Response Bodies
Transaction Management
Usage Management
Rate Management
Dynamic Revenue Orchestrator
Billing
Revenue Cloud Associated Objects
PDF

Configurator Input

Input representation of the request to modify the product configuration.
JSON example
This example shows a sample to initiate a context based on a transaction ID.
{
    "transactionLineId": "0QLDE000000IBXw4AO",
    "transactionId": "0Q0xx0000000001GAA",
    "correlationId": "c95246d4-102c-4ecd-a263-f74ac525d1e5",
    "configuratorOptions": {
        "executePricing": true,
        "returnProductCatalogData": true
    },
    "qualificationContext": {
        "accountId": "001xx0000000001AAA",
        "contactId": "003xx00000000D7AAI"
    }
}
This example shows a sample to add, update, or delete a node in an existing context.
{
    "transactionLineId": "0QLDE000000IBXw4AO",
    "transactionId": "0Q0DE000000ISHJs81",
    "correlationId": "c95246d4-102c-4ecd-a263-f74ac525d1e5",
    "configuratorOptions": {
        "executePricing": true,
        "returnProductCatalogData": true,
        "qualifyAllProductsInTransaction": true,
        "validateProductCatalog": true,
        "validateAmendRenewCancel": true,
        "executeConfigurationRules": true,
        "addDefaultConfiguration": true
    },
    "qualificationContext": {
        "accountId": "001xx0000000001AAA",
        "contactId": "003xx00000000D7AAI"
    },
    "transactionContextId": "008d27d7-e004-4906-a949-ee7d7c323c77",
    "addedNodes": [
        {
            "path": ["0Q0DE000000ISHJs81", "sti2_id"],
            "addedObject": {
                "id": "ref_sti2_id",
                "SalesTransactionSource": "sti2_id",
                "PricebookEntry": "01uxx0000000001AAA",
                "ProductSellingModel": "0jPxx0000000001AAA",
                "businessObjectType": "QuoteLineItem",
                "Quantity": 10,
                "UnitPrice": 2.0,
                "Product": "01txx0000000001AAA"
            }
        },
        {
            "path": ["0Q0DE000000ISHJs81", "0QLDE000000IBXw4AO","ref_stir1_id"],
            "addedObject": {
                "id": "ref_stir1_id",
                "businessObjectType": "QuoteLineItemRelationship",
                "MainItem": "0QLDE000000IBXw4AO",
                "AssociatedItem": "ref_sti2_id",
                "ProductRelatedComponent": "0dSxx0000000001AAA",
                "ProductRelationshipType": "0yoxx0000000001AAA",
                "AssociatedItemPricing": "IncludedInBundlePrice"
                
            }
        }
    ],
    "updatedNodes": [
        {
            "path": ["0Q0DE000000ISHJs81", "0QLDE000000IBXw4AO"],
            "updatedAttributes": {
                "Quantity": 5
            }
        }
    ],
    "deletedNodes": [
        {
            "path": ["0Q0DE000000ISHJs81", "0QLDE000000IBXw4AO"]
        }
    ]
}
Properties
Name Type Description Required or Optional Available Version
added​Nodes Configurator Added Node Input[] List of added context nodes that’s passed to the product configurator. Optional 60.0
configurator​Options Configurator Options Input[] Options to pass to the configurator. Optional 60.0
correlation​Id String ID that’s specified for traceability of logs. Optional 60.0
deleted​Nodes Configurator Deleted Node Input[] List of deleted context nodes that’s passed to the product configurator. Optional 60.0
qualification​Context User Context Input[] Details such as account ID, contact ID, and context ID that are used for executing qualification rules. Optional 60.0
transaction​ContextId String ID of the transaction context. Optional 60.0
transaction​Id String ID of the sales transaction that’s being configured such as a quote or an order. Required 60.0
transaction​LineId String ID of the top-level line item that’s being configured. Optional 60.0
updated​Nodes Configurator Updated Node Input[] List of updated context nodes that’s passed to the product configurator. Optional 60.0