GET
/
api
/
v2
/
platform
/
tax_rates
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/tax_rates \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "12",
      "type": "tax_rate",
      "attributes": {
        "amount": "0.1",
        "included_in_price": false,
        "created_at": "2022-11-08T19:35:44.070Z",
        "updated_at": "2022-11-08T19:35:44.070Z",
        "name": "TaxRate - 903896",
        "show_rate_in_label": true,
        "deleted_at": null,
        "public_metadata": {},
        "private_metadata": {}
      },
      "relationships": {
        "zone": {
          "data": {
            "id": "99",
            "type": "zone"
          }
        },
        "tax_category": {
          "data": {
            "id": "165",
            "type": "tax_category"
          }
        }
      }
    },
    {
      "id": "13",
      "type": "tax_rate",
      "attributes": {
        "amount": "0.1",
        "included_in_price": false,
        "created_at": "2022-11-08T19:35:44.073Z",
        "updated_at": "2022-11-08T19:35:44.073Z",
        "name": "TaxRate - 477775",
        "show_rate_in_label": true,
        "deleted_at": null,
        "public_metadata": {},
        "private_metadata": {}
      },
      "relationships": {
        "zone": {
          "data": {
            "id": "100",
            "type": "zone"
          }
        },
        "tax_category": {
          "data": {
            "id": "165",
            "type": "tax_category"
          }
        }
      }
    }
  ],
  "meta": {
    "count": 2,
    "total_count": 2,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/tax_rates?page=1&per_page=&include=&filter[zone_id_eq]=&filter[amount_gt]=&filter[tax_category_id_eq]=",
    "next": "http://www.example.com/api/v2/platform/tax_rates?filter%5Bamount_gt%5D=&filter%5Btax_category_id_eq%5D=&filter%5Bzone_id_eq%5D=&include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/tax_rates?filter%5Bamount_gt%5D=&filter%5Btax_category_id_eq%5D=&filter%5Bzone_id_eq%5D=&include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/tax_rates?filter%5Bamount_gt%5D=&filter%5Btax_category_id_eq%5D=&filter%5Bzone_id_eq%5D=&include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/tax_rates?filter%5Bamount_gt%5D=&filter%5Btax_category_id_eq%5D=&filter%5Bzone_id_eq%5D=&include=&page=1&per_page="
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
per_page
integer
include
string

Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

filter[zone_id_eq]
string
filter[amount_gt]
string
filter[tax_category_id_eq]
string

Response

200
application/vnd.api+json
Records returned
data
object[]
required
meta
object
required