Skip to main content
PUT
Error

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
code
string
required

The rule code to update.

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Body

application/json

The updated rule. Code in body must match URL code.

Contract DTO for a FutureShipmentRebalancing rule. Rules determine priority ordering for shipments in the Future Shipments Queue when supply changes trigger rebalancing.

​
auditInfo
object
​
code
string | null
​
customerRules
string[] | null
​
description
string | null
​
enabled
boolean | null
​
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
unknown
​
name
string | null
​
productRules
object[] | null
​
rank
integer<int32> | null
​
shipmentRules
object[] | null
​
sortAttribute
string | null
​
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].

Response

Rule updated successfully.

Contract DTO for a FutureShipmentRebalancing rule. Rules determine priority ordering for shipments in the Future Shipments Queue when supply changes trigger rebalancing.

​
auditInfo
object
​
code
string | null
​
customerRules
string[] | null
​
description
string | null
​
enabled
boolean | null
​
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
unknown
​
name
string | null
​
productRules
object[] | null
​
rank
integer<int32> | null
​
shipmentRules
object[] | null
​
sortAttribute
string | null
​
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].