orderCancel Mutation
Description
Cancels an order, optionally relisting stock, recording a note, a refund status and a Discogs cancellation reason for marketplace orders.
mutation orderCancel(
$orderRef: ID!
$note: String
$relist: Boolean
$discogsReason: String
$refundStatus: String
$refundAmount: Float
$refundOrigin: String
$refundViaProcessor: Boolean
$refundReason: RefundReason
$refundNote: String
) {
orderCancel(
orderRef: $orderRef
note: $note
relist: $relist
discogsReason: $discogsReason
refundStatus: $refundStatus
refundAmount: $refundAmount
refundOrigin: $refundOrigin
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": "89474efda3180006780c5250",
"note": "note",
"relist": true,
"discogsReason": "discogsReason",
"refundStatus": "refundStatus",
"refundAmount": 30.7,
"refundOrigin": "refundOrigin",
"refundViaProcessor": true,
"refundReason": "requested_by_customer",
"refundNote": "refundNote"
}
Response
{
"orderCancel": {
"_id": "39162f725a8dc987cff822a6",
"id": "example",
"incId": 42,
"origin": "example",
"created": 1769314192614,
"modified": 1739173285001,
"shipping": {
"status": "Pending",
"fulfilled": true,
"date": 1737566325785,
"method": "example",
"freeShippingThreshold": 1.23,
"tracking": "example",
"shopCollection": true,
"weight": 1.23,
"packingSlip": "example"
},
"billing": {
"status": "example",
"fulfilled": true,
"paymentDate": 1768240456043,
"refundDate": 1775660883188
},
"orderId": "example",
"notes": [
{
"date": 1752889533903,
"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": "27d8c8ec533d053cb41af061",
"quantity": 1,
"unavailable": true,
"added": 1786520544976
}
],
"messages": [
{
"_id": "b736675db02a066f91d834dd",
"created": 1779439166413,
"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": "63b6108b81e15d93c4712e1d",
"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": 1741614436870,
"ip": "example"
}
],
"seller": {
"type": "example",
"name": "example",
"email": "email@example.com",
"ref": "531398c29968420548e8bc26"
},
"updated": 1778496317627,
"status": "example",
"discogsStatus": "example",
"buyerWasContacted": true,
"unreadMessagesCount": 42,
"mergeableOrders": [
{
"_id": "d060604555269c0fca575ba2",
"id": "example",
"created": 1755820256749,
"total": 29.99,
"description": "example"
}
],
"path": "/release/1763553751/release-artist-release-name"
}
}
Arguments
| Name | Type | Description |
|---|---|---|
orderRef | ID! | Reference ID of the order to cancel. |
note | String | Optional cancellation note added to the order history. |
relist | Boolean | Whether to restore (relist) the stock quantities of the order's items. |
discogsReason | String | Cancellation reason to report to Discogs for marketplace orders. |
refundStatus | String | Refund status to set on the order's billing (e.g. "Refunded", "Partially Refunded"). Ignored when a refund is recorded, which sets the status itself. |
refundAmount | Float | Amount of a refund made outside the platform, recorded with the cancellation. Capped at what is left to refund on the order. |
refundOrigin | String | Payment method the refund recorded with refundAmount was made with (e.g. "cash", "paypal"). |
refundViaProcessor | Boolean | Refunds what is left of every payment taken through a processor that supports it (Stripe, PayPal), through the processor itself, before cancelling the order. If a processor refuses, the order is not cancelled; the refunds made before that are recorded. |
refundReason | RefundReason | Reason given with the refunds made with refundViaProcessor. Stripe records it; PayPal has no reasons and ignores it. |
refundNote | String | Note to the buyer with the refunds made with refundViaProcessor, shown by PayPal (255 characters at most); Stripe keeps it in the refund's metadata. |