Update Status (GraphQL)

Moves an RMA request to a new status. Pass a status id taken from the request's availableStatuses (see View Return).

Action semantics

Two statuses do more than change the label:

• Received package (rmaStatusId = 5) — creates a refund for the returned item. Send a shipping amount to include shipping in the refund; omit or send 0 to refund the item only.
• Item canceled (rmaStatusId = 8) — cancels the order item and restores its inventory.

Any other status just updates the status. Every status change adds a note to the conversation and notifies the customer.

Input

Field	Type	Required	Description
id	ID	yes	The return IRI (/api/admin/rma/requests/{id}).
rmaStatusId	Int	yes	The next status id (one of the request's availableStatuses).
shipping	Float	no	Shipping amount to include when the status creates a refund. Defaults to 0.

TIP

See the Returns overview for the full status workflow.

Permission: sales.rma.requests.

All admin operations require an admin Bearer token — see Authentication.