Skip to main content
POST
Approve a return request

Authorizations

Authorization
string
header
required

Sign in to the admin dashboard and use the resulting ID token for a store and operation you can access. The authenticated dashboard cookie is accepted when the Authorization header is absent. Missing or insufficient access returns 401.

Path Parameters

return_number
string
required
Maximum string length: 255

Body

application/json

Approve a created return. Refund value uses original item prices less prorated coupon and promotion discounts, with tax applied to the discounted amount. The returned share of redeemed loyalty points is refunded as points; only the remainder is cash. Each share is capped by its remaining refundable balance. Partial-return points use cumulative whole-point rounding so the final return retains the residual share. Replacement approval does not create a replacement order.

resolution
enum<string>
required
Available options:
refund,
replacement
pickup_required
boolean
required
refund_mode
enum<string> | null

Required and non-null when the return has a cash refund, subject to the order's available refund modes. Optional for points-only returns, which use loyalty-point refunds without bank details. Cleared for replacement or credit-line refund approval.

Available options:
original-payment-mode,
bank-transfer,
null
bank_account_id
string | null

Required for bank-transfer mode or a bank-transfer allocation/eligible paid leg. Must identify a verified outbound account for the order customer/user. Blank is accepted at field level; cleared when unnecessary.

Response

OK

message
string
required
Example:

"Return request approved successfully."

success
boolean
required
content
object
required