Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Body

application/json
id
string
required
Minimum string length: 1
templateId
string
required
Minimum string length: 1
name
string
required
Required string length: 1 - 255
actionFamily
enum<string>
required
Available options:
RESTOCK_PLAN,
REBALANCE_PLAN,
MARKDOWN_PLAN,
PRE_SEASON_PLAN,
SUPPLIER_RETURN_PLAN,
SUPPLIER_EXCHANGE_PLAN,
RECOMMENDATION,
WORKFLOW
description
string | null
Maximum string length: 2000
thresholdValue
number
enforcementMode
enum<string>
default:WARN
Available options:
BLOCK,
WARN,
LOG
scopes
object[]
active
boolean
default:true
priority
integer
default:0
Required range: -9007199254740991 <= x <= 9007199254740991

Response

The created rule, assembled from its template.

The created rule, assembled from its template.

id
string
required
Minimum string length: 1
name
string
required
Required string length: 1 - 255
description
string | null
required
Maximum string length: 2000
category
enum<string>
required
Available options:
CAPACITY,
ASSORTMENT,
ORDERING,
TRANSFER,
PRICING,
DISTRIBUTION,
COMPLIANCE
condition
object
required
enforcementMode
enum<string>
required
Available options:
BLOCK,
WARN,
LOG
checkLevel
enum<string>
required
Available options:
SHOP,
BRAND,
PRODUCT,
VARIANT,
INVENTORY_ITEM,
PLAN,
PLAN_ITEM
evaluationPoints
enum<string>[]
required
Available options:
PRE_PLAN_ITEM_ADD,
PRE_PLAN_VALIDATE,
RECOMMENDATION_GENERATION,
WORKFLOW_EXECUTION,
MANUAL_CHECK
actionFamily
enum<string> | null
required
Available options:
RESTOCK_PLAN,
REBALANCE_PLAN,
MARKDOWN_PLAN,
PRE_SEASON_PLAN,
SUPPLIER_RETURN_PLAN,
SUPPLIER_EXCHANGE_PLAN,
RECOMMENDATION,
WORKFLOW
scopes
object[]
required
active
boolean
required
priority
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
templateId
string | null
required
Minimum string length: 1
phase
enum<string> | null
required
Available options:
SCORING,
SIZING,
SOURCING,
APPROVAL
paradigm
enum<string>
required
Available options:
VALIDATION,
DECISION_SHAPING
origin
enum<string>
required
Available options:
centrale,
os
payload
unknown
required
version
integer
required
Required range: 0 < x <= 9007199254740991