Skip to main content
POST
Error

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Body

application/json

Reservation Steal-From Rule contract (CAT-7911). Structurally identical to Mozu.ProductAdmin.Contracts.ReservationRules.ReservationRule except it does not have TimeFenceDays; instead it adds an explicit Mozu.ProductAdmin.Contracts.ReservationStealFromRules.ReservationStealFromRule.StartDate/Mozu.ProductAdmin.Contracts.ReservationStealFromRules.ReservationStealFromRule.EndDate window during which the rule is enabled — the same effective-date-window concept used by Discounts and Price Lists, not a reworded time fence. Fully independent of the sibling Mozu.ProductAdmin.Contracts.ReservationStealForRules.ReservationStealForRule.

​
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 when omitted/null on create or update.

​
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 on create when omitted or ≤0. Rejected (not auto-assigned) on update when omitted or ≤0.

​
sortAttribute
string | null

Optional tiebreaker attribute name used by the reservation-stealing engine when two candidates match. Max 50 chars.

​
startDate
string<date-time> | null

Start of the rule's effective window. Null = no lower bound.

​
validForAllSites
boolean | null

When true the rule applies to all sites; ValidSites is ignored. When false/omitted and ValidSites is also omitted, ValidSites auto-populates with the calling site from the request context (FR-022); the save is rejected if no site context is available.

​
validSites
integer<int32>[] | null

Site IDs this rule applies to.

Response

OK

Reservation Steal-From Rule contract (CAT-7911). Structurally identical to Mozu.ProductAdmin.Contracts.ReservationRules.ReservationRule except it does not have TimeFenceDays; instead it adds an explicit Mozu.ProductAdmin.Contracts.ReservationStealFromRules.ReservationStealFromRule.StartDate/Mozu.ProductAdmin.Contracts.ReservationStealFromRules.ReservationStealFromRule.EndDate window during which the rule is enabled — the same effective-date-window concept used by Discounts and Price Lists, not a reworded time fence. Fully independent of the sibling Mozu.ProductAdmin.Contracts.ReservationStealForRules.ReservationStealForRule.

​
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 when omitted/null on create or update.

​
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 on create when omitted or ≤0. Rejected (not auto-assigned) on update when omitted or ≤0.

​
sortAttribute
string | null

Optional tiebreaker attribute name used by the reservation-stealing engine when two candidates match. Max 50 chars.

​
startDate
string<date-time> | null

Start of the rule's effective window. Null = no lower bound.

​
validForAllSites
boolean | null

When true the rule applies to all sites; ValidSites is ignored. When false/omitted and ValidSites is also omitted, ValidSites auto-populates with the calling site from the request context (FR-022); the save is rejected if no site context is available.

​
validSites
integer<int32>[] | null

Site IDs this rule applies to.