Customer Return
List active return reasons for a resolution type
Reasons a customer can pick when raising a return, filtered by ?resolution_type=return|cancel_items. Use these ids as rmaReasonId when creating a return.
get/return-reasons
Request
- Base URLhttp://localhost:8000/api/shop
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
resolution_type'return' | 'cancel_items' required
return | cancel_items
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
Active reasons for the resolution type. Use an id as rmaReasonId when creating a return.
Changes
No recorded changes to this operation across all 13 revisions of this API.