Save TaxRule

PUT /V1/taxRules

Save TaxRule

Body

rule object Required

Tax rule interface.
Hide rule attributes Show rule attributes object
- id integer
  
  Id
- code string Required
  
  Tax rule code
- priority integer Required
  
  Priority
- position integer Required
  
  Sort order.
- customer_tax_class_ids array[integer] Required
  
  Customer tax class id
- product_tax_class_ids array[integer] Required
  
  Product tax class id
- tax_rate_ids array[integer] Required
  
  Tax rate ids
- calculate_subtotal boolean
  
  Calculate subtotal.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Tax\Api\Data\TaxRuleInterface

Responses

200

200 Success.
Hide response attributes Show response attributes object
- id integer
  
  Id
- code string Required
  
  Tax rule code
- priority integer Required
  
  Priority
- position integer Required
  
  Sort order.
- customer_tax_class_ids array[integer] Required
  
  Customer tax class id
- product_tax_class_ids array[integer] Required
  
  Product tax class id
- tax_rate_ids array[integer] Required
  
  Tax rate ids
- calculate_subtotal boolean
  
  Calculate subtotal.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Tax\Api\Data\TaxRuleInterface
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
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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
  
  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
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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
  
  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
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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
  
  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
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

PUT /V1/taxRules

curl \
 -X PUT https://magento2.winkelstraat.mac/rest/all/V1/taxRules \
 -d '{"rule":{"id":42,"code":"string","priority":42,"position":42,"customer_tax_class_ids":[42],"product_tax_class_ids":[42],"tax_rate_ids":[42],"calculate_subtotal":true,"extension_attributes":{}}}'

Request examples

{
  "rule": {
    "id": 42,
    "code": "string",
    "priority": 42,
    "position": 42,
    "customer_tax_class_ids": [
      42
    ],
    "product_tax_class_ids": [
      42
    ],
    "tax_rate_ids": [
      42
    ],
    "calculate_subtotal": true,
    "extension_attributes": {}
  }
}

Response examples (200)

{
  "id": 42,
  "code": "string",
  "priority": 42,
  "position": 42,
  "customer_tax_class_ids": [
    42
  ],
  "product_tax_class_ids": [
    42
  ],
  "tax_rate_ids": [
    42
  ],
  "calculate_subtotal": true,
  "extension_attributes": {}
}

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