Skip to content
Saleor
Esc
↑↓navigate↵open⌘Jpreview

Schema: Saleor 3.23.43Download SDLUpgrade guides

On this page

OrderGrantRefundCreateInput Input Type

input OrderGrantRefundCreateInput {
  amount: Decimal
  reason: String
  reasonReference: ID
  lines: [OrderGrantRefundCreateLineInput!]
  grantRefundForShipping: Boolean
  transactionId: ID!
}

Fields

amount

amount · Decimal

Amount of the granted refund. If not provided, the amount will be calculated automatically based on provided lines and grantRefundForShipping.

reason

reason · String

Reason of the granted refund.

reasonReference

reasonReference · ID

ID of a Page (Model) to reference in reason.

Added in Saleor 3.22

lines

lines · [OrderGrantRefundCreateLineInput!]

Lines to assign to granted refund.

grantRefundForShipping

grantRefundForShipping · Boolean

Determine if granted refund should include shipping costs.

transactionId

transactionId · ID!

The ID of the transaction item related to the granted refund. If amount provided in the input, the transaction.chargedAmount needs to be equal or greater than provided amount.If amount is not provided in the input and calculated automatically by Saleor, the min(calculatedAmount, transaction.chargedAmount) will be used. Field required starting from Saleor 3.21.

Added in Saleor 3.20

Used by


Schema: Saleor 3.23.43. Download SDL.

Last updated on April 13, 2026

Was this page helpful?