Znode

GET taxclasses

Gets a list of tax classes.

Request Information

» Filters

Name Description Usage
externalId This will filter the request by external ID. GET taxclasses?filter=externalid~{operator}~{value}
isActive This will filter the request by the is active flag. GET taxclasses?filter=isactive~{operator}~{value}
name This will filter the request by name. GET taxclasses?filter=name~{operator}~{value}
portalId This will filter the request by portal ID. GET taxclasses?filter=portalid~{operator}~{value}

» Sorting

Name Description Usage
displayOrder This will sort the response by display order. GET taxclasses?sort=displayorder
name This will sort the response by name. GET taxclasses?sort=name
taxClassId This will sort the response by tax class ID. GET taxclasses?sort=taxclassid

» Paging

Name Description Usage
index The index to retrieve when requesting paged results. GET taxclasses?page=index~{value}
size The size of the page when retrieving paged results. GET taxclasses?page=size~{value}

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

Sample:
	{
  "TaxClasses": [
    {
      "DisplayOrder": 1,
      "ExternalId": null,
      "ActiveInd": true,
      "Name": "Default",
      "PortalId": 7,
      "TaxClassId": 2,
      "StoreName": null,
      "CustomErrorMessage": null,
      "TaxRuleList": null
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false
}