Returns > Returns > returnsRefund
Commerce APIReturnsReturnsreturnsRefund
returnsRefund
POST:returns/refund.json

Description

Refund a return.

Permission bit: "returns.modify"

Topic: Returns

Arguments

data: ReturnRefund!

Main argument for mutations.


return_id: String!

Unique return identifier. See also: Unique Identifiers

Example: "rt_EQzGqWoY"


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

amount: Int!

Refund amount (doesn't include fee and customer balance portion)

Valid when: amount is a non-negative integer


customer_balance: Int!

How much to refund to customer balance

Valid when: customer_balance is a non-negative integer


fee: Int!

Refund fee

Valid when: fee is a non-negative integer


Result

Return

Preview (typescript)

Loading module