TaxRules

PreviousSearch NextSearch

tax Tax Rule Repository V1Get Get

Get TaxRule

get

/V1/taxRules/{ruleId}

Path parameters

ruleIdstringrequired

(Required)

Example: <integer>

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

500

{
  "code": "<string>",
  "priority": "<integer>",
  "position": "<integer>",
  "customer_tax_class_ids": [
    "<integer>",
    "<integer>"
  ],
  "product_tax_class_ids": [
    "<integer>",
    "<integer>"
  ],
  "tax_rate_ids": [
    "<integer>",
    "<integer>"
  ],
  "id": "<integer>",
  "calculate_subtotal": "<boolean>",
  "extension_attributes": "<object>"
}

tax Tax Rule Repository V1Delete By Id Delete

Delete TaxRule

delete

/V1/taxRules/{ruleId}

Path parameters

ruleIdstringrequired

(Required)

Example: <integer>

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

500

true

tax Tax Rule Repository V1Save Post

Save TaxRule

post

/V1/taxRules

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"rule":{"code":"<string>","priority":"<integer>","position":"<integer>","customer_tax_class_ids":["<integer>","<integer>"],"product_tax_class_ids":["<integer>","<integer>"],"tax_rate_ids":["<integer>","<integer>"],"id":"<integer>","calculate_subtotal":"<boolean>","extension_attributes":"<object>"}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/taxRules' \
  --header 'Content-Type: application/json' \
  --data '{
    "rule": {
      "code": "<string>",
      "priority": "<integer>",
      "position": "<integer>",
      "customer_tax_class_ids": [
        "<integer>",
        "<integer>"
      ],
      "product_tax_class_ids": [
        "<integer>",
        "<integer>"
      ],
      "tax_rate_ids": [
        "<integer>",
        "<integer>"
      ],
      "id": "<integer>",
      "calculate_subtotal": "<boolean>",
      "extension_attributes": "<object>"
    }
  }'

200

400

401

500

{
  "code": "<string>",
  "priority": "<integer>",
  "position": "<integer>",
  "customer_tax_class_ids": [
    "<integer>",
    "<integer>"
  ],
  "product_tax_class_ids": [
    "<integer>",
    "<integer>"
  ],
  "tax_rate_ids": [
    "<integer>",
    "<integer>"
  ],
  "id": "<integer>",
  "calculate_subtotal": "<boolean>",
  "extension_attributes": "<object>"
}

tax Tax Rule Repository V1Save Put

Save TaxRule

put

/V1/taxRules

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"rule":{"code":"<string>","priority":"<integer>","position":"<integer>","customer_tax_class_ids":["<integer>","<integer>"],"product_tax_class_ids":["<integer>","<integer>"],"tax_rate_ids":["<integer>","<integer>"],"id":"<integer>","calculate_subtotal":"<boolean>","extension_attributes":"<object>"}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://{{baseurl}}/V1/taxRules' \
  --header 'Content-Type: application/json' \
  --data '{
    "rule": {
      "code": "<string>",
      "priority": "<integer>",
      "position": "<integer>",
      "customer_tax_class_ids": [
        "<integer>",
        "<integer>"
      ],
      "product_tax_class_ids": [
        "<integer>",
        "<integer>"
      ],
      "tax_rate_ids": [
        "<integer>",
        "<integer>"
      ],
      "id": "<integer>",
      "calculate_subtotal": "<boolean>",
      "extension_attributes": "<object>"
    }
  }'

200

400

401

500

{
  "code": "<string>",
  "priority": "<integer>",
  "position": "<integer>",
  "customer_tax_class_ids": [
    "<integer>",
    "<integer>"
  ],
  "product_tax_class_ids": [
    "<integer>",
    "<integer>"
  ],
  "tax_rate_ids": [
    "<integer>",
    "<integer>"
  ],
  "id": "<integer>",
  "calculate_subtotal": "<boolean>",
  "extension_attributes": "<object>"
}