API ReferenceReturns

List Returns

Retrieves a paginated list of Return Merchandise Authorizations (RMAs) with various filtering options including pagination, sorting, and specific attributes such as status, last updated before, and standalone.

Headers

Impilo-API-KeystringRequired

Query parameters

statusenumOptional
Lists only returns with the provided status.
relatedOrderIdlongOptional
Lists only returns related to the provided order ID.
searchStringstringOptional
lastUpdatedBeforestringOptionalformat: "date"
standalonebooleanOptional
pageintegerOptionalDefaults to 1
sizeintegerOptionalDefaults to 15

Response

OK
contentlist of objects or null
The content of the page, consisting of a list of objects.
firstboolean or null
True if this is the first page, false otherwise.
lastboolean or null
True if this is the last page, false otherwise.
pageinteger or null
The current page number. The first page has value 1.
sizeinteger or null
The current page size. Default 15, maximum 250.
totalinteger or null
The number of objects matching the request.