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

The safety stock rule to create.

Represents a rule for safety stock in the product administration system.

​
auditInfo
object
​
code
string | null

Gets or sets the unique identifier of the SafetyStockRule. If not given provided on create one will be assigned. Read-only after creation.

​
description
string | null

Gets or sets the description of the SafetyStockRule.

​
enabled
boolean | null

Gets or sets whether the SafetyStockRule is enabled.

​
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.

​
locationCodes
string[] | null

Gets or sets the list of location codes where the SafetyStockRule applies.

​
locationGroups
string[] | null

Gets or sets the list of location groups where the SafetyStockRule applies.

​
metaData
any | null

Metadata for the Safety stock rule which is a json format, used to store additional information

​
name
string | null

Gets or sets the name of the SafetyStockRule.

​
productRules
object[] | null

Gets or sets the list of product rules associated with the SafetyStockRule.

​
quantity
integer<int32> | null

Gets or sets the quantity defined by the SafetyStockRule.

​
rank
integer<int32>

Gets or sets the rank of the SafetyStockRule. When not given or zero, a value will be assigned.

​
startDate
string<date-time> | null

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

Response

OK

Represents a rule for safety stock in the product administration system.

​
auditInfo
object
​
code
string | null

Gets or sets the unique identifier of the SafetyStockRule. If not given provided on create one will be assigned. Read-only after creation.

​
description
string | null

Gets or sets the description of the SafetyStockRule.

​
enabled
boolean | null

Gets or sets whether the SafetyStockRule is enabled.

​
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.

​
locationCodes
string[] | null

Gets or sets the list of location codes where the SafetyStockRule applies.

​
locationGroups
string[] | null

Gets or sets the list of location groups where the SafetyStockRule applies.

​
metaData
any | null

Metadata for the Safety stock rule which is a json format, used to store additional information

​
name
string | null

Gets or sets the name of the SafetyStockRule.

​
productRules
object[] | null

Gets or sets the list of product rules associated with the SafetyStockRule.

​
quantity
integer<int32> | null

Gets or sets the quantity defined by the SafetyStockRule.

​
rank
integer<int32>

Gets or sets the rank of the SafetyStockRule. When not given or zero, a value will be assigned.

​
startDate
string<date-time> | null

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