Compares line items from multiple carts of a single quote.

Returns a table that compares line items (products, bundles, options) from multiple carts of the same quote. Each row represents a product or hierarchy node, and each cart appears in its own column. Products are unioned across all carts; null values indicate a product is absent in that cart. Supports paging when there are many products. Bundle and sub-bundle hierarchies are preserved.

Up to 5 carts can be compared at a time.

Mandatory Fields:

  • request.CartIds - required; must contain 2 to 5 unique valid cart ID GUIDs

Required Fields:

  • request.PageNumber - must be greater than or equal to 1 (defaults to 1)

  • request.PageSize - must be greater than or equal to 1 (defaults to 50)

Responses

  • 200 OK: the paged line-item comparison is returned.

  • 400 Bad Request: the request is missing/invalid (e.g. fewer than 1 or more than 5 cart IDs, duplicate cart IDs, invalid GUIDs).

  • 500 Internal Server Error: an unexpected error occurred or data is still loading.
    Special Notes

  • Field selection is determined by system#comparequotesettings fieldset (defaults to ["NetPrice", "Quantity"]).

  • Products missing in a cart show null values in that column.

  • Hierarchy (bundles, sub-bundles, options) is preserved across all carts.

  • Multiple root bundles are supported and displayed correctly.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The quote ID that owns the carts being compared.

Body Params

Cart comparison request. Provide 1 to 5 cart IDs and optional paging values.
Fields are determined by system#comparequotesettings fieldset configuration.

Request model for comparing carts of a single quote.
Quote ID is passed via route parameter; cart IDs are provided in the request body.

CartIds
array of strings
required
length between 2 and 5

List of cart IDs to compare. Must contain 2 to 5 unique valid GUID strings.

CartIds*
int32
1 to 2147483647
Defaults to 1

Page number (1-based). Defaults to 1.

int32
1 to 2147483647
Defaults to 50

Number of root bundles (or standalone lines) per page. Defaults to 50.
Every descendant of a selected root is returned on the same page, so the returned row count may exceed this value.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

500

Internal Server Error

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json