TaxRates

tax Tax Rate Repository V1Get Get

Get tax rate

get

/V1/taxRates/{rateId}

Path parameters

rateIdstringrequired

(Required)

Example: <integer>

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{{baseurl}}/V1/taxRates/{rateId}'

200

400

401

500

200

{
  "tax_country_id": "<string>",
  "rate": "<number>",
  "code": "<string>",
  "id": "<integer>",
  "tax_region_id": "<integer>",
  "region_name": "<string>",
  "tax_postcode": "<string>",
  "zip_is_range": "<integer>",
  "zip_from": "<integer>",
  "zip_to": "<integer>",
  "titles": [
    {
      "store_id": "<string>",
      "value": "<string>",
      "extension_attributes": "<object>"
    },
    {
      "store_id": "<string>",
      "value": "<string>",
      "extension_attributes": "<object>"
    }
  ],
  "extension_attributes": "<object>"
}

OK

tax Tax Rate Repository V1Delete By Id Delete

Delete tax rate

delete

/V1/taxRates/{rateId}

Path parameters

rateIdstringrequired

(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/taxRates/{rateId}'

200

400

401

500

200

true

OK

tax Tax Rate Repository V1Save Post

Create or update tax rate

post

/V1/taxRates

Header parameters

Content-Typestring

Example: application/json

Body

object

Example: {"taxRate":{"tax_country_id":"<string>","rate":"<number>","code":"<string>","id":"<integer>","tax_region_id":"<integer>","region_name":"<string>","tax_postcode":"<string>","zip_is_range":"<integer>","zip_from":"<integer>","zip_to":"<integer>","titles":[{"store_id":"<string>","value":"<string>","extension_attributes":"<object>"},{"store_id":"<string>","value":"<string>","extension_attributes":"<object>"}],"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/taxRates' \
  --header 'Content-Type: application/json' \
  --data '{
    "taxRate": {
      "tax_country_id": "<string>",
      "rate": "<number>",
      "code": "<string>",
      "id": "<integer>",
      "tax_region_id": "<integer>",
      "region_name": "<string>",
      "tax_postcode": "<string>",
      "zip_is_range": "<integer>",
      "zip_from": "<integer>",
      "zip_to": "<integer>",
      "titles": [
        {
          "store_id": "<string>",
          "value": "<string>",
          "extension_attributes": "<object>"
        },
        {
          "store_id": "<string>",
          "value": "<string>",
          "extension_attributes": "<object>"
        }
      ],
      "extension_attributes": "<object>"
    }
  }'

200

400

401

500

200

{
  "tax_country_id": "<string>",
  "rate": "<number>",
  "code": "<string>",
  "id": "<integer>",
  "tax_region_id": "<integer>",
  "region_name": "<string>",
  "tax_postcode": "<string>",
  "zip_is_range": "<integer>",
  "zip_from": "<integer>",
  "zip_to": "<integer>",
  "titles": [
    {
      "store_id": "<string>",
      "value": "<string>",
      "extension_attributes": "<object>"
    },
    {
      "store_id": "<string>",
      "value": "<string>",
      "extension_attributes": "<object>"
    }
  ],
  "extension_attributes": "<object>"
}

OK

tax Tax Rate Repository V1Save Put

Create or update tax rate

put

/V1/taxRates

Header parameters

Content-Typestring

Example: application/json

Body

object

Example: {"taxRate":{"tax_country_id":"<string>","rate":"<number>","code":"<string>","id":"<integer>","tax_region_id":"<integer>","region_name":"<string>","tax_postcode":"<string>","zip_is_range":"<integer>","zip_from":"<integer>","zip_to":"<integer>","titles":[{"store_id":"<string>","value":"<string>","extension_attributes":"<object>"},{"store_id":"<string>","value":"<string>","extension_attributes":"<object>"}],"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/taxRates' \
  --header 'Content-Type: application/json' \
  --data '{
    "taxRate": {
      "tax_country_id": "<string>",
      "rate": "<number>",
      "code": "<string>",
      "id": "<integer>",
      "tax_region_id": "<integer>",
      "region_name": "<string>",
      "tax_postcode": "<string>",
      "zip_is_range": "<integer>",
      "zip_from": "<integer>",
      "zip_to": "<integer>",
      "titles": [
        {
          "store_id": "<string>",
          "value": "<string>",
          "extension_attributes": "<object>"
        },
        {
          "store_id": "<string>",
          "value": "<string>",
          "extension_attributes": "<object>"
        }
      ],
      "extension_attributes": "<object>"
    }
  }'

200

400

401

500

200

{
  "tax_country_id": "<string>",
  "rate": "<number>",
  "code": "<string>",
  "id": "<integer>",
  "tax_region_id": "<integer>",
  "region_name": "<string>",
  "tax_postcode": "<string>",
  "zip_is_range": "<integer>",
  "zip_from": "<integer>",
  "zip_to": "<integer>",
  "titles": [
    {
      "store_id": "<string>",
      "value": "<string>",
      "extension_attributes": "<object>"
    },
    {
      "store_id": "<string>",
      "value": "<string>",
      "extension_attributes": "<object>"
    }
  ],
  "extension_attributes": "<object>"
}

OK