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
) {
  orderCancel(
    orderRef: $orderRef
    note: $note
    relist: $relist
    discogsReason: $discogsReason
    refundStatus: $refundStatus
  ) {
    _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": "3cdcb941bea72430eb7cb7bb",
    "note": "note",
    "relist": true,
    "discogsReason": "discogsReason",
    "refundStatus": "refundStatus"
}

Response

{
    "orderCancel": {
        "_id": "645ceb200ee3b324deea87ca",
        "id": "example",
        "incId": 42,
        "origin": "example",
        "created": 1746768397085,
        "modified": 1756548242872,
        "shipping": {
            "status": "Pending",
            "fulfilled": true,
            "date": 1739675829780,
            "method": "example",
            "freeShippingThreshold": 1.23,
            "tracking": "example",
            "shopCollection": true,
            "weight": 1.23,
            "packingSlip": "example"
        },
        "billing": {
            "status": "example",
            "fulfilled": true,
            "paymentDate": 1761435797658,
            "refundDate": 1767949864378
        },
        "orderId": "example",
        "notes": [
            {
                "date": 1754428730003,
                "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": "d298c413f6afaaca9949e028",
                "quantity": 1,
                "unavailable": true,
                "added": 1747233942242
            }
        ],
        "messages": [
            {
                "_id": "75d7f0fc0538e959668a2060",
                "created": 1783461718701,
                "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": "eb350d8e7202f6b98dc8b766",
            "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": 1735546649872,
                "ip": "example"
            }
        ],
        "seller": {
            "type": "example",
            "name": "example",
            "email": "email@example.com",
            "ref": "00f48744357e75fc1573236e"
        },
        "updated": 1747304076376,
        "status": "example",
        "discogsStatus": "example",
        "buyerWasContacted": true,
        "unreadMessagesCount": 42,
        "mergeableOrders": [
            {
                "_id": "0179b21f713dcfc44aa5318b",
                "id": "example",
                "created": 1790124980969,
                "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").

Returns

Order!