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.