Sign in

v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB
CallOffOrderRule

Returns a single Call-Off Order Rule by its tenant-unique code

Returns a single Call-Off Order Rule by its tenant-unique code.

get/commerce/rules/callOffOrder/{code}

Path parameters

codestring required

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

Query parameters

responseFieldsstring

limits which fields are returned in the response body

Response

OK

codestring nullable

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.

descriptionstring nullable

Optional rule purpose / authoring notes. Max 2000 chars.

enabledboolean

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

idstring nullable

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

metaDataobject nullable

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

namestring nullable

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

ruleTypestring nullable

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

tenantIdinteger

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