salesRules/search

GET

/V1/salesRules/search

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://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

响应示例

200 - 示例 1

{
    "items": [
        {
            "action_condition": {
                "aggregator_type": "string",
                "attribute_name": "string",
                "condition_type": "string",
                "conditions": [
                    {}
                ],
                "extension_attributes": {},
                "operator": "string",
                "value": "string"
            },
            "apply_to_shipping": true,
            "condition": {
                "aggregator_type": "string",
                "attribute_name": "string",
                "condition_type": "string",
                "conditions": [
                    {}
                ],
                "extension_attributes": {},
                "operator": "string",
                "value": "string"
            },
            "coupon_type": "string",
            "customer_group_ids": [
                0
            ],
            "description": "string",
            "discount_amount": 0,
            "discount_qty": 0,
            "discount_step": 0,
            "extension_attributes": {
                "reward_points_delta": 0
            },
            "from_date": "string",
            "is_active": true,
            "is_advanced": true,
            "is_rss": true,
            "name": "string",
            "product_ids": [
                0
            ],
            "rule_id": 0,
            "simple_action": "string",
            "simple_free_shipping": "string",
            "sort_order": 0,
            "stop_rules_processing": true,
            "store_labels": [
                {
                    "extension_attributes": {},
                    "store_id": 0,
                    "store_label": "string"
                }
            ],
            "times_used": 0,
            "to_date": "string",
            "use_auto_generation": true,
            "uses_per_coupon": 0,
            "uses_per_customer": 0,
            "website_ids": [
                0
            ]
        }
    ],
    "search_criteria": {
        "current_page": 0,
        "filter_groups": [
            {
                "filters": [
                    {
                        "condition_type": "string",
                        "field": "string",
                        "value": "string"
                    }
                ]
            }
        ],
        "page_size": 0,
        "sort_orders": [
            {
                "direction": "string",
                "field": "string"
            }
        ]
    },
    "total_count": 0
}

请求参数

Query 参数

searchCriteria[filterGroups][0][filters][0][field]

string

Field

可选

searchCriteria[filterGroups][0][filters][0][value]

string

Value

可选

searchCriteria[filterGroups][0][filters][0][conditionType]

string

可选

Condition type

searchCriteria[sortOrders][0][field]

string

可选

Sorting field.

searchCriteria[sortOrders][0][direction]

string

可选

Sorting direction.

searchCriteria[pageSize]

integer

可选

Page size.

searchCriteria[currentPage]

integer

可选

Current page.

返回响应

🟢200成功

application/json

200 Success.

Body

items

array[object (sales-rule-data-rule-interface) {28}]

Rules.

必需

action_condition

object (sales-rule-data-condition-interface)

可选

Interface ConditionInterface

apply_to_shipping

boolean

必需

The rule applies to shipping

condition

object (sales-rule-data-condition-interface)

可选

Interface ConditionInterface

coupon_type

string

必需

Coupon type

customer_group_ids

array[integer]

必需

Ids of customer groups that the rule applies to

description

string

可选

Description

discount_amount

number

必需

Discount amount

discount_qty

number

可选

Maximum qty discount is applied

discount_step

integer

必需

Discount step

extension_attributes

object (sales-rule-data-rule-extension-interface)

可选

ExtensionInterface class for @see \Magento\SalesRule\Api\Data\RuleInterface

from_date

string

可选

The start date when the coupon is active

is_active

boolean

必需

The coupon is active

is_advanced

boolean

必需

Is this field needed

is_rss

boolean

必需

Whether the rule is in RSS

name

string

Rule name

可选

product_ids

array[integer]

可选

Product ids

rule_id

integer

Rule id

可选

simple_action

string

可选

Simple action of the rule

simple_free_shipping

string

可选

To grant free shipping

sort_order

integer

必需

Sort order

stop_rules_processing

boolean

必需

To stop rule processing

store_labels

array[object (sales-rule-data-rule-label-interface) {3}]

可选

Display label

times_used

integer

必需

How many times the rule has been used

to_date

string

可选

The end date when the coupon is active

use_auto_generation

boolean

必需

To auto generate coupon

uses_per_coupon

integer

必需

Limit of uses per coupon

uses_per_customer

integer

必需

Number of uses per customer

website_ids

array[integer]

必需

A list of websites the rule applies to

search_criteria

object (framework-search-criteria-interface)

必需

Search criteria interface.

current_page

integer

可选

Current page.

filter_groups

array[object (framework-search-filter-group) {1}]

必需

A list of filter groups.

page_size

integer

可选

Page size.

sort_orders

array[object (framework-sort-order) {2}]

可选

Sort order.

total_count

integer

必需

Total count.

🟠401没有权限

🔴500服务器错误

修改于 2024-11-22 03:29:06

carts/mine/totals-information

carts/search