Refund object
Represents a refund of items or transactions in an order.
Required access
read_orders
access scope.
On this page
Connections
-
orderAdjustments (
OrderAdjustmentConnection!
)Order adjustments associated with the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
refundLineItems (
RefundLineItemConnection!
)The RefundLineItem resources attached to the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
transactions (
OrderTransactionConnection!
)Transactions associated with the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
createdAt (
DateTime
)When the refund was created.
-
duties (
[RefundDuty!]
)List of the order's refunded duties.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
note (
String
)Note associated with the refund.
-
order (
Order!
)The order associated with the refund.
-
totalRefundedSet (
MoneyBag!
)Total amount refunded across all the transactions for this refund in shop and presentment currencies.
-
updatedAt (
DateTime!
)When the refund was last updated.
Types that return Refund
Mutations for Refund
-
Creates a refund.
Implements
Deprecated fields
-
totalRefunded (
MoneyV2!
) deprecatedTotal amount refunded across all the transactions for this refund.
Deprecation warning
Use
totalRefundedSet
instead
Represents a refund of items or transactions in an order.
Required access
read_orders
access scope.
On this page
Connections
-
refundLineItems (
RefundLineItemConnection!
)The RefundLineItem resources attached to the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
transactions (
OrderTransactionConnection!
)Transactions associated with the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
createdAt (
DateTime
)When the refund was created.
-
duties (
[RefundDuty!]
)List of the order's refunded duties.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
note (
String
)Note associated with the refund.
-
order (
Order!
)The order associated with the refund.
-
totalRefundedSet (
MoneyBag!
)Total amount refunded across all the transactions for this refund in shop and presentment currencies.
-
updatedAt (
DateTime!
)When the refund was last updated.
Types that return Refund
Mutations for Refund
-
Creates a refund.
Implements
Deprecated fields
-
totalRefunded (
MoneyV2!
) deprecatedTotal amount refunded across all the transactions for this refund.
Deprecation warning
Use
totalRefundedSet
instead
Represents a refund of items or transactions in an order.
Required access
read_orders
access scope.
On this page
Connections
-
refundLineItems (
RefundLineItemConnection!
)The RefundLineItem resources attached to the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
transactions (
OrderTransactionConnection!
)Transactions associated with the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
createdAt (
DateTime
)When the refund was created.
-
duties (
[RefundDuty!]
)List of the order's refunded duties.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
note (
String
)Note associated with the refund.
-
order (
Order!
)The order associated with the refund.
-
totalRefundedSet (
MoneyBag!
)Total amount refunded across all the transactions for this refund in shop and presentment currencies.
-
updatedAt (
DateTime!
)When the refund was last updated.
Types that return Refund
Mutations for Refund
-
Creates a refund.
Implements
Deprecated fields
-
totalRefunded (
MoneyV2!
) deprecatedTotal amount refunded across all the transactions for this refund.
Deprecation warning
Use
totalRefundedSet
instead
Represents a refund of items or transactions in an order.
Required access
read_orders
access scope.
On this page
Connections
-
refundLineItems (
RefundLineItemConnection!
)The RefundLineItem resources attached to the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
transactions (
OrderTransactionConnection!
)Transactions associated with the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
createdAt (
DateTime
)When the refund was created.
-
duties (
[RefundDuty!]
)List of the order's refunded duties.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
note (
String
)Note associated with the refund.
-
order (
Order!
)The order associated with the refund.
-
totalRefundedSet (
MoneyBag!
)Total amount refunded across all the transactions for this refund in shop and presentment currencies.
-
updatedAt (
DateTime!
)When the refund was last updated.
Types that return Refund
Mutations for Refund
-
Creates a refund.
Implements
Deprecated fields
-
totalRefunded (
MoneyV2!
) deprecatedTotal amount refunded across all the transactions for this refund.
Deprecation warning
Use
totalRefundedSet
instead
Represents a refund of items or transactions in an order.
Required access
read_orders
access scope.
On this page
Connections
-
refundLineItems (
RefundLineItemConnection!
)The RefundLineItem resources attached to the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
transactions (
OrderTransactionConnection!
)Transactions associated with the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
createdAt (
DateTime
)When the refund was created.
-
duties (
[RefundDuty!]
)List of the order's refunded duties.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
note (
String
)Note associated with the refund.
-
totalRefundedSet (
MoneyBag!
)Total amount refunded across all the transactions for this refund in shop and presentment currencies.
-
updatedAt (
DateTime!
)When the refund was last updated.
Types that return Refund
Mutations for Refund
-
Creates a refund.
Implements
Deprecated fields
-
restocked (
Boolean!
) deprecatedWhether the RefundLineItem resources were restocked when the refund was created.
Deprecation warning
Use
RefundLineItem.restockType
instead. -
totalRefunded (
MoneyV2!
) deprecatedTotal amount refunded across all the transactions for this refund.
Deprecation warning
Use
totalRefundedSet
instead
Represents a refund of items or transactions in an order.
Required access
read_orders
access scope.
On this page
Connections
-
refundLineItems (
RefundLineItemConnection!
)The RefundLineItem resources attached to the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
transactions (
OrderTransactionConnection!
)Transactions associated with the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
createdAt (
DateTime
)When the refund was created.
-
duties (
[RefundDuty!]
)List of the order's refunded duties.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
note (
String
)Note associated with the refund.
-
totalRefundedSet (
MoneyBag!
)Total amount refunded across all the transactions for this refund in shop and presentment currencies.
-
updatedAt (
DateTime!
)When the refund was last updated.
Types that return Refund
Mutations for Refund
-
Creates a refund.
Implements
Deprecated fields
-
restocked (
Boolean!
) deprecatedWhether the RefundLineItem resources were restocked when the refund was created.
Deprecation warning
Use
RefundLineItem.restockType
instead. -
totalRefunded (
MoneyV2!
) deprecatedTotal amount refunded across all the transactions for this refund.
Deprecation warning
Use
totalRefundedSet
instead
Represents a refund of items or transactions in an order.
Required access
read_orders
access scope.
On this page
Connections
-
refundLineItems (
RefundLineItemConnection!
)The RefundLineItem resources attached to the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
transactions (
OrderTransactionConnection!
)Transactions associated with the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
createdAt (
DateTime
)When the refund was created.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
note (
String
)Note associated with the refund.
-
totalRefundedSet (
MoneyBag!
)Total amount refunded across all the transactions for this refund in shop and presentment currencies.
-
updatedAt (
DateTime!
)When the refund was last updated.
Types that return Refund
Mutations for Refund
-
Creates a refund.
Implements
Deprecated fields
-
restocked (
Boolean!
) deprecatedWhether the RefundLineItem resources were restocked when the refund was created.
Deprecation warning
Use
RefundLineItem.restockType
instead. -
totalRefunded (
MoneyV2!
) deprecatedTotal amount refunded across all the transactions for this refund.
Deprecation warning
Use
totalRefundedSet
instead
Represents a refund of items or transactions in an order.
Required access
read_orders
access scope.
On this page
Connections
-
refundLineItems (
RefundLineItemConnection!
)The RefundLineItem resources attached to the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
transactions (
OrderTransactionConnection!
)Transactions associated with the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
createdAt (
DateTime
)When the refund was created.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
note (
String
)Note associated with the refund.
-
totalRefundedSet (
MoneyBag!
)Total amount refunded across all the transactions for this refund in shop and presentment currencies.
-
updatedAt (
DateTime!
)When the refund was last updated.
Types that return Refund
Mutations for Refund
-
Creates a refund.
Implements
Deprecated fields
-
restocked (
Boolean!
) deprecatedWhether the RefundLineItem resources were restocked when the refund was created.
Deprecation warning
Use
RefundLineItem.restockType
instead. -
totalRefunded (
MoneyV2!
) deprecatedTotal amount refunded across all the transactions for this refund.
Deprecation warning
Use
totalRefundedSet
instead
Represents a refund of items or transactions in an order.
Required access
read_orders
access scope.
On this page
Connections
-
refundLineItems (
RefundLineItemConnection!
)The RefundLineItem resources attached to the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
transactions (
OrderTransactionConnection!
)Transactions associated with the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
createdAt (
DateTime
)When the refund was created.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
note (
String
)Note associated with the refund.
-
totalRefundedSet (
MoneyBag!
)Total amount refunded across all the transactions for this refund in shop and presentment currencies.
-
updatedAt (
DateTime!
)When the refund was last updated.
Types that return Refund
Mutations for Refund
-
Creates a refund.
Implements
Deprecated fields
-
restocked (
Boolean!
) deprecatedWhether the RefundLineItem resources were restocked when the refund was created.
Deprecation warning
Use
RefundLineItem.restockType
instead. -
totalRefunded (
MoneyV2!
) deprecatedTotal amount refunded across all the transactions for this refund.
Deprecation warning
Use
totalRefundedSet
instead
Represents a refund of items or transactions in an order.
Required access
read_orders
access scope.
On this page
Connections
-
refundLineItems (
RefundLineItemConnection!
)The RefundLineItem resources attached to the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
-
transactions (
OrderTransactionConnection!
)Transactions associated with the refund.
Argument Description after
(String
)Returns the elements that come after the specified cursor.
before
(String
)Returns the elements that come before the specified cursor.
first
(Int
)Returns up to the first
n
elements from the list.last
(Int
)Returns up to the last
n
elements from the list.reverse
(Boolean
)Reverse the order of the underlying list.
Default value:false
Fields
-
createdAt (
DateTime
)When the refund was created.
-
id (
ID!
)Globally unique identifier.
-
legacyResourceId (
UnsignedInt64!
)The ID of the corresponding resource in the REST Admin API.
-
note (
String
)Note associated with the refund.
-
totalRefundedSet (
MoneyBag!
)Total amount refunded across all the transactions for this refund in shop and presentment currencies.
-
updatedAt (
DateTime!
)When the refund was last updated.
Types that return Refund
Mutations for Refund
-
Creates a refund.
Implements
Deprecated fields
-
restocked (
Boolean!
) deprecatedWhether the RefundLineItem resources were restocked when the refund was created.
Deprecation warning
Use
RefundLineItem.restockType
instead. -
totalRefunded (
MoneyV2!
) deprecatedTotal amount refunded across all the transactions for this refund.
Deprecation warning
Use
totalRefundedSet
instead