Customer Return

List the active custom fields of the return form

Changed on

The additional fields the storefront return form renders. Answer them with customAttributes when creating a return, keyed by the field id. Fields with isRequired: true must be answered; select/radio answers must be one of the option values, multiselect/checkbox answers a list of them.

get/return-custom-fields

Request

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 custom fields, in the order the storefront renders them.

Changes