Customer Return

Get one of the customer's return (RMA) requests

Full detail of a single RMA owned by the authenticated customer — the returned item, images, status, and action flags (canClose / canReopen / isExpired). item.product_image is the returned product's image, or the store's product placeholder when it has none; images are the photos the customer attached. 404 if it is not the customer's.

get/returns/{id}

Request

Base URL
http://localhost:8000/api/shop
Auth
HTTP bearer
TypeScript
https://skmtc.dev/bagisto/apis/bagisto-shop-api/docs/returns/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Customer return ID

Headers

X-STOREFRONT-KEYstring required

Storefront API Key for authentication. Required for all shop/storefront API requests.

X-Localestring

Example:en

Locale code for localized data (e.g. "en", "fr", "ar"). Defaults to channel's default locale.

X-Channelstring

Example:default

Channel code (e.g. "default"). Defaults to the current channel.

X-Currencystring

Example:USD

Currency code (e.g. "USD", "EUR", "INR"). Defaults to channel's base currency.

Response

The return request detail.

Changes

No recorded changes to this operation across all 13 revisions of this API.