List Rule Attribute Options of a Rule Type

Retrieve a list of potential rule attributes for the promotion and application method types specified in the query parameters.
Only the attributes of the rule type specified in the path parameter are retrieved:

If rule_type is rules, the attributes of the promotion's type are retrieved.

If rule_type is target-rules, the target rules' attributes of the application method's type are retrieved.

If rule_type is buy-rules, the buy rules' attributes of the application method's type are retrieved.

{ "attributes": [ { "id": "customer_group", "value": "customer.groups.id", "label": "Customer Group", "operators": [ { "id": "in", "value": "in", "label": "In" } ] } ] }

Request

Authorization

Path Params

rule_type

enum<string>

required

The rule type.

Allowed values:

rulestarget-rulesbuy-rules

Query Params

promotion_type

enum<string>

promotion_type

optional

The promotion type to retrieve rules for.

Allowed values:

standardbuyget

application_method_type

enum<string>

application_method_type

optional

The application method type to retrieve rules for.

Allowed values:

fixedpercentage

Responses

🟢200OK

application/json

Body

The list of attributes.

attributes

array[object (AdminRuleAttributeOption) {4}]

required

The list of attributes.

string

required

The rule attribute's ID, which is a rule's attribute it refers to.

Example:

customer_group

value

string

value

required

The rule attribute's value.

Example:

customer.groups.id

label

string

label

required

The rule attribute option's label.

Example:

Customer Group

operators

array[object (BaseRuleOperatorOptions) {3}]

required

The attribute's operators.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error