GET v1/ShippingTemplate?pageNumber={pageNumber}&pageSize={pageSize}&textExactMatch={textExactMatch}&name={name}
This method gets a paged list of shipping templates.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| pageNumber |
The page number for the list you wish to retrieve |
integer |
Optional Must be greater than 1 Default value is 1 if not specified |
| pageSize |
The page size for the list you wish to retrieve |
integer |
Optional Must be greater than 1 and less than 500 Default value is 500 if not specified |
| textExactMatch |
Whether to search for exact text matches only. The default is to use wildcard/partial matches |
boolean |
Optional |
| name |
Name of the shipping template |
string |
Optional |
Body Parameters
None.
Response Information
Resource Description
A paged list of shipping templates
IPagedCollection (of ShippingTemplate)
| Name | Description | Type |
|---|---|---|
| TotalCount |
The total number of records in the resultset including those returned on this page |
integer |
| PageNumber |
The page number of the current resultset |
integer |
| PageSize |
The page size of the current resultset |
integer |
| List |
The list of records in this page of the resultset |
Collection of ShippingTemplate |
Response Formats
application/json
Sample:
{
"TotalCount": 1440,
"PageNumber": 1,
"PageSize": 10,
"List": [
{
"ShippingTemplateID": null,
"OrganisationID": 3451460443781171981,
"Name": "Shipping template 1",
"ShippingTemplateOptions": [
{
"ShippingTemplateOptionID": 3451460443781171982,
"Cost": 15.0,
"Name": "Courier",
"ShippingType": 25003
},
{
"ShippingTemplateOptionID": 3451460443781171984,
"Cost": 5.0,
"Name": "Post",
"ShippingType": 25002
}
]
}
]
}