Cart-Based APIs and Guest Users

The following URIs and their corresponding Cart-Based REST APIs, remote actions, and CpqAppHandler calls allow guest users to create and update records.

/carts

Create Cart

POST /carts
/cpq/carts/*
- Get Cart Summary
  
  GET /cpq/carts/{encrypted_cart_ID}
- Update Cart Summary (see Industries Configure, Price, Quote Web APIs v2 Documentation)
  
  PUT /cpq/carts/{encrypted_cart_ID}
/cpq/carts/*/attributes

Get Filterable Attributes

GET /cpq/carts/{encrypted_cart_ID}/attributes
/cpq/carts/*/cancel
- Cancel Order
  
  POST /cpq/carts/{encrypted_cart_ID}/cancel
- Create Supplemental Order
  
  POST /cpq/carts/{encrypted_order_ID}/cancel
- Send Updates on Cancellations (see Industries Configure, Price, Quote Web APIs v2 Documentation)
  
  PUT /cpq/carts/{encrypted_cart_ID}/cancel
- Submit a Cancel Order Request
  
  POST /v2/cpq/carts/{encrypted_order_ID}/cancel
/cpq/carts/*/items
- Add Items to Cart
  
  POST /cpq/carts/{encrypted_cart_ID}/items
- Add to Cart
  
  POST /cpq/carts/{encrypted_cart_ID}/items
- Get Cart Items
  
  GET /cpq/carts/{encrypted_cart_ID}/items
- Get Line Items by ID
  
  GET /cpq/carts/{encrypted_cart_ID}/items
- Remove Items from Cart
  
  DELETE /cpq/carts/{encrypted_cart_ID}/items
- Update Items in Cart
  
  PUT /cpq/carts/{encrypted_cart_ID}/items
/cpq/carts/*/items/checkout
- Checkout Items in Cart
  
  POST /cpq/carts/{encrypted_cart_ID}/items/checkout
- Check Status of the Cart
  
  GET /cpq/carts/{encrypted_cart_ID}/items/checkout
/cpq/carts//items//itemattributes

Update Item Attributes

PUT /cpq/carts/{encrypted_cart_ID}/items/{itemId}/itemattributes
/cpq/carts//items//pricing
- Apply Adjustment
  
  POST /cpq/carts/{encrypted_cart_ID}/items/{itemId}/pricing
- Apply an Adjustment (Discount, Markup, or Override to a Price) see Industries Configure, Price, Quote Web APIs v2 Documentation
  
  PUT /cpq/carts/{encrypted_cart_ID}/items/{itemId}/pricing
- Delete Adjustment
  
  DELETE /cpq/carts/{encrypted_cart_ID}/items/{itemId}/pricing
- Get Price Waterfall for Price
  
  GET /cpq/carts/{encrypted_cart_ID}/items/{itemId}/pricing
/cpq/carts/*/price
- Price Items in Cart (Query)
  
  GET /cpq/carts/{encrypted_cart_ID}/price
- Run Pricing for Items to Cart
  
  POST /cpq/carts/{encrypted_cart_ID}/price
/cpq/carts/*/pricelists

Get Price Lists for Cart

GET /cpq/carts/{encrypted_cart_ID}/pricelists
/cpq/carts/*/products
- Get Details of Product
  
  GET /cpq/carts/{encrypted_cart_ID}/products/{pricebookEntryId}
- Get List of Products
  
  GET /cpq/carts/{encrypted_cart_ID}/products
- Get Products by ID
  
  GET /v2/cpq/carts/{encrypted_cart_ID}/products?{id}&includeAttachment=[true|false]
/cpq/carts/*/promotions
- Add Promotion to Cart
  
  POST /cpq/carts/{encrypted_cart_ID}/promotions
- Delete Applied Promo Items
  
  DELETE /cpq/carts/{encrypted_cart_ID}/promotions
- Get Applied or Available Promotions for Cart
  
  GET /cpq/carts/{encrypted_cart_ID}/promotions
- Get Cart Promotions
  
  GET /cpq/carts/{encrypted_cart_ID}/promotions
- Post Cart Promotion Items
  
  POST /cpq/carts/{encrypted_cart_ID}/promotions
/cpq/catalogs/*

Get Catalog Information

GET /cpq/catalogs