Skip to main content

orderAddRefundMethod Mutation

Description​

Adds a refund method to an order. The refund amount is recorded in the order's payment methods. Refunds reduce the total paid amount for the order.

mutation orderAddRefundMethod(
$orderRef: ID!
$orderPaymentMethodInput: OrderPaymentMethodInput!
$refundViaProcessor: Boolean
$refundReason: RefundReason
$refundNote: String
) {
orderAddRefundMethod(
orderRef: $orderRef
orderPaymentMethodInput: $orderPaymentMethodInput
refundViaProcessor: $refundViaProcessor
refundReason: $refundReason
refundNote: $refundNote
) {
_id
id
incId
origin
created
modified
shipping {
status
fulfilled
date
method
freeShippingThreshold
tracking
shopCollection
weight
packingSlip
}
billing {
status
fulfilled
paymentDate
refundDate
}
orderId
notes {
date
content
}
instructions
totals {
subtotal
subtotalBeforeTaxes
tax
grand
leftToPay
itemQuantity
discount
shipping
creditNote
balance
}
items {
_id
quantity
unavailable
added
}
messages {
_id
created
subject
message
fromBuyer
flagged
archived
isSystem
content
read
orderId
orderIncId
uri
via
}
buyer {
_id
firstName
lastName
email
name
path
telephone
organisation
taxNumber
}
logs {
action
description
date
ip
}
seller {
type
name
email
ref
}
updated
status
discogsStatus
buyerWasContacted
unreadMessagesCount
mergeableOrders {
_id
id
created
total
description
}
path
}
}

Variables​

{
"orderRef": "8ceb95cffae40d850bdced93",
"orderPaymentMethodInput": {
"origin": "origin",
"amount": 29.99,
"ref": "dd142c5d16a85b0fe27a17c3",
"intentId": "intentId",
"added": 1790012793591
},
"refundViaProcessor": true,
"refundReason": "requested_by_customer",
"refundNote": "refundNote"
}

Response​

{
"orderAddRefundMethod": {
"_id": "f083d92fccdcf50d9cc836e4",
"id": "example",
"incId": 42,
"origin": "example",
"created": 1790655686039,
"modified": 1742550463452,
"shipping": {
"status": "Pending",
"fulfilled": true,
"date": 1781472187183,
"method": "example",
"freeShippingThreshold": 1.23,
"tracking": "example",
"shopCollection": true,
"weight": 1.23,
"packingSlip": "example"
},
"billing": {
"status": "example",
"fulfilled": true,
"paymentDate": 1756551809800,
"refundDate": 1792783593750
},
"orderId": "example",
"notes": [
{
"date": 1786354373393,
"content": "example"
}
],
"instructions": "example",
"totals": {
"subtotal": 1.23,
"subtotalBeforeTaxes": 1.23,
"tax": 1.23,
"grand": 1.23,
"leftToPay": 1.23,
"itemQuantity": 1.23,
"discount": 0.1,
"shipping": 1.23,
"creditNote": 1.23,
"balance": 1.23
},
"items": [
{
"_id": "0ee12119e5df69a45379b034",
"quantity": 1,
"unavailable": true,
"added": 1773800351907
}
],
"messages": [
{
"_id": "dbfe6c5ccc5cc603840716ef",
"created": 1739777064237,
"subject": "example",
"message": "example",
"fromBuyer": true,
"flagged": true,
"archived": true,
"isSystem": true,
"content": "example",
"read": true,
"orderId": "example",
"orderIncId": 42,
"uri": "https://www.my-common-ground-store.com/release/1763553751/release-artist-release-name",
"via": "example"
}
],
"buyer": {
"_id": "38126aa9383ca55b8e41eabd",
"firstName": "example",
"lastName": "example",
"email": "email@example.com",
"name": "example",
"path": "/release/1763553751/release-artist-release-name",
"telephone": "example",
"organisation": "example",
"taxNumber": "example"
},
"logs": [
{
"action": "example",
"description": "example",
"date": 1750090634468,
"ip": "example"
}
],
"seller": {
"type": "example",
"name": "example",
"email": "email@example.com",
"ref": "27168d479667d8e2dfff96ef"
},
"updated": 1756560410867,
"status": "example",
"discogsStatus": "example",
"buyerWasContacted": true,
"unreadMessagesCount": 42,
"mergeableOrders": [
{
"_id": "b247e6cdbd53ad9617881ba9",
"id": "example",
"created": 1776489910777,
"total": 29.99,
"description": "example"
}
],
"path": "/release/1763553751/release-artist-release-name"
}
}

Arguments​

NameTypeDescription
orderRefID!Reference ID of the order to add a refund method to.
orderPaymentMethodInputOrderPaymentMethodInput!Refund method details including origin, amount, optional reference, and date.
refundViaProcessorBooleanRefunds the amount to the buyer through the processor named by the input's origin ("stripe", "paypal"), from its most recent payment first, and records the processor's refunds rather than the input. A refund made this way can never be removed from the order.
refundReasonRefundReasonReason given with the refund made with refundViaProcessor. Stripe records it; PayPal has no reasons and ignores it.
refundNoteStringNote to the buyer with the refund made with refundViaProcessor, shown by PayPal (255 characters at most); Stripe keeps it in the refund's metadata.

Returns​

Order!