Skip to content

View Return

Retrieve a single return (RMA) request owned by the authenticated customer, with the full detail — the returned item, attached images, status and the action flags (canClose, canReopen, isExpired). If the return does not exist or belongs to a different customer, the endpoint returns HTTP 404.

Endpoint

GET /api/shop/returns/{id}

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)

Path Parameters

ParameterTypeRequiredDescription
idintegerYesId of the return to view. Must belong to the authenticated customer.

Response Fields (200 OK)

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.
informationstringFree-text note supplied when the return was raised.
canClosebooleanWhether the return can be closed (marked solved).
canReopenbooleanWhether the return can be reopened back to pending.
isExpiredbooleanWhether the return is past its action window.
itemobjectThe returned item (see below).
item.idintegerId of the return item row.
item.order_item_idintegerId of the source order item.
item.skustringProduct SKU.
item.namestringProduct name.
item.quantityintegerQuantity being returned/canceled.
item.resolutionstringResolution type: return or cancel_items.
item.reason_idintegerId of the chosen return reason.
item.reasonstringTitle of the chosen return reason.
item.variant_idintegerVariant id for a configurable product, or null.
imagesarrayAttached images.
images[].idintegerImage id.
images[].pathstringStored file path.
images[].urlstringPublic URL of the image.
messagesCountintegerNumber of conversation messages on the return.
createdAtstringISO 8601 creation timestamp.
updatedAtstringISO 8601 last update timestamp.

Status Codes

StatusMeaning
200 OKReturn retrieved.
401 UnauthorizedMissing or invalid customer Bearer token.
403 ForbiddenMissing or invalid storefront key.
404 Not FoundThe return does not exist or is not the customer's.

Released under the MIT License.