Get Account IDs Matching a Customer Rule

Returns a paginated list of customer account IDs that satisfy the specified customer rule’s expression. For Return-type rules, searches all account types. For other rule types, only B2B accounts are included.

GET /commerce/rules/customer/{code}/accountIds

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    123
  ],
  "pageCount": 123,
  "pageSize": 123,
  "startIndex": 123,
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

code · string · required

The customer rule code to evaluate

Query Parameters

startIndex · integer<int32> · default: 0

Starting index for pagination (default: 0)

pageSize · integer<int32> · default: 200

Number of results per page (max: 200, default: 200)

sortBy · string

Sort field and direction (e.g., "customerAccountId asc")

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

Paginated collection of customer account IDs returned when querying accounts by rule.

items · integer<int32>[] | null

pageCount · integer<int32>

pageSize · integer<int32>

startIndex · integer<int32>

totalCount · integer<int32>