Znode

Build Version:

GET shippingtypes

Gets a list of shipping types.

Request Information

» Filters

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

» Sorting

Name Description Usage
className This will sort the response by class name. GET shippingtypes?sort=classname
name This will sort the response by name. GET shippingtypes?sort=name
shippingTypeId This will sort the response by shipping type ID. GET shippingtypes?sort=shippingtypeid

» Paging

Name Description Usage
index The index to retrieve when requesting paged results. GET shippingtypes?page=index~{value}
size The size of the page when retrieving paged results. GET shippingtypes?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:
	{
  "ShippingTypes": [
    {
      "ClassName": "ZnodeShippingFedEx",
      "Description": "Calculates shipping rates when using FedEx.",
      "IsActive": true,
      "Name": "FedEx",
      "ShippingTypeId": 1
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}