List Rules of a Promotion

GET

/admin/promotions/{id}/{rule_type}

Retrieve a list of rules in a promotion. The type of rules retrieved depend on the value of the rule_type path parameter:

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

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

Request

Authorization

Path Params

Query Params

Responses

🟢200OK

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl '{backend_url}/admin/promotions/{id}/{rule_type}' \
-H 'Authorization: Bearer {access_token}'

Response Example

200 - Example 1

{
    "rules": [
        {
            "id": "string",
            "description": "string",
            "attribute": "customer_group_id",
            "operator": "gt",
            "values": [
                "cusgroup_123"
            ]
        }
    ]
}

Modified at 2025-06-17 04:10:32

List Rule Attribute Options of a Rule Type

List Rule Values Given a Rule Attribute