Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

code
string
required

Query Parameters

responseFields
string

limits which fields are returned in the response body

Response

OK

Reservation Rule contract (CAT-7686)

auditInfo
object
callOffOrderRules
string[] | null

Referenced call-off-order rule codes. Max 1 entry.

code
string | null

Unique identifier. Auto-generated when omitted on create.

customerRules
string[] | null

Referenced customer rule codes. Max 1 entry.

description
string | null

Optional description, max 500 chars.

enabled
boolean | null

Whether the rule is active. Defaults to true on insert.

endDate
string<date-time> | null

End of the rule's effective window. Null = never expires. Must be >= StartDate when both supplied.

isActive
boolean | null

Read-only. Computed server-side: true when the current UTC instant is inside the effective window (StartDate null/≤now AND EndDate null/≥now), false otherwise. A rule with no dates is always active. This reflects the effective window alone and does not incorporate the enabled flag.

metaData
any | null

Opaque JSON metadata. Passed through unchanged.

name
string | null

Display name. Required, max 200 chars.

productRules
object[] | null

Referenced product rules. Max 1 entry.

rank
integer<int32>

Priority rank, unique per master catalog within the tenant. Auto-assigned when omitted or ≤0.

sortAttribute
string | null

Optional tiebreaker attribute name used by the reservation engine when two call-off orders match. Max 50 chars.

startDate
string<date-time> | null

Start of the rule's effective window. Null = no lower bound (already active).

timeFenceDays
integer<int32>

Time fence in days. Inclusive [0, 365].

validForAllSites
boolean | null

When true the rule applies to all sites; ValidSites is ignored.

validSites
integer<int32>[] | null

Site IDs this rule applies to. Optional — when omitted and ValidForAllSites is not true, the server auto-sets ValidForAllSites=true (FR-022).