Communications, Media, Energy and Utilities (CME) Developer Guide

Get Started with CME Developer Resources
Fields on Standard Objects
Standard Objects
Associated Objects
Platform Event Objects
REST Reference
Resources
Request Bodies
Additional Fields Input
Bulk Product Details Input
Configuration Options Input
Configurator Added Node Input
Configurator Deleted Node Input
Configurator Input
Configurator Options Input
Configurator Preference Input
Configurator Updated Node Input
User Context Input
Context Data Input
Context Input
Execution Settings Input
Filter Criteria Input
Filter Input
Group Ramp Action Input
Object Graph Input
Object Input Map
Object with Reference Input
Sales Transaction Bulk Operation Filter
Sales Transaction Bulk Operation Input
Sales Transaction Input
Product Data Input
Product Details Input
Product List Input
Related Object Filter Input
User Context Input
Recipient Group Input
Split Recipient Group Input
Response Bodies
Invocable Actions
PDF

Group Ramp Action Input

Understand the sample request to specify group ramp actions during initial sale.

Keep these considerations in mind when you specify ramp actions.

JSON example to edit a group

This is a sample request that creates the first ramp segment. This request accepts IDs of a quote and quote line group. Additionally, the request accepts attributes of quote line group such as IsRamped, SegmentType, StartDate, and EndDate. A ramp segment is created with a ramp identifier and segment identifier added to all the quote line items available in the ramp segment.

This process converts a group into a segment, which becomes the first segment in the ramp schedule. A quote can contain a single ramp schedule only. To create another segment in the ramp schedule, use the Clone Sales Transaction API.

JSON example to edit a ramp segment
This is a sample request to edit multiple ramp segments simultaneously, maintaining date continuity among ramp segments.
JSON example to add a product
This is a sample request to add a product to the current and subsequent segments. A ramp identifier and segment identifier are added to the quote line items.
JSON example to delete a product
This is a sample request to delete a product from the current and subsequent ramp segments.
JSON example to delete a segment
This is a sample request to delete the first and last segment in a ramp schedule. The API throws an error if the specified segment isn't the first and last segment, ensuring there are no gaps between quote line items in different ramp segments.
JSON example to remove a segment from a ramp schedule
This is a sample request to remove the first or last ramp segment in a ramp schedule. This request removes the ramp-specific fields from a quote line group such as IsRamped and SegmentType. Additionally, this request removes the RampIdentifier and SegmentIdentifier fields from a quote line item.