Skip to main content
POST
/
commerce
/
rules
/
callOffOrder
/
{code}
/
evaluate
Error
A valid request URL is required to generate request examples
{
  "callOffOrderIds": [
    "<string>"
  ],
  "nextPageToken": "<string>",
  "ruleCode": "<string>",
  "totalCount": 123
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
code
string
required

The rule's tenant-unique code.

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Body

application/json

Optional StatusFilter, PageSize, and PageToken for cursor-style paging.

Request body for POST /commerce/rules/callOffOrder/{code}/evaluate.

​
pageSize
integer<int32> | null

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

​
pageToken
string | null

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

​
statusFilter
string | null

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

Response

OK

Response body for POST /commerce/rules/callOffOrder/{code}/evaluate.

​
callOffOrderIds
string[] | null

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

​
nextPageToken
string | null

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

​
ruleCode
string | null

Echoed input rule code for client correlation.

​
totalCount
integer<int32>

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