TaxRules

tax Tax Rule Repository V1Get Get

get

Get TaxRule

Path parameters

ruleIdstringRequired

(Required)

Example: <integer>

Responses

200

OK

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/V1/taxRules/{ruleId}

HTTPcURLJavaScriptPython

GET /V1/taxRules/{ruleId} HTTP/1.1
Host: {{baseurl}}
Accept: */*

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

Delete TaxRule

Path parameters

ruleIdstringRequired

(Required)

Example: <integer>

Responses

200

OK

application/json

Responseobject

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

delete

/V1/taxRules/{ruleId}

HTTPcURLJavaScriptPython

DELETE /V1/taxRules/{ruleId} HTTP/1.1
Host: {{baseurl}}
Accept: */*

true

tax Tax Rule Repository V1Save Post

post

Save TaxRule

Header parameters

Content-TypestringOptionalExample: application/json

Body

application/json

objectOptionalExample: {"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

200

OK

application/json

Responseobject

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

/V1/taxRules

HTTPcURLJavaScriptPython

POST /V1/taxRules HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 300

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

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

put

Save TaxRule

Header parameters

Content-TypestringOptionalExample: application/json

Body

application/json

objectOptionalExample: {"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

200

OK

application/json

Responseobject

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

put

/V1/taxRules

HTTPcURLJavaScriptPython

PUT /V1/taxRules HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 300

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

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