Get rule by ID

GET /V1/salesRules/{ruleId}

Get rule by ID.

Path parameters

ruleId integer Required

Responses

200

200 Success.
Hide response attributes Show response attributes object
Interface RuleInterface
- rule_id integer
  
  Rule id
- name string
  
  Rule name
- store_labels array[object]
  
  Interface RuleLabelInterface
  
  Hide store_labels attributes Show store_labels attributes object
  
  Interface RuleLabelInterface
  
  store_id integer Required
  
  StoreId
  
  store_label string Required
  
  The label for the store
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\SalesRule\Api\Data\RuleLabelInterface
- description string
  
  Description
- website_ids array[integer] Required
  
  A list of websites the rule applies to
- customer_group_ids array[integer] Required
  
  Ids of customer groups that the rule applies to
- from_date string
  
  The start date when the coupon is active
- to_date string
  
  The end date when the coupon is active
- uses_per_customer integer Required
  
  Number of uses per customer
- is_active boolean Required
  
  The coupon is active
- condition object
  
  Interface ConditionInterface
  
  Hide condition attributes Show condition attributes object
  
  condition_type string Required
  
  Condition type
  
  conditions array[object]
  
  Interface ConditionInterface
  
  Interface ConditionInterface
  
  Interface ConditionInterface
  
  aggregator_type string
  
  The aggregator type
  
  operator string Required
  
  The operator of the condition
  
  attribute_name string
  
  The attribute name of the condition
  
  value string Required
  
  The value of the condition
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\SalesRule\Api\Data\ConditionInterface
- action_condition object
  
  Interface ConditionInterface
  
  Hide action_condition attributes Show action_condition attributes object
  
  condition_type string Required
  
  Condition type
  
  conditions array[object]
  
  Interface ConditionInterface
  
  Interface ConditionInterface
  
  Interface ConditionInterface
  
  aggregator_type string
  
  The aggregator type
  
  operator string Required
  
  The operator of the condition
  
  attribute_name string
  
  The attribute name of the condition
  
  value string Required
  
  The value of the condition
  
  extension_attributes object
  
  ExtensionInterface class for @see \Magento\SalesRule\Api\Data\ConditionInterface
- stop_rules_processing boolean Required
  
  To stop rule processing
- is_advanced boolean Required
  
  Is this field needed
- product_ids array[integer]
  
  Product ids
- sort_order integer Required
  
  Sort order
- simple_action string
  
  Simple action of the rule
- discount_amount number Required
  
  Discount amount
- discount_qty number
  
  Maximum qty discount is applied
- discount_step integer Required
  
  Discount step
- apply_to_shipping boolean Required
  
  The rule applies to shipping
- times_used integer Required
  
  How many times the rule has been used
- is_rss boolean Required
  
  Whether the rule is in RSS
- coupon_type string Required
  
  Coupon type
- use_auto_generation boolean Required
  
  To auto generate coupon
- uses_per_coupon integer Required
  
  Limit of uses per coupon
- simple_free_shipping string
  
  To grant free shipping
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\SalesRule\Api\Data\RuleInterface
  
  Hide extension_attributes attributes Show extension_attributes attributes object
  
  reward_points_delta integer
  
  product_groups array[string]
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
400

400 Bad Request
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
500

Internal Server error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

GET /V1/salesRules/{ruleId}

curl \
 -X GET https://magento2.winkelstraat.mac/rest/all/V1/salesRules/{ruleId}

Response examples (200)

{
  "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"
    ]
  }
}

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 (400)

{
  "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)

{
  "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)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}