Price Ramp for Multiple Line Items Overview
Use case
Previously, you could manage price ramps for only one line item per request. To add, update, or delete ramps for multiple lines, you had to send multiple requests, which increased processing time and complexity.
With the Ramps controller and its Ramp APIs, you can now manage price ramps for multiple line items in a single request. This is useful when you need to:
- Create ramps for several products in one operation.
- Add additional ramp lines to multiple existing ramped items.
- Update ramp quantities, terms, and dates across multiple ramp lines.
- Delete ramp lines for multiple items in a single call.
Ramps controller
To support managing multiple line items in a single request, a new Ramps controller is introduced as part of the Cart service.
| Property | Value |
|---|---|
| Base URL | api/cart/v1/carts/{cartId}/items/ramps |
| Service | Cart service |
| Documentation | Cart Swagger (Ramps controller) |
The Ramps controller exposes four Ramp APIs:
High-level behavior
All Ramp APIs operate on the same base URL and accept arrays of ramp definitions or ramp line references:
- Create Ramps: Creates ramp schedules for multiple existing line items using frequency, start/end dates, and number of periods.
- Add Ramps: Adds additional ramp lines for items that already have ramps.
- Update Ramps: Updates existing ramp line items, similar to updating line items.
- Delete Ramps: Deletes existing ramp line items by ID (intermediate ramp lines cannot be deleted).
Each API returns a 202 Accepted response with a link to the cart
/status endpoint, where you can track processing progress.