Znode

GET shippingservicecodes

Gets a list of shipping service codes.

Request Information

» Expands

Name Description Usage
shippingType This will retrieve the related shipping type. GET shippingservicecodes?expand=shippingtype

» Filters

Name Description Usage
code This will filter the request by code. GET shippingservicecodes?filter=code~{operator}~{value}
description This will filter the request by description. GET shippingservicecodes?filter=description~{operator}~{value}
isActive This will filter the request by the is active flag. GET shippingservicecodes?filter=isactive~{operator}~{value}
shippingTypeId This will filter the request by shipping type ID. GET shippingservicecodes?filter=shippingtypeid~{operator}~{value}

» Sorting

Name Description Usage
code This will sort the response by code. GET shippingservicecodes?sort=code
description This will sort the response by description. GET shippingservicecodes?sort=description
displayOrder This will sort the response by display order. GET shippingservicecodes?sort=displayorder
shippingServiceCodeId This will sort the response by shipping service code ID. GET shippingservicecodes?sort=shippingservicecodeid

» Paging

Name Description Usage
index The index to retrieve when requesting paged results. GET shippingservicecodes?page=index~{value}
size The size of the page when retrieving paged results. GET shippingservicecodes?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:
	{
  "ShippingServiceCodes": [
    {
      "Code": "FEDEX_GROUND",
      "Description": "FedEx Ground",
      "DisplayOrder": 9,
      "IsActive": true,
      "ShippingServiceCodeId": 19,
      "ShippingType": {
        "ClassName": "ZnodeShippingFedEx",
        "Description": "Calculates shipping rates when using FedEx.",
        "IsActive": true,
        "Name": "FedEx",
        "ShippingTypeId": 1
      },
      "ShippingTypeId": 2
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false
}