> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /openapi/openapi_commerce.json post /commerce/rules/callOffOrder/{code}/evaluate
openapi: 3.0.1
info:
  description: |-
    <div id="overview_COMMERCE">
                <h2>COMMERCE</h2>
                <p>The Commerce API interacts with the commerce entities of your tenant, including shoppers's active shopping
                    carts, checkouts, submitted orders, wishlists, and returns as well as B2B quotes.</p>
                <p>Use the <strong>Carts</strong> resource to manage storefront shopping carts as shoppers add and remove items for purchase.
                    Each time a shopper's cart is modified, the Carts resource updates the estimated total with any
                    applicable
                    discounts.</p>
                <p>Use the <strong>Channels</strong> and <strong>Channel Groups</strong> resources to manage the channels a company uses to create logical
                    commercial business divisions based on region or types of sales, such as "US Online," "Amazon," or "EMEA
                    Retail."
                    All orders include a channel association that enables the company to perform financial reporting for
                    each defined channel.
                    Because channels are managed at the tenant level, you must associate all the tenant's sites with a
                    channel. Sites that do not
                    have a defined channel association cannot successfully submit orders.</p>
                <p>Use the <strong>Checkouts</strong> resource to track a shopper's order items and their intended destinations on sites that
                    have the multiple shipment feature enabled.</p>
                <p>Use the <strong>Orders</strong> resource to manage all components of order processing, payment, and order-level
                    fulfillment.</p>
                <p>Use the <strong>Quotes</strong> resource to support B2B functionality by managing order quotes, similar to wishlists.</p>
                <p>Use the <strong>Returns</strong> resource to manage returned items that were previously fufilled. Returns can include any
                    number of items associated with an original
                    order. Each return must either be associated with an original order or a product definition to represent
                    each returned item.</p>
                <p>Use the <strong>Wish Lists</strong> resource to manage the shopper wish lists of products associated with a customer
                    account. Although customer accounts are managed at the tenant
                    level, the system stores shopper wish lists at the site level. This enables the same customer to have
                    wish lists for each of a merchant's sites. The <strong>Wish List Items</strong>
                    resource allows you to manage the individual items in a wish list.</p>
            </div>
  title: Cart/Checkout/Quote
  version: 0.0.1
servers:
  - description: Kibo Base URL
    url: '{baseUrl}/api'
    variables:
      baseUrl:
        default: https://t1000000.sb.usc1.gcp.kibocommerce.com
        description: Base URL
security:
  - bearerAuth: []
paths:
  /commerce/rules/callOffOrder/{code}/evaluate:
    post:
      tags:
        - CallOffOrderRule
      summary: Evaluates an enabled rule and returns the paged list of matching
      description: |-
        Call-Off Order ids. Optionally AND-composes the rule expression with a
        `statusFilter` to scope results to a single status.
      parameters:
        - description: The rule's tenant-unique code.
          in: path
          name: code
          required: true
          schema:
            type: string
        - description: limits which fields are returned in the response body
          in: query
          name: responseFields
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallOffOrderRuleEvalRequest'
        description: "Optional `StatusFilter`, `PageSize`, and\r\n            `PageToken` for cursor-style paging."
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallOffOrderRuleEvalResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CallOffOrderRuleEvalResponse'
            text/plain:
              schema:
                $ref: '#/components/schemas/CallOffOrderRuleEvalResponse'
          description: OK
        '404':
          description: No enabled rule exists for the given code.
components:
  schemas:
    CallOffOrderRuleEvalRequest:
      description: Request body for `POST /commerce/rules/callOffOrder/{code}/evaluate`.
      properties:
        pageSize:
          description: "Requested page size. Defaults to 50 when omitted. Values above 200 are\r\nsilently clamped to 200 per FR-009."
          format: int32
          nullable: true
          type: integer
        pageToken:
          description: "Opaque cursor returned by a prior response's `NextPageToken`. Null on\r\nthe first page."
          nullable: true
          type: string
        statusFilter:
          description: "Optional Call-Off Order status (e.g. `\"Hold\"`) AND-composed with the\r\nrule predicate at evaluation time."
          nullable: true
          type: string
      type: object
    CallOffOrderRuleEvalResponse:
      description: Response body for `POST /commerce/rules/callOffOrder/{code}/evaluate`.
      properties:
        callOffOrderIds:
          description: "Matched Call-Off Order ids, up to `PageSize`, ordered by `_id`\r\nascending."
          items:
            type: string
          nullable: true
          type: array
        nextPageToken:
          description: Cursor for the next page; null when this is the last page.
          nullable: true
          type: string
        ruleCode:
          description: Echoed input rule code for client correlation.
          nullable: true
          type: string
        totalCount:
          description: "Total number of matching orders across all pages (not capped at\r\n`PageSize`)."
          format: int32
          type: integer
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: JWT Authorization header using the Bearer scheme.
      scheme: bearer
      type: http

````