SalesRules

sales Rule Rule Repository V1Get By Id Get

Get rule by ID.

get

/V1/salesRules/{ruleId}

Path parameters

ruleIdstringrequired

(Required)

Example: <integer>

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{{baseurl}}/V1/salesRules/{ruleId}'

200

400

401

500

200

{
  "website_ids": [
    "<integer>",
    "<integer>"
  ],
  "customer_group_ids": [
    "<integer>",
    "<integer>"
  ],
  "uses_per_customer": "<integer>",
  "is_active": "<boolean>",
  "stop_rules_processing": "<boolean>",
  "is_advanced": "<boolean>",
  "sort_order": "<integer>",
  "discount_amount": "<number>",
  "discount_step": "<integer>",
  "apply_to_shipping": "<boolean>",
  "times_used": "<integer>",
  "is_rss": "<boolean>",
  "coupon_type": "<string>",
  "use_auto_generation": "<boolean>",
  "uses_per_coupon": "<integer>",
  "rule_id": "<integer>",
  "name": "<string>",
  "store_labels": [
    {
      "store_id": "<integer>",
      "store_label": "<string>",
      "extension_attributes": "<object>"
    },
    {
      "store_id": "<integer>",
      "store_label": "<string>",
      "extension_attributes": "<object>"
    }
  ],
  "description": "<string>",
  "from_date": "<string>",
  "to_date": "<string>",
  "condition": {
    "condition_type": "<string>",
    "operator": "<string>",
    "value": "<string>",
    "conditions": [
      {
        "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
      },
      {
        "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
      }
    ],
    "aggregator_type": "<string>",
    "attribute_name": "<string>",
    "extension_attributes": "<object>"
  },
  "action_condition": {
    "condition_type": "<string>",
    "operator": "<string>",
    "value": "<string>",
    "conditions": [
      {
        "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
      },
      {
        "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
      }
    ],
    "aggregator_type": "<string>",
    "attribute_name": "<string>",
    "extension_attributes": "<object>"
  },
  "product_ids": [
    "<integer>",
    "<integer>"
  ],
  "simple_action": "<string>",
  "discount_qty": "<number>",
  "simple_free_shipping": "<string>",
  "extension_attributes": "<object>"
}

OK

sales Rule Rule Repository V1Save Put

Save sales rule.

put

/V1/salesRules/{ruleId}

Path parameters

ruleIdstringrequired

(Required)

Example: <string>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example: {"rule":{"website_ids":["<integer>","<integer>"],"customer_group_ids":["<integer>","<integer>"],"uses_per_customer":"<integer>","is_active":"<boolean>","stop_rules_processing":"<boolean>","is_advanced":"<boolean>","sort_order":"<integer>","discount_amount":"<number>","discount_step":"<integer>","apply_to_shipping":"<boolean>","times_used":"<integer>","is_rss":"<boolean>","coupon_type":"<string>","use_auto_generation":"<boolean>","uses_per_coupon":"<integer>","rule_id":"<integer>","name":"<string>","store_labels":[{"store_id":"<integer>","store_label":"<string>","extension_attributes":"<object>"},{"store_id":"<integer>","store_label":"<string>","extension_attributes":"<object>"}],"description":"<string>","from_date":"<string>","to_date":"<string>","condition":{"condition_type":"<string>","operator":"<string>","value":"<string>","conditions":[{"value":"<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"},{"value":"<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"}],"aggregator_type":"<string>","attribute_name":"<string>","extension_attributes":"<object>"},"action_condition":{"condition_type":"<string>","operator":"<string>","value":"<string>","conditions":[{"value":"<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"},{"value":"<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"}],"aggregator_type":"<string>","attribute_name":"<string>","extension_attributes":"<object>"},"product_ids":["<integer>","<integer>"],"simple_action":"<string>","discount_qty":"<number>","simple_free_shipping":"<string>","extension_attributes":"<object>"}}

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'http://{{baseurl}}/V1/salesRules/{ruleId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "rule": {
      "website_ids": [
        "<integer>",
        "<integer>"
      ],
      "customer_group_ids": [
        "<integer>",
        "<integer>"
      ],
      "uses_per_customer": "<integer>",
      "is_active": "<boolean>",
      "stop_rules_processing": "<boolean>",
      "is_advanced": "<boolean>",
      "sort_order": "<integer>",
      "discount_amount": "<number>",
      "discount_step": "<integer>",
      "apply_to_shipping": "<boolean>",
      "times_used": "<integer>",
      "is_rss": "<boolean>",
      "coupon_type": "<string>",
      "use_auto_generation": "<boolean>",
      "uses_per_coupon": "<integer>",
      "rule_id": "<integer>",
      "name": "<string>",
      "store_labels": [
        {
          "store_id": "<integer>",
          "store_label": "<string>",
          "extension_attributes": "<object>"
        },
        {
          "store_id": "<integer>",
          "store_label": "<string>",
          "extension_attributes": "<object>"
        }
      ],
      "description": "<string>",
      "from_date": "<string>",
      "to_date": "<string>",
      "condition": {
        "condition_type": "<string>",
        "operator": "<string>",
        "value": "<string>",
        "conditions": [
          {
            "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
          },
          {
            "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
          }
        ],
        "aggregator_type": "<string>",
        "attribute_name": "<string>",
        "extension_attributes": "<object>"
      },
      "action_condition": {
        "condition_type": "<string>",
        "operator": "<string>",
        "value": "<string>",
        "conditions": [
          {
            "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
          },
          {
            "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
          }
        ],
        "aggregator_type": "<string>",
        "attribute_name": "<string>",
        "extension_attributes": "<object>"
      },
      "product_ids": [
        "<integer>",
        "<integer>"
      ],
      "simple_action": "<string>",
      "discount_qty": "<number>",
      "simple_free_shipping": "<string>",
      "extension_attributes": "<object>"
    }
  }'

200

400

401

500

200

{
  "website_ids": [
    "<integer>",
    "<integer>"
  ],
  "customer_group_ids": [
    "<integer>",
    "<integer>"
  ],
  "uses_per_customer": "<integer>",
  "is_active": "<boolean>",
  "stop_rules_processing": "<boolean>",
  "is_advanced": "<boolean>",
  "sort_order": "<integer>",
  "discount_amount": "<number>",
  "discount_step": "<integer>",
  "apply_to_shipping": "<boolean>",
  "times_used": "<integer>",
  "is_rss": "<boolean>",
  "coupon_type": "<string>",
  "use_auto_generation": "<boolean>",
  "uses_per_coupon": "<integer>",
  "rule_id": "<integer>",
  "name": "<string>",
  "store_labels": [
    {
      "store_id": "<integer>",
      "store_label": "<string>",
      "extension_attributes": "<object>"
    },
    {
      "store_id": "<integer>",
      "store_label": "<string>",
      "extension_attributes": "<object>"
    }
  ],
  "description": "<string>",
  "from_date": "<string>",
  "to_date": "<string>",
  "condition": {
    "condition_type": "<string>",
    "operator": "<string>",
    "value": "<string>",
    "conditions": [
      {
        "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
      },
      {
        "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
      }
    ],
    "aggregator_type": "<string>",
    "attribute_name": "<string>",
    "extension_attributes": "<object>"
  },
  "action_condition": {
    "condition_type": "<string>",
    "operator": "<string>",
    "value": "<string>",
    "conditions": [
      {
        "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
      },
      {
        "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
      }
    ],
    "aggregator_type": "<string>",
    "attribute_name": "<string>",
    "extension_attributes": "<object>"
  },
  "product_ids": [
    "<integer>",
    "<integer>"
  ],
  "simple_action": "<string>",
  "discount_qty": "<number>",
  "simple_free_shipping": "<string>",
  "extension_attributes": "<object>"
}

OK

sales Rule Rule Repository V1Delete By Id Delete

Delete rule by ID.

delete

/V1/salesRules/{ruleId}

Path parameters

ruleIdstringrequired

(Required)

Example: <integer>

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://{{baseurl}}/V1/salesRules/{ruleId}'

200

400

401

500

200

true

OK

sales Rule Rule Repository V1Save Post

Save sales rule.

post

/V1/salesRules

Header parameters

Content-Typestring

Example: application/json

Body

object

Example: {"rule":{"website_ids":["<integer>","<integer>"],"customer_group_ids":["<integer>","<integer>"],"uses_per_customer":"<integer>","is_active":"<boolean>","stop_rules_processing":"<boolean>","is_advanced":"<boolean>","sort_order":"<integer>","discount_amount":"<number>","discount_step":"<integer>","apply_to_shipping":"<boolean>","times_used":"<integer>","is_rss":"<boolean>","coupon_type":"<string>","use_auto_generation":"<boolean>","uses_per_coupon":"<integer>","rule_id":"<integer>","name":"<string>","store_labels":[{"store_id":"<integer>","store_label":"<string>","extension_attributes":"<object>"},{"store_id":"<integer>","store_label":"<string>","extension_attributes":"<object>"}],"description":"<string>","from_date":"<string>","to_date":"<string>","condition":{"condition_type":"<string>","operator":"<string>","value":"<string>","conditions":[{"value":"<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"},{"value":"<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"}],"aggregator_type":"<string>","attribute_name":"<string>","extension_attributes":"<object>"},"action_condition":{"condition_type":"<string>","operator":"<string>","value":"<string>","conditions":[{"value":"<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"},{"value":"<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"}],"aggregator_type":"<string>","attribute_name":"<string>","extension_attributes":"<object>"},"product_ids":["<integer>","<integer>"],"simple_action":"<string>","discount_qty":"<number>","simple_free_shipping":"<string>","extension_attributes":"<object>"}}

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/salesRules' \
  --header 'Content-Type: application/json' \
  --data '{
    "rule": {
      "website_ids": [
        "<integer>",
        "<integer>"
      ],
      "customer_group_ids": [
        "<integer>",
        "<integer>"
      ],
      "uses_per_customer": "<integer>",
      "is_active": "<boolean>",
      "stop_rules_processing": "<boolean>",
      "is_advanced": "<boolean>",
      "sort_order": "<integer>",
      "discount_amount": "<number>",
      "discount_step": "<integer>",
      "apply_to_shipping": "<boolean>",
      "times_used": "<integer>",
      "is_rss": "<boolean>",
      "coupon_type": "<string>",
      "use_auto_generation": "<boolean>",
      "uses_per_coupon": "<integer>",
      "rule_id": "<integer>",
      "name": "<string>",
      "store_labels": [
        {
          "store_id": "<integer>",
          "store_label": "<string>",
          "extension_attributes": "<object>"
        },
        {
          "store_id": "<integer>",
          "store_label": "<string>",
          "extension_attributes": "<object>"
        }
      ],
      "description": "<string>",
      "from_date": "<string>",
      "to_date": "<string>",
      "condition": {
        "condition_type": "<string>",
        "operator": "<string>",
        "value": "<string>",
        "conditions": [
          {
            "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
          },
          {
            "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
          }
        ],
        "aggregator_type": "<string>",
        "attribute_name": "<string>",
        "extension_attributes": "<object>"
      },
      "action_condition": {
        "condition_type": "<string>",
        "operator": "<string>",
        "value": "<string>",
        "conditions": [
          {
            "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
          },
          {
            "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
          }
        ],
        "aggregator_type": "<string>",
        "attribute_name": "<string>",
        "extension_attributes": "<object>"
      },
      "product_ids": [
        "<integer>",
        "<integer>"
      ],
      "simple_action": "<string>",
      "discount_qty": "<number>",
      "simple_free_shipping": "<string>",
      "extension_attributes": "<object>"
    }
  }'

200

400

401

500

200

{
  "website_ids": [
    "<integer>",
    "<integer>"
  ],
  "customer_group_ids": [
    "<integer>",
    "<integer>"
  ],
  "uses_per_customer": "<integer>",
  "is_active": "<boolean>",
  "stop_rules_processing": "<boolean>",
  "is_advanced": "<boolean>",
  "sort_order": "<integer>",
  "discount_amount": "<number>",
  "discount_step": "<integer>",
  "apply_to_shipping": "<boolean>",
  "times_used": "<integer>",
  "is_rss": "<boolean>",
  "coupon_type": "<string>",
  "use_auto_generation": "<boolean>",
  "uses_per_coupon": "<integer>",
  "rule_id": "<integer>",
  "name": "<string>",
  "store_labels": [
    {
      "store_id": "<integer>",
      "store_label": "<string>",
      "extension_attributes": "<object>"
    },
    {
      "store_id": "<integer>",
      "store_label": "<string>",
      "extension_attributes": "<object>"
    }
  ],
  "description": "<string>",
  "from_date": "<string>",
  "to_date": "<string>",
  "condition": {
    "condition_type": "<string>",
    "operator": "<string>",
    "value": "<string>",
    "conditions": [
      {
        "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
      },
      {
        "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
      }
    ],
    "aggregator_type": "<string>",
    "attribute_name": "<string>",
    "extension_attributes": "<object>"
  },
  "action_condition": {
    "condition_type": "<string>",
    "operator": "<string>",
    "value": "<string>",
    "conditions": [
      {
        "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
      },
      {
        "value": "<Circular reference to #/components/schemas/sales-rule-data-condition-interface detected>"
      }
    ],
    "aggregator_type": "<string>",
    "attribute_name": "<string>",
    "extension_attributes": "<object>"
  },
  "product_ids": [
    "<integer>",
    "<integer>"
  ],
  "simple_action": "<string>",
  "discount_qty": "<number>",
  "simple_free_shipping": "<string>",
  "extension_attributes": "<object>"
}

OK