Customer Return

List the return-eligible items of one of the customer's orders

Items from the order named by ?order_id= that are still within their return window and not already fully returned/canceled. Each row carries the trusted quantity caps (forReturnQuantity, forCancelQuantity, currentQuantity) the create endpoint enforces. Requires the order to belong to the authenticated customer.

get/returnable-items

Request

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

Query parameters

order_idinteger required

Order id to list returnable items for

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-eligible items of the order, with server-enforced quantity caps.

Changes

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