Get Cart Summary

Returns a comprehensive summary of the cart, including:

  • Account details and associated information
  • Multi-site order information and available sites
  • Action links for further operations (e.g., checkout)
  • A quick overview of your cart's status
  • Total costs broken down by type
  • Account information
  • Shipping details
  • Available actions like checkout
  • Multi-site order information
  • Instant access to cart information
  • Perfect for real-time displays like shopping cart icons
  • Reliable performance even during high-traffic periods
  • Faster than full cart details
  • Ideal for mobile apps and websites
  • Efficient bandwidth usage
  • Real-time pricing and discounts
  • Checkout readiness status
  • Consistent information across all channels
  • Monitor cart activity in real-time
  • Track sales performance
  • View customer shopping patterns
  • Quick view of cart totals
  • Instant status updates
  • Fast checkout verification
  • Track average cart values
  • Monitor discount usage
  • Analyze shopping trends
  • Role-based access controls
  • Secure data transmission
  • Protected customer information
  • Authenticated transactions
  • Comprehensive audit trails
  • Multi-language support
  • Currency conversion

Get Cart Details excludes these fields from the Opportunity, Order, and Quote.

  • IsDeleted

  • CreatedDate

  • CreatedById

  • LastModifiedDate

  • LastModifiedById

  • SystemModstamp

  • LastActivityDate

  • CleanStatus

Get Cart Details returns these fields from the Opportunity, Order, and Quote.

  • Opportunity

    { 'Name', 'Account.Id', 'Account.Name', 'Account.PhotoUrl', 'Email__c', 'Phone__c', 'EffectiveRecurringTotal__c', 'EffectiveOneTimeTotal__c', 'EffectiveOpportunityTotal__c', 'PriceListId__c','PriceListId__r.Name','PriceListId__r.CurrencyCode__c','PriceListId__r.LoyaltyCode__c', 'OriginatingContractId__c' }

  • Order

    { 'Name', 'Status', 'OrderNumber', 'Account.Id', 'Account.Name', 'Account.PhotoUrl', 'ShippingAddress', 'ShipToContact.Name', 'Email__c', 'Phone__c', 'EffectiveRecurringTotal__c', 'EffectiveOneTimeTotal__c', 'EffectiveOrderTotal__c','PriceListId__c','PriceListId__r.Name','PriceListId__r.CurrencyCode__c','PriceListId__r.LoyaltyCode__c', 'OrderStatus__c', 'IsChangesAllowed__c', 'SupersededOrderId__c', 'OriginatingContractId__c','SupplementalAction__c', 'RecordType.Name', 'AsyncOperation__c' }

  • Quote

    { 'Name', 'QuoteNumber', 'Account.Id', 'Account.Name', 'Account.PhotoUrl', 'ShippingAddress', 'ShippingName', 'Email', 'Phone', 'EffectiveRecurringTotal__c', 'EffectiveOneTimeTotal__c', 'EffectiveQuoteTotal__c', 'PriceListId__c','PriceListId__r.Name','PriceListId__r.CurrencyCode__c','PriceListId__r.LoyaltyCode__c', 'RenewalSourceContractId__c', 'RecordType.Name', 'AsyncOperation__c' }

By default, items deleted from a cart are not evaluated for Vlocity Rules. To enable evaluation of deleted items, set the 'ShouldConsiderDeletedItems' custom setting to true.

In ​Salesforce Industries Communications, Media, and Energy Winter '21 and later releases, the getCarts validate parameter has a default value of _True*, so the API will return validation messages. If validate=false is not specified, validation messages are returned by default. Specify validate=false in the UI if you do not want to receive validation messages.

This API supports the guest user enhancements that Salesforce introduced with the Winter ‘21 release. To encrypt and decrypt data for guest users, use the UserSecurity class with this API. See Guest User Technical Details.

For additional information, ​see UserSecurity Class and CPQ and Digital Commerce Changes for Guest Users.

Communication (vlocity_cmt)

For API parameter names and descriptions, see Cart-Based API Swagger Reference.

Response FormatJSON
Resource URL/services/apexrest/{namespace}/v2/cpq/carts/{CART_ID}?headerFieldSet={field_set_feature}&validate={true/false}