Customer Return
List the conversation messages of a return request
Changed onMessages on the RMA named by ?return_id=, newest first. Requires the RMA to belong to the authenticated customer.
get/return-messages
Request
- Base URLhttp://localhost:8000/api/shop
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
return_idinteger required
Return (RMA) id
limitinteger
Example:5
Messages per page, as the storefront's limit. Omit it to get every message.
pageinteger
Example:1
Page number when limit is sent.
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 RMA conversation messages, newest first.
Changes
- info
added the new optional
queryrequest parameterlimit - info
added the new optional
queryrequest parameterpage
- info