listReturns

Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.

Query Params
string

The SmartConnect location ID of the location from which you want to retrieve return items.

string

The RMA ID of the return items you want to list.

string
enum

The status of return items you want to list. You can retrieve all new return items with the CREATED status.

string

The reverse tracking ID of the return items you want to list.

date-time

Return items created after the specified date are included in the response. In ISO 8601 date-time format.

date-time

Return items created before the specified date are included in the response. In ISO 8601 date-time format.

date-time

Return items updated after the specified date are included in the response. In ISO 8601 date-time format. If you supply this parameter, you must also supply returnLocationId and status.

date-time

Return items whose most recent update is before the specified date are included in the response. In ISO 8601 date-time format. If you supply this parameter, you must also supply returnLocationId and status.

date-time

DEPRECATED. Use the createdSince parameter.

date-time

DEPRECATED. Use the createdUntil parameter.

int64
≤ 100

The number of return items you want to include in the response.

Default: 10

Maximum: 100

string

A token that you use to retrieve the next page of results. The response includes nextToken when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextToken is null. Note that this operation can return empty pages.

Responses

Language
Response
Choose an example:
application/json