View Ramp Deal (GET)

View a ramp deal related to a quote line item or an order item.

This API request retrieves the segments if the ramp deal already exists. This API is applicable when you’re working with line ramps. To work with ramp deals for groups, you must use the Place Sales Transaction API and specify the groupRampActions property.

Resource 

 
1/connect/revenue-management/sales-transaction-contexts/{resourceId}/actions/ramp-deal-view

Resource Example 

 
1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/revenue-management/sales-transaction-contexts/{0QLxx0000004CSOGA2}/actions/ramp-deal-view?transactionId=0Q0xx0000004CDxCAM&transactionLineId=0QLxx0000004CSOGA2

Available Version 

62.0

HTTP Methods 

GET

Path Parameter for GET 
NameTypeDescriptionRequired or OptionalAvailable Version
resourceIdStringID of the quote line item, order item, or context.Required62.0

Request Parameters for GET 
Parameter NameTypeDescriptionRequired or OptionalAvailable Version
transaction​IdStringID of the quote or order required to hydrate the context and retrieve the quote lines.Required62.0
transaction​LineIdStringID of the quote or order line required to retrieve the segmented details.Required62.0

Response Body for GET 

Ramp Deal Service

Get Started with Revenue Management Developer Resources
Revenue Management Settings
Revenue Management Deployment
Product Catalog Management
Salesforce Pricing
Rate Management
Product Configurator
Transaction Management
Transaction Management Standard Objects
Transaction Management Fields on Standard Objects
Transaction Management Tooling API Objects
Transaction Management Platform Event
Transaction Management Business APIs
Resources
Asset Amendment (POST)
Asset Cancellation (POST)
Asset Renewal (POST)
Clone Sales Transaction (POST)
Create Promotions (GET, POST, PUT)
Get Eligible Promotions (POST)
Initiate Downgrade (POST)
Initiate Swap (POST)
Initiate Upgrade (POST)
Instant Pricing (POST)
Place Order (POST)
Place Quote (POST)
Place Sales Transaction (POST)
Place Supplemental Transaction (POST)
Read Sales Transaction (POST)
Retrieve Sales Transaction API Errors (GET)
Unlock Transaction (POST)
Create Ramp Deal (POST)
Delete Ramp Deal (POST)
Update Ramp Deal (POST)
View Ramp Deal (GET)
Request Bodies
Response Bodies
Transaction Management Apex Reference
Transaction Management Standard Invocable Actions
Transaction Management Metadata API Types
Advanced Approvals
Dynamic Revenue Orchestrator
Usage Management
Billing
Revenue Management Associated Objects
Previous Versions