Skip to main content
GET
/
commerce
/
rules
/
safetystock
/
{code}
Error
A valid request URL is required to generate request examples
{
  "code": "<string>",
  "name": "<string>",
  "description": "<string>",
  "enabled": true,
  "productRules": [
    {
      "code": "<string>",
      "masterCatalogId": 123
    }
  ],
  "locationCodes": [
    "<string>"
  ],
  "locationGroups": [
    "<string>"
  ],
  "quantity": 123,
  "rank": 123,
  "metaData": "<unknown>",
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

code
string
required

The code of the safety stock rule.

Query Parameters

responseFields
string

limits which fields are returned in the response body

Response

Success

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

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.

name
string | null

Gets or sets the name of the SafetyStockRule.

description
string | null

Gets or sets the description of the SafetyStockRule.

enabled
boolean | null

Gets or sets whether the SafetyStockRule is enabled.

productRules
object[] | null

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

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.

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.

metaData
any | null

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

auditInfo
object