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.
GET
/V1/salesRules/search
curl \
--request GET 'https://magento2.winkelstraat.mac/rest/all/V1/salesRules/search'
Response examples (200)
{
"items": [
{
"rule_id": 42,
"name": "string",
"store_labels": [
{
"store_id": 42,
"store_label": "string",
"extension_attributes": {}
}
],
"description": "string",
"website_ids": [
42
],
"customer_group_ids": [
42
],
"from_date": "string",
"to_date": "string",
"uses_per_customer": 42,
"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": [
42
],
"sort_order": 42,
"simple_action": "string",
"discount_amount": 42.0,
"discount_qty": 42.0,
"discount_step": 42,
"apply_to_shipping": true,
"times_used": 42,
"is_rss": true,
"coupon_type": "string",
"use_auto_generation": true,
"uses_per_coupon": 42,
"simple_free_shipping": "string",
"extension_attributes": {
"reward_points_delta": 42,
"product_groups": [
"string"
]
}
}
],
"search_criteria": {
"filter_groups": [
{
"filters": [
{
"field": "string",
"value": "string",
"condition_type": "string"
}
]
}
],
"sort_orders": [
{
"field": "string",
"direction": "string"
}
],
"page_size": 42,
"current_page": 42
},
"total_count": 42
}
Response examples (200)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<items type="array">
<item>
<rule-id type="integer">42</rule-id>
<name>string</name>
<store-labels type="array">
<store-label>
<store-id type="integer">42</store-id>
<store-label>string</store-label>
<extension-attributes>
</extension-attributes>
</store-label>
</store-labels>
<description>string</description>
<website-ids type="array">
<website-id type="integer">42</website-id>
</website-ids>
<customer-group-ids type="array">
<customer-group-id type="integer">42</customer-group-id>
</customer-group-ids>
<from-date>string</from-date>
<to-date>string</to-date>
<uses-per-customer type="integer">42</uses-per-customer>
<is-active type="boolean">true</is-active>
<condition>
<condition-type>string</condition-type>
<conditions type="array">
<condition>
</condition>
</conditions>
<aggregator-type>string</aggregator-type>
<operator>string</operator>
<attribute-name>string</attribute-name>
<value>string</value>
<extension-attributes>
</extension-attributes>
</condition>
<action-condition>
<condition-type>string</condition-type>
<conditions type="array">
<condition>
</condition>
</conditions>
<aggregator-type>string</aggregator-type>
<operator>string</operator>
<attribute-name>string</attribute-name>
<value>string</value>
<extension-attributes>
</extension-attributes>
</action-condition>
<stop-rules-processing type="boolean">true</stop-rules-processing>
<is-advanced type="boolean">true</is-advanced>
<product-ids type="array">
<product-id type="integer">42</product-id>
</product-ids>
<sort-order type="integer">42</sort-order>
<simple-action>string</simple-action>
<discount-amount type="float">42.0</discount-amount>
<discount-qty type="float">42.0</discount-qty>
<discount-step type="integer">42</discount-step>
<apply-to-shipping type="boolean">true</apply-to-shipping>
<times-used type="integer">42</times-used>
<is-rss type="boolean">true</is-rss>
<coupon-type>string</coupon-type>
<use-auto-generation type="boolean">true</use-auto-generation>
<uses-per-coupon type="integer">42</uses-per-coupon>
<simple-free-shipping>string</simple-free-shipping>
<extension-attributes>
<reward-points-delta type="integer">42</reward-points-delta>
<product-groups type="array">
<product-group>string</product-group>
</product-groups>
</extension-attributes>
</item>
</items>
<search-criteria>
<filter-groups type="array">
<filter-group>
<filters type="array">
<filter>
<field>string</field>
<value>string</value>
<condition-type>string</condition-type>
</filter>
</filters>
</filter-group>
</filter-groups>
<sort-orders type="array">
<sort-order>
<field>string</field>
<direction>string</direction>
</sort-order>
</sort-orders>
<page-size type="integer">42</page-size>
<current-page type="integer">42</current-page>
</search-criteria>
<total-count type="integer">42</total-count>
</root>
Response examples (401)
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Response examples (401)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<message>string</message>
<errors type="array">
<error>
<message>string</message>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
</error>
</errors>
<code type="integer">42</code>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
<trace>string</trace>
</root>
Response examples (500)
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Response examples (500)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<message>string</message>
<errors type="array">
<error>
<message>string</message>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
</error>
</errors>
<code type="integer">42</code>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
<trace>string</trace>
</root>
Response examples (default)
{
"message": "string",
"errors": [
{
"message": "string",
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
]
}
],
"code": 42,
"parameters": [
{
"resources": "string",
"fieldName": "string",
"fieldValue": "string"
}
],
"trace": "string"
}
Response examples (default)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<message>string</message>
<errors type="array">
<error>
<message>string</message>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
</error>
</errors>
<code type="integer">42</code>
<parameters type="array">
<parameter>
<resources>string</resources>
<fieldName>string</fieldName>
<fieldValue>string</fieldValue>
</parameter>
</parameters>
<trace>string</trace>
</root>