DocsAPI ReferenceCart/bff/cart/list
getCartAdmin BFF

/bff/cart/list

Returns a paginated list of carts for the authenticated organisation, sorted by updated_date descending. Each row includes a precomputed item count and a total price (in cart currency). Filters cover full-text search, empty / non-empty carts, anonymous vs identified, and a date range on updated_date.

CartgetBffCartList

Parameters

7 query

7 total
Query · 7
pagestring

Page number (1-based) for pagination.

limitstring

Max items per page (1–500, default 50).

filterFulltextQuerystring

Free-text search across cart identifier and customer email / first / last name.

hasItemsstring

"true" = only carts with at least one item, "false" = only empty carts.

hasCustomerstring

"true" = only carts linked to a contact, "false" = only anonymous carts.

updatedFromstring

Inclusive lower bound on updated_date (ISO date or datetime).

updatedTostring

Inclusive upper bound on updated_date (ISO date or datetime).

Request

GET /bff/cart/list

get
curl -X GET "https://api.bizkithub.com/bff/cart/list?page=1&limit=50&filterFulltextQuery=jan%40example.com&hasItems=true&hasCustomer=true&updatedFrom=example_updatedFrom&updatedTo=example_updatedTo" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key