Znode

GET shippingruletypes

Gets a list of shipping rule types.

Request Information

» Filters

Name Description Usage
className This will filter the request by class name. GET shippingruletypes?filter=classname~{operator}~{value}
isActive This will filter the request by the is active flag. GET shippingruletypes?filter=isactive~{operator}~{value}
name This will filter the request by name. GET shippingruletypes?filter=name~{operator}~{value}

» Sorting

Name Description Usage
name This will sort the response by name. GET shippingruletypes?sort=name
shippingRuleTypeId This will sort the response by shipping rule type ID. GET shippingruletypes?sort=shippingruletypeid

» Paging

Name Description Usage
index The index to retrieve when requesting paged results. GET shippingruletypes?page=index~{value}
size The size of the page when retrieving paged results. GET shippingruletypes?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:
	{
  "ShippingRuleTypes": [
    {
      "ClassName": null,
      "Description": "Quantity-Based Rate",
      "IsActive": true,
      "Name": "Quantity-Based Rate",
      "ShippingRuleTypeId": 1
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false
}