Skip to main content
GET
/
commerce
/
rules
/
callOffOrder
/
{code}
Error
A valid request URL is required to generate request examples
{
  "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
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
code
string
required

The rule's tenant-unique code (slug).

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Response

OK

Tenant-scoped, expression-based rule that selects Mozu.CommerceRuntime.Contracts.CallOffOrders.CallOffOrder entities for downstream composite consumers (e.g. CallOff Reservation Rule in Catalog).

​
auditInfo
object
​
code
string | null

Tenant-unique stable identifier referenced by composite consumers. Matches [A-Za-z0-9_-]+. Auto-generated from Mozu.CommerceRuntime.Contracts.CallOffOrderRules.CallOffOrderRule.Name when omitted on create. Immutable after create.

​
description
string | null

Optional rule purpose / authoring notes. Max 2000 chars.

​
enabled
boolean

If false, the evaluate endpoint rejects the rule with HTTP 400. Lifecycle CRUD reads continue to return it. Default true on create.

​
expression
object
​
id
string | null

System-generated unique identifier (MozuObjectId). Server-set; ignored on write.

​
metaData
object | null

Free-form consumer-specific metadata. Mirrors PurchaseLimitRule.MetaData.

​
name
string | null

Human-readable rule name. Required; non-empty; max 255 chars.

​
ruleType
string | null

Identifies which composite consumer family uses this rule. Free string matching [A-Za-z0-9_-]+. Well-known values: "Reservation", "PurchaseLimit", "Custom".

​
tenantId
integer<int32>

Tenant identifier. Populated from IApiContext on the server. Never accepted from the client request body.