CallOffOrderRule

Evaluates an enabled rule and returns the paged list of matching

Call-Off Order ids. Optionally AND-composes the rule expression with a statusFilter to scope results to a single status.

post/commerce/rules/callOffOrder/{code}/evaluate

Request

  • Base URL
    https://t1000000.sb.usc1.gcp.kibocommerce.com/api
  • URL
    https://t1000000.sb.usc1.gcp.kibocommerce.com/api/commerce/rules/callOffOrder/{code}/evaluate
  • Auth
    HTTP bearer

Path parameters

codestring required

The rule's tenant-unique code.

Query parameters

responseFieldsstring

limits which fields are returned in the response body

Request body

pageSizeinteger nullable

Requested page size. Defaults to 50 when omitted. Values above 200 are silently clamped to 200 per FR-009.

pageTokenstring nullable

Opaque cursor returned by a prior response's NextPageToken. Null on the first page.

statusFilterstring nullable

Optional Call-Off Order status (e.g. "Hold") AND-composed with the rule predicate at evaluation time.

Response

OK

callOffOrderIdsstring[] nullable

Matched Call-Off Order ids, up to PageSize, ordered by _id ascending.

nextPageTokenstring nullable

Cursor for the next page; null when this is the last page.

ruleCodestring nullable

Echoed input rule code for client correlation.

totalCountinteger

Total number of matching orders across all pages (not capped at PageSize).

Changes

No recorded changes to this operation across all 1 revision of this API.