Gets the line items grouped by a field, or the grouping metadata for a cart.

get

https://rls.congacloud.com/api/cart/v1/carts/{cartId}/group/status

DEPRECATION NOTICE: The functionality to retrieve grouped line items with isMetadata=false is deprecated and will be removed in a future release.

Required Fields:

cartId (route) - required
group (query) - required; field name to group line items by

Responses

200 OK: the grouped line items or grouping metadata are returned.
400 Bad Request: the cartId or group is missing/invalid.
500 Internal Server Error: an unexpected error occurred.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

cartId

string

required

Cart Id.

Query Params

group

string

required

Field name to group the line items by.

filter

array of strings

Filter conditions applied to the line items before grouping.

filter

sort

array of strings

Sort order definitions applied to the grouped result.

sort

filterExpression

string

Advanced hierarchical filter expression; takes precedence over filter when supplied.

isMetadata

boolean

Defaults to true

When true, returns group-header metadata and paginates the group keys; when false, returns the line items in the group and paginates the line items. Defaults to true (metadata mode). DEPRECATED: Using isMetadata=false is deprecated and will be removed in a future release.

pageNumber

int32

Defaults to 1

1-based page index. Provides the page of group headers. Defaults to 1.

pageSize

int32

Defaults to 50

Maximum number of records per page for group headers. Defaults to 50.

Responses

200

500

Internal Server Error

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad Request