Admin Sales: RMA

Create an RMA request for a customer order

Admin-side return creation for any order. rmaQty is capped server-side by the item's returnable/cancelable quantity. Optional image files via multipart images[] (REST only). Returns the created RMA. Permission: sales.rma.requests.create.

post/rma/requests

Request

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

Request body

order_idinteger required

order_item_idinteger required

rma_qtyinteger required

resolution_type'return' | 'cancel_items' required

rma_reason_idinteger required

informationstring

package_conditionstring

Example request

{
  "order_id": 12,
  "order_item_id": 45,
  "rma_qty": 1,
  "resolution_type": "return",
  "rma_reason_id": 2,
  "information": "Customer reported a defect.",
  "package_condition": "opened"
}

Response

The created return request.

Changes

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