Build Version:

GET shippingrules

Gets a list of shipping rules.

Request Information

» Expands

Name	Description	Usage
shippingOption	This will retrieve the latest shipping option.	GET shippingrules?expand=shippingoption
shippingRuleType	This will retrieve the related shipping rule type.	GET shippingrules?expand=shippingruletype

» Filters

Name	Description	Usage
externalId	This will filter the request by external ID.	GET shippingrules?filter=externalid~{operator}~{value}
shippingOptionId	This will filter the request by shipping option ID.	GET shippingrules?filter=shippingoptionid~{operator}~{value}
shippingRuleTypeId	This will filter the request by shipping rule type ID.	GET shippingrules?filter=shippingruletypeid~{operator}~{value}

» Sorting

Name	Description	Usage
baseCost	This will sort the response by base cost.	GET shippingrules?sort=basecost
perItemCost	This will sort the response by per item cost.	GET shippingrules?sort=peritemcost
shippingRuleId	This will sort the response by shipping rule ID.	GET shippingrules?sort=shippingruleid

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET shippingrules?page=index~{value}
size	The size of the page when retrieving paged results.	GET shippingrules?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.

application/json

Sample:

	{
  "ShippingRules": [
    {
      "BaseCost": 5.00,
      "ClassName": null,
      "Custom1": "",
      "Custom2": "",
      "Custom3": "",
      "ExternalId": null,
      "errorMessage": null,
      "LowerLimit": 1.00,
      "PerItemCost": 2.25,
      "ShippingOption": {
        "CountryCode": "US",
        "Description": "Custom Flat Rate",
        "CustomErrorMessage": null,
        "DisplayOrder": 1,
        "ExternalId": null,
        "HandlingCharge": 2.50,
        "ActiveInd": true,
        "ProfileId": 7,
        "ShippingCode": "FLAT",
        "ShippingId": 9,
        "PortalId": 0,
        "ShippingType": null,
        "ShippingTypeId": 1,
        "ShippingRule": null,
        "ShippingServiceCodeId": 0,
        "ShippingServiceCode": null,
        "ShippingtypeName": null,
        "ProfileName": null,
        "ClassName": null,
        "UserType": null,
        "IsFreeShipping": false
      },
      "ShippingOptionId": 9,
      "ShippingRuleId": 1,
      "ShippingRuleType": {
        "ClassName": null,
        "Description": "Quantity-Based Rate",
        "IsActive": true,
        "Name": "Quantity-Based Rate",
        "ShippingRuleTypeId": 1
      },
      "ShippingRuleTypeId": 0,
      "UpperLimit": 2.00
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}