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

# Creates a Call-Off Order Rule. The expression is validated and canonicalized

> at save time; `code` auto-generates from `name` when omitted.



## OpenAPI

````yaml /openapi/openapi_commerce.json post /commerce/rules/callOffOrder
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:
    post:
      tags:
        - CallOffOrderRule
      summary: >-
        Creates a Call-Off Order Rule. The expression is validated and
        canonicalized
      description: at save time; `code` auto-generates from `name` when omitted.
      parameters:
        - 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/CallOffOrderRule'
        description: The rule to create.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallOffOrderRule'
            text/json:
              schema:
                $ref: '#/components/schemas/CallOffOrderRule'
            text/plain:
              schema:
                $ref: '#/components/schemas/CallOffOrderRule'
          description: OK
        '201':
          description: >-
            Rule created. Returns 409 if a rule with the supplied code already
            exists or the expression failed validation.
components:
  schemas:
    CallOffOrderRule:
      description: "Tenant-scoped, expression-based rule that selects Mozu.CommerceRuntime.Contracts.CallOffOrders.CallOffOrder\r\nentities for downstream composite consumers (e.g. CallOff Reservation Rule in Catalog)."
      properties:
        auditInfo:
          $ref: '#/components/schemas/CoreApiContractsAuditInfo'
        code:
          description: "Tenant-unique stable identifier referenced by composite consumers. Matches\r\n`[A-Za-z0-9_-]+`. Auto-generated from Mozu.CommerceRuntime.Contracts.CallOffOrderRules.CallOffOrderRule.Name when omitted\r\non create. Immutable after create."
          nullable: true
          type: string
        description:
          description: Optional rule purpose / authoring notes. Max 2000 chars.
          nullable: true
          type: string
        enabled:
          description: "If `false`, the evaluate endpoint rejects the rule with HTTP 400.\r\nLifecycle CRUD reads continue to return it. Default `true` on create."
          type: boolean
        expression:
          $ref: '#/components/schemas/CommerceRuntimeDynamicExpression'
        id:
          description: >-
            System-generated unique identifier (MozuObjectId). Server-set;
            ignored on write.
          nullable: true
          type: string
        metaData:
          description: >-
            Free-form consumer-specific metadata. Mirrors
            `PurchaseLimitRule.MetaData`.
          nullable: true
          type: object
        name:
          description: Human-readable rule name. Required; non-empty; max 255 chars.
          nullable: true
          type: string
        ruleType:
          description: "Identifies which composite consumer family uses this rule. Free string\r\nmatching `[A-Za-z0-9_-]+`. Well-known values: `\"Reservation\"`,\r\n`\"PurchaseLimit\"`, `\"Custom\"`."
          nullable: true
          type: string
        tenantId:
          description: "Tenant identifier. Populated from `IApiContext` on the server. Never\r\naccepted from the client request body."
          format: int32
          type: integer
      type: object
    CoreApiContractsAuditInfo:
      properties:
        createBy:
          nullable: true
          type: string
        createDate:
          format: date-time
          nullable: true
          type: string
        updateBy:
          nullable: true
          type: string
        updateDate:
          format: date-time
          nullable: true
          type: string
      type: object
    CommerceRuntimeDynamicExpression:
      properties:
        text:
          nullable: true
          type: string
        tree:
          $ref: '#/components/schemas/CommerceRuntimeExpression'
      type: object
    CommerceRuntimeExpression:
      properties:
        left:
          nullable: true
          type: string
        logicalOperator:
          nullable: true
          type: string
        nodes:
          items:
            $ref: '#/components/schemas/CommerceRuntimeExpression'
          nullable: true
          type: array
        operator:
          nullable: true
          type: string
        right:
          nullable: true
        type:
          nullable: true
          type: string
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: JWT Authorization header using the Bearer scheme.
      scheme: bearer
      type: http

````