Skip to main content
GET
List active business-logic rules for the authenticated organization

Authorizations

Authorization
string
header
required

User session token issued by NextAuth. For human users accessing Solya via the web application.

Query Parameters

phase
enum<string>

Filter by business phase

Available options:
SCORING,
SIZING,
SOURCING,
APPROVAL
actionFamily
enum<string>

Filter by action family (e.g. RESTOCK, MARKDOWN)

Available options:
RESTOCK_PLAN,
REBALANCE_PLAN,
MARKDOWN_PLAN,
PRE_SEASON_PLAN,
RECOMMENDATION,
WORKFLOW,
SUPPLIER_RETURN_PLAN,
SUPPLIER_EXCHANGE_PLAN
scopeShopId
string

Filter rules whose scope includes this shop ID

Minimum string length: 1
scopeBrandId
string

Filter rules whose scope includes this brand ID

Minimum string length: 1
scopeVariantId
string

Filter rules whose scope includes this variant ID

Minimum string length: 1
scopeSupplierId
string

Filter rules whose scope includes this supplier ID

Minimum string length: 1
limit
integer
default:100

Maximum number of rules to return (default: 100, max: 1000)

Required range: 1 <= x <= 1000
offset
integer
default:0

Number of rules to skip (default: 0)

Required range: 0 <= x <= 9007199254740991

Response

Successful response

data
object
required
success
enum<boolean>
required
Available options:
true