Error
A valid request URL is required to generate request examples{
"id": "rule-exchange-ratio",
"name": "Ratio de recommande",
"description": "Sur un échange, recommander au moins 110 % de ce qui est renvoyé.",
"category": "COMPLIANCE",
"condition": {
"contextType": "EXCHANGE_RECEIVE_RATIO",
"contextParams": {},
"operator": "LOWER_THAN",
"thresholdValue": 110
},
"enforcementMode": "BLOCK",
"checkLevel": "PLAN",
"evaluationPoints": [
"PRE_PLAN_VALIDATE"
],
"actionFamily": "SUPPLIER_EXCHANGE_PLAN",
"scopes": [
{
"position": 0,
"criteria": [
{
"kind": "ENTITY",
"entityType": "SUPPLIER",
"entityId": "supplier-sportswear"
}
],
"thresholdValue": 130
}
],
"active": true,
"priority": 0,
"templateId": "exchange_reorder_ratio",
"phase": null,
"paradigm": "VALIDATION",
"payload": null,
"version": 2
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}Settings
Change a rule's threshold, mode, perimeter or switch
Changes what the merchant owns: the threshold, the enforcement mode, when it fires, its per-subject scopes, its priority and its switch. It CANNOT repoint the rule at another measurement — that would be a rule builder, and the catalogue is closed on purpose. Sending scopes REPLACES the whole list, so read the rule first. expectedVersion is required and never defaulted: a stale write is refused with 409 rather than silently overwriting the administrator who saved thirty seconds earlier.
PUT
/
v1
/
rules
/
{ruleId}
Error
A valid request URL is required to generate request examples{
"id": "rule-exchange-ratio",
"name": "Ratio de recommande",
"description": "Sur un échange, recommander au moins 110 % de ce qui est renvoyé.",
"category": "COMPLIANCE",
"condition": {
"contextType": "EXCHANGE_RECEIVE_RATIO",
"contextParams": {},
"operator": "LOWER_THAN",
"thresholdValue": 110
},
"enforcementMode": "BLOCK",
"checkLevel": "PLAN",
"evaluationPoints": [
"PRE_PLAN_VALIDATE"
],
"actionFamily": "SUPPLIER_EXCHANGE_PLAN",
"scopes": [
{
"position": 0,
"criteria": [
{
"kind": "ENTITY",
"entityType": "SUPPLIER",
"entityId": "supplier-sportswear"
}
],
"thresholdValue": 130
}
],
"active": true,
"priority": 0,
"templateId": "exchange_reorder_ratio",
"phase": null,
"paradigm": "VALIDATION",
"payload": null,
"version": 2
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}Authorizations
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.
Path Parameters
The rule id, e.g. rule-exchange-ratio.
Minimum string length:
1Body
application/json
Required range:
0 < x <= 9007199254740991Required string length:
1 - 255Maximum string length:
2000Available options:
BLOCK, WARN, LOG Available options:
SHOP, BRAND, PRODUCT, VARIANT, INVENTORY_ITEM, PLAN, PLAN_ITEM Minimum array length:
1Available options:
PRE_PLAN_ITEM_ADD, PRE_PLAN_VALIDATE, RECOMMENDATION_GENERATION, WORKFLOW_EXECUTION, MANUAL_CHECK Available options:
CAPACITY, ASSORTMENT, ORDERING, TRANSFER, PRICING, DISTRIBUTION, COMPLIANCE Show child attributes
Show child attributes
Required range:
-9007199254740991 <= x <= 9007199254740991Response
The rule as it now stands, at its new version.
The rule as it now stands, at its new version.
Minimum string length:
1Required string length:
1 - 255Maximum string length:
2000Available options:
CAPACITY, ASSORTMENT, ORDERING, TRANSFER, PRICING, DISTRIBUTION, COMPLIANCE Show child attributes
Show child attributes
Available options:
BLOCK, WARN, LOG Available options:
SHOP, BRAND, PRODUCT, VARIANT, INVENTORY_ITEM, PLAN, PLAN_ITEM Available options:
PRE_PLAN_ITEM_ADD, PRE_PLAN_VALIDATE, RECOMMENDATION_GENERATION, WORKFLOW_EXECUTION, MANUAL_CHECK Available options:
RESTOCK_PLAN, REBALANCE_PLAN, MARKDOWN_PLAN, PRE_SEASON_PLAN, SUPPLIER_RETURN_PLAN, SUPPLIER_EXCHANGE_PLAN, RECOMMENDATION, WORKFLOW Show child attributes
Show child attributes
Required range:
-9007199254740991 <= x <= 9007199254740991Minimum string length:
1Available options:
SCORING, SIZING, SOURCING, APPROVAL Available options:
VALIDATION, DECISION_SHAPING Available options:
centrale, os Required range:
0 < x <= 9007199254740991