GET v1/SalesReturn?pageNumber={pageNumber}&pageSize={pageSize}&status={status}&createdFrom={createdFrom}&createdTo={createdTo}&modifiedFrom={modifiedFrom}&modifiedTo={modifiedTo}&returnNumber={returnNumber}
This method gets a paged list of sales returns including sales return line data
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 |
| status |
Filter the list to returns with a particular status value |
integer |
Optional |
| createdFrom |
Filter the list to returns created after a certain date-time (assumed to be in the time-zone configured on the organisation's Tradevine account) |
date |
Optional |
| createdTo |
Filter the list to returns created before a certain date-time (assumed to be in the time-zone configured on the organisation's Tradevine account) |
date |
Optional |
| modifiedFrom |
Filter the list to returns modified after a certain date-time (assumed to be in the time-zone configured on the organisation's Tradevine account) |
date |
Optional |
| modifiedTo |
Filter the list to returns modified before a certain date-time (assumed to be in the time-zone configured on the organisation's Tradevine account) |
date |
Optional |
| returnNumber |
Filter the list to a single returns with the matching return number e.g. SR3221 |
string |
Optional |
Body Parameters
None.
Response Information
Resource Description
A list of sales return data from the Tradevine database
IPagedCollection (of SalesReturn)
| 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 SalesReturn |
Response Formats
application/json
Sample:
Sample not available.