API ReferenceReturns

List Returns

Returns a paginated list of returns for the authenticated business. Optionally filter by status or purchase order.

Requires scope: returns:read

Authentication

API_KEYstring
API Key authentication via header

Query parameters

pageintegerOptional

Zero-based page index. Defaults to 0.

sizeintegerOptional

Items per page. Defaults to 20, maximum 100.

statusenumOptional
Filter by return status.
Allowed values:
purchaseOrderIdUUIDOptional
Filter by purchase order ID.
sortstringOptional

Sort by field,direction (Spring Pageable format; direction asc or desc, default asc). Allowed fields: id, returnNumber, status, trackingNumber, note, returnDate, createdAt, updatedAt. Default order (when no sort is supplied): createdAt,desc.

Response

This endpoint returns an object.
datalist of objects
paginationobject
Pagination metadata returned on all list endpoints.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error