Skip to main content
GET
/
commerce
/
rules
/
callOffOrder
Error
A valid request URL is required to generate request examples
{
  "items": [
    {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "code": "<string>",
      "description": "<string>",
      "enabled": true,
      "expression": {
        "text": "<string>",
        "tree": {
          "left": "<string>",
          "logicalOperator": "<string>",
          "nodes": "<array>",
          "operator": "<string>",
          "right": null,
          "type": "<string>"
        }
      },
      "id": "<string>",
      "metaData": {},
      "name": "<string>",
      "ruleType": "<string>",
      "tenantId": 123
    }
  ],
  "pageCount": 123,
  "pageSize": 123,
  "startIndex": 123,
  "totalCount": 123
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

startIndex
integer<int32>
default:0

Zero-based page offset. Defaults to 0.

pageSize
integer<int32>
default:20

Maximum items returned. Defaults to 20.

sortBy
string

Optional sort expression, e.g. createDate desc.

filter
string

Optional filter expression, e.g. enabled eq true.

responseFields
string

limits which fields are returned in the response body

Response

OK

Paged result for Call-Off Order Rule list queries.

items
object[] | null

Page of call-off order rules matching the query.

pageCount
integer<int32>

Total number of pages.

pageSize
integer<int32>

Maximum number of records per page.

startIndex
integer<int32>

Zero-based index of the first record in this page.

totalCount
integer<int32>

Total number of matching records across all pages.