BAbagisto
Customer Return

List the orders a return can still be raised against

Changed on

The authenticated customer's orders that can start a return — the set the storefront shows first in the New Request flow. An order appears while it holds at least one item that was placed with returns allowed, is inside its return window, and has quantity left after everything already returned. Canceled, closed, fraud and pending-payment orders never appear. Pick an order from here, then call /returnable-items?order_id= for the items and their quantity caps.

get/returnable-orders

Request

Query parameters

increment_idstring

Filter by order number (partial match).

statusstring

Filter by order status.

sortstring

Sort column — created_at (default), increment_id or grand_total.

orderstring

Sort direction — desc (default) or asc.

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

Orders eligible for a new return.

Changes