GET shippingrules/{shippingRuleId}

Gets a shipping rule.

Request Information

» Parameters

Name Description Additional information
shippingRuleId The ID of the shipping rule.

Define this parameter in the request URI.

» Expands

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

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.

  "ShippingRule": {
    "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
    "ShippingOptionId": 9,
    "ShippingRuleId": 1,
    "ShippingRuleType": {
      "ClassName": null,
      "Description": "Quantity-Based Rate",
      "IsActive": true,
      "Name": "Quantity-Based Rate",
      "ShippingRuleTypeId": 1
    "ShippingRuleTypeId": 0,
    "UpperLimit": 2.00
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false