Retrieve sales rules that match te specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://developer.adobe.com/commerce/webapi/rest/attributes#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.
200 Success.
401 Unauthorized
Internal Server error
Unexpected error
{- "items": [
- {
- "rule_id": 0,
- "name": "string",
- "store_labels": [
- {
- "store_id": 0,
- "store_label": "string",
- "extension_attributes": { }
}
], - "description": "string",
- "website_ids": [
- 0
], - "customer_group_ids": [
- 0
], - "from_date": "string",
- "to_date": "string",
- "uses_per_customer": 0,
- "is_active": true,
- "condition": {
- "condition_type": "string",
- "conditions": [
- { }
], - "aggregator_type": "string",
- "operator": "string",
- "attribute_name": "string",
- "value": "string",
- "extension_attributes": { }
}, - "action_condition": {
- "condition_type": "string",
- "conditions": [
- { }
], - "aggregator_type": "string",
- "operator": "string",
- "attribute_name": "string",
- "value": "string",
- "extension_attributes": { }
}, - "stop_rules_processing": true,
- "is_advanced": true,
- "product_ids": [
- 0
], - "sort_order": 0,
- "simple_action": "string",
- "discount_amount": 0,
- "discount_qty": 0,
- "discount_step": 0,
- "apply_to_shipping": true,
- "times_used": 0,
- "is_rss": true,
- "coupon_type": "string",
- "use_auto_generation": true,
- "uses_per_coupon": 0,
- "simple_free_shipping": "string",
- "extension_attributes": {
- "reward_points_delta": 0
}
}
], - "search_criteria": {
- "filter_groups": [
- {
- "filters": [
- {
- "field": "string",
- "value": "string",
- "condition_type": "string"
}
]
}
], - "sort_orders": [
- {
- "field": "string",
- "direction": "string"
}
], - "page_size": 0,
- "current_page": 0
}, - "total_count": 0
}