Search

tax Tax Class Repository V1Get List Get

get

Retrieve tax classes which match a specific criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxClassRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

Query parameters
searchCriteria[filterGroups][0][filters][0][field]stringOptional

Field

Example: <string>
searchCriteria[filterGroups][0][filters][0][value]stringOptional

Value

Example: <string>
searchCriteria[filterGroups][0][filters][0][conditionType]stringOptional

Condition type

Example: <string>
searchCriteria[sortOrders][0][field]stringOptional

Sorting field.

Example: <string>
searchCriteria[sortOrders][0][direction]stringOptional

Sorting direction.

Example: <string>
searchCriteria[pageSize]stringOptional

Page size.

Example: <integer>
searchCriteria[currentPage]stringOptional

Current page.

Example: <integer>
Responses
200

OK

application/json
Responseobject
get
GET /V1/taxClasses/search HTTP/1.1
Host: {{baseurl}}
Accept: */*

{
  "items": [
    {
      "class_name": "<string>",
      "class_type": "<string>",
      "class_id": "<integer>",
      "extension_attributes": "<object>"
    },
    {
      "class_name": "<string>",
      "class_type": "<string>",
      "class_id": "<integer>",
      "extension_attributes": "<object>"
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "tempor mollit",
            "value": "exercitation nostrud dolore occaecat",
            "condition_type": "dolore amet in qui voluptate"
          },
          {
            "field": "sunt dolore incididunt fugia",
            "value": "ipsum nulla",
            "condition_type": "in cillum nostrud laboris"
          }
        ]
      },
      {
        "filters": [
          {
            "field": "occaecat id do amet eu",
            "value": "Ut dolo",
            "condition_type": "aute"
          },
          {
            "field": "minim eiusmod in aliqua ut",
            "value": "amet dolore fugiat",
            "condition_type": "proident"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "quis irure cupidatat",
        "direction": "deserunt aute do"
      },
      {
        "field": "dolore Duis cillum eiusmo",
        "direction": "amet"
      }
    ],
    "page_size": -85093059,
    "current_page": 64487489
  },
  "total_count": -46176740
}
PreviousTaxClassesNextSalesRules