RefundInput

Specifies the fields to create a refund.

Show definition

# Specifies the fields to create a refund.
input RefundInput {
  # Order ID for which the refund is created.
  orderId: ID!

# Whether to add the line items back to the store's inventory. restock: Boolean

# An optional note attached to a refund. note: String

# Whether to send a refund notification to the customer. notify: Boolean

# Specifies how much of the shipping cost to refund. shipping: ShippingRefundInput

# A list of line items to refund. refundLineItems: [RefundLineItemInput!]

# A list of transactions involved in the refund. transactions: [OrderTransactionInput!] }

Input Fields

note   (String)

An optional note attached to a refund.

notify   (Boolean)

Whether to send a refund notification to the customer.

orderId   (ID!)

Required

Order ID for which the refund is created.

refundLineItems   ([RefundLineItemInput!])

A list of line items to refund.

restock   (Boolean)

Whether to add the line items back to the store's inventory.

shipping   (ShippingRefundInput)

Specifies how much of the shipping cost to refund.

transactions   ([OrderTransactionInput!])

A list of transactions involved in the refund.

Sign up for a Partner account to get started.

Sign up