Build Version:
GET shippingoptions/listbyprofileids
No documentation available.
Request Information
» Parameters
| Name | Description | Additional information |
|---|---|---|
| model | No documentation available. |
Define this parameter in the request body. |
» Filters
| Name | Description | Usage |
|---|---|---|
| countryCode | This will filter the request by country code. | GET shippingoptions/listbyprofileids?filter=countrycode~{operator}~{value} |
| externalId | This will filter the request by external ID. | GET shippingoptions/listbyprofileids?filter=externalid~{operator}~{value} |
| isActive | This will filter the request by the is active flag. | GET shippingoptions/listbyprofileids?filter=isactive~{operator}~{value} |
| profileId | This will filter the request by profile ID. | GET shippingoptions/listbyprofileids?filter=profileid~{operator}~{value} |
| shippingCode | This will filter the request by shipping code. | GET shippingoptions/listbyprofileids?filter=shippingcode~{operator}~{value} |
| shippingTypeId | This will filter the request by shipping type ID. | GET shippingoptions/listbyprofileids?filter=shippingtypeid~{operator}~{value} |
» Sorting
| Name | Description | Usage |
|---|---|---|
| countryCode | This will sort the response by country code. | GET shippingoptions/listbyprofileids?sort=countrycode |
| description | This will sort the response by description. | GET shippingoptions/listbyprofileids?sort=description |
| displayOrder | This will sort the response by display order. | GET shippingoptions/listbyprofileids?sort=displayorder |
| shippingCode | This will sort the response by shipping code. | GET shippingoptions/listbyprofileids?sort=shippingcode |
| shippingOptionId | This will sort the response by shipping option ID. | GET shippingoptions/listbyprofileids?sort=shippingoptionid |
» Paging
| Name | Description | Usage |
|---|---|---|
| index | The index to retrieve when requesting paged results. | GET shippingoptions/listbyprofileids?page=index~{value} |
| size | The size of the page when retrieving paged results. | GET shippingoptions/listbyprofileids?page=size~{value} |
Request Body Formats
Sample:
{
"Ids": "sample string 1"
}