TaxRates

tax Tax Rate Repository V1Get Get

get

Get tax rate

Path parameters
rateIdstringRequired

(Required)

Example: <integer>
Responses
200

OK

application/json
Responseobject
get
GET /V1/taxRates/{rateId} HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "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>"
}

tax Tax Rate Repository V1Delete By Id Delete

delete

Delete tax rate

Path parameters
rateIdstringRequired

(Required)

Example: <integer>
Responses
200

OK

application/json
Responseobject
delete
DELETE /V1/taxRates/{rateId} HTTP/1.1
Host: {{baseurl}}
Accept: */*
true

tax Tax Rate Repository V1Save Post

post

Create or update tax rate

Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"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
200

OK

application/json
Responseobject
post
POST /V1/taxRates HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 443

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

tax Tax Rate Repository V1Save Put

put

Create or update tax rate

Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"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
200

OK

application/json
Responseobject
put
PUT /V1/taxRates HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 443

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