Cart API Endpoints Reference
Endpoint Summary
Use these endpoints to manage carts, status, migration, and ramps.
| Operation | Method | Endpoint | Description |
|---|---|---|---|
| Create cart | POST | /api/cart/v1/carts | Create a new CPQ cart. |
| Get cart | GET | /api/cart/v1/carts/{cartId} | Retrieve cart details. |
| Update cart | PATCH | /api/cart/v1/carts/{cartId} | Update cart attributes. |
| Delete cart | DELETE | /api/cart/v1/carts/{cartId} | Delete a cart. |
| List carts | GET | /api/cart/v1/carts | List carts with optional filters. |
| Activate cart | POST | /api/cart/v1/carts/{cartId}/activate | Start cart processing and optional collaboration. |
| Get cart status | GET | /api/cart/v1/carts/{cartId}/status | Check processing and pricing state. |
| Migrate cart | POST | /api/cart/v1/carts/migrate | Migrate a single cart from a legacy system. |
| Migrate carts (batch) | POST | /api/cart/v1/carts/migrate/batch | Migrate multiple carts in a single batch. |
| Create ramps | POST | /api/cart/v1/carts/{cartId}/items/ramps | Create ramp schedules for multiple line items. |
| Add ramp lines | PUT | /api/cart/v1/carts/{cartId}/items/ramps | Add periods to existing ramp schedules. |
| Update ramp lines | PATCH | /api/cart/v1/carts/{cartId}/items/ramps | Update ramp period quantities and pricing. |
| Delete ramp lines | DELETE | /api/cart/v1/carts/{cartId}/items/ramps | Delete intermediate ramp periods. |