Skip to content

List Returns

Retrieve the authenticated customer's own return (RMA) requests, newest first. Requests are always scoped to the logged-in customer — a customer can never see another customer's returns. The detail-only action flags (canClose, canReopen, isExpired) and the images array come back null on the listing — fetch a single return to get them.

Endpoint

GET /api/shop/returns

Authentication

This endpoint requires an authenticated customer — send the storefront key and a customer Bearer token. See the Authentication page.

Request Headers

HeaderRequiredDescription
Content-TypeYesapplication/json
X-STOREFRONT-KEYYesYour storefront API key
AuthorizationYesBearer token (customer login required)

Query Parameters

ParameterTypeRequiredDescription
statusintegerNoFilter by return status id.

Response Fields (200 OK)

The response is a plain JSON array. Each item is a return object.

FieldTypeDescription
idintegerReturn ID.
orderIdintegerId of the order the item belongs to.
orderIncrementIdstringHuman-readable order number.
statusIdintegerNumeric status id.
statusTitlestringStatus label, e.g. Pending.
statusColorstringHex color for the status badge.
packageConditionstringReported package condition, e.g. opened.
informationstringFree-text note supplied when the return was raised.
canClosebooleanWhether the return can be closed. null on the listing.
canReopenbooleanWhether the return can be reopened. null on the listing.
isExpiredbooleanWhether the return is past its action window. null on the listing.
itemobjectThe returned item — id, order_item_id, sku, name, quantity, resolution, reason_id, reason, variant_id.
imagesarrayAttached images (id, path, url). null on the listing.
messagesCountintegerNumber of conversation messages on the return.
createdAtstringISO 8601 creation timestamp.
updatedAtstringISO 8601 last update timestamp.

Status Codes

StatusMeaning
200 OKReturns retrieved.
401 UnauthorizedMissing or invalid customer Bearer token.
403 ForbiddenMissing or invalid storefront key.

Released under the MIT License.