Search carts
Finds carts matching the fields in the request body (such as customerNumber, status, registerId, paymentStatus). Paginated with 0-based page (default 0) and size (default 20); set includeItems=true to include line items.
How to use it
- Send any combination of filter fields in the body, e.g. status, customerNumber or paymentStatus; all must match. Leave out type and registerId, which currently make the search fail.
- Pass page (from 0) and size (default 20) in the query to page through the results.
- Nothing is changed; the response is a page of matching carts with paging totals.
BearerAuthAuthorizationBearer <JWT>page?integerPage number, starting at 0. See Paging.
int320size?integerNumber of records per page.
int3220includeItems?booleantrue to include each cart's line items; false (default) returns cart headers and totals only.
falseapplication/json- body
cartName?|Return carts whose name contains this text, ignoring case.
customerNumber?|Return carts for this exact customer number.
mobileNumber?|Return carts with this exact mobile number.
date?|Return carts whose stored creation timestamp equals this value exactly (same unit the client stored).
int32email?|Return carts whose email contains this text, ignoring case.
status?|Return carts in this state: Active, Discarded, Abandoned, Checkout, Suspended or Resumed.
"Active""Discarded""Abandoned""Checkout""Suspended""Resumed"nullorderId?|Return the cart linked to this exact order ID.
modifiedDate?|Return carts whose stored last-change timestamp equals this value exactly (same unit the client stored).
int32source?|Return carts whose source contains this text, ignoring case.
pin?|Return carts with this exact PIN.
int32type?|Intended to return carts with this cart type label. Not usable at the moment: sending it makes the search fail, so filter on other fields.
registerId?|Intended to return carts rung up on this register (see List registers). Not usable at the moment: sending it makes the search fail, so filter on other fields.
int32paymentStatus?|Return carts with this payment state: Paid, Unpaid or Refunded.
"Paid""Unpaid""Refunded"nullOK
*/*- response
content?array<>|The records on this page.
page?Paging details: page size, current page number, total matching records and total pages.
curl -X POST 'https://beta.iotoms.com/api/v1/transaction/cart/filter' \ -H 'Content-Type: application/json' \ -d '{}'{ "content": [ {} ], "page": { "size": 0, "number": 0, "totalElements": 0, "totalPages": 0 }}