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!
) {
  orderAddRefundMethod(
    orderRef: $orderRef
    orderPaymentMethodInput: $orderPaymentMethodInput
  ) {
    _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
      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": "46dea40aa1102b5e3a23b8c9",
    "orderPaymentMethodInput": {
        "origin": "origin",
        "amount": 29.99,
        "ref": "954e461774755d6254a54d7d",
        "added": 1735398813512
    }
}

Response

{
    "orderAddRefundMethod": {
        "_id": "4eac8c8900fba816af17dc67",
        "id": "example",
        "incId": 42,
        "origin": "example",
        "created": 1736546820602,
        "modified": 1744934466812,
        "shipping": {
            "status": "Pending",
            "fulfilled": true,
            "date": 1725827367237,
            "method": "example",
            "freeShippingThreshold": 1.23,
            "tracking": "example",
            "shopCollection": true,
            "weight": 1.23,
            "packingSlip": "example"
        },
        "billing": {
            "status": "example",
            "fulfilled": true,
            "paymentDate": 1743453830897,
            "refundDate": 1761064040105
        },
        "orderId": "example",
        "notes": [
            {
                "date": 1726847636917,
                "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": "3de20a4ced104907aca9fb0d",
                "quantity": 1,
                "unavailable": true,
                "added": 1743231185325
            }
        ],
        "messages": [
            {
                "_id": "67ac6ad66d6f9c8babf82968",
                "created": 1724814829904,
                "subject": "example",
                "message": "example",
                "fromBuyer": true,
                "flagged": 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": "61311f8d74ac2564ff7bb25c",
            "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": 1745892887623,
                "ip": "example"
            }
        ],
        "seller": {
            "type": "example",
            "name": "example",
            "email": "email@example.com",
            "ref": "5a8d7c1ab95438a51f498bed"
        },
        "updated": 1746772256825,
        "status": "example",
        "discogsStatus": "example",
        "buyerWasContacted": true,
        "unreadMessagesCount": 42,
        "mergeableOrders": [
            {
                "_id": "b9476810c94a318816904f7e",
                "id": "example",
                "created": 1728175088588,
                "total": 29.99,
                "description": "example"
            }
        ],
        "path": "/release/1763553751/release-artist-release-name"
    }
}

Arguments

Name	Type	Description
orderRef	ID!	Reference ID of the order to add a refund method to.
orderPaymentMethodInput	OrderPaymentMethodInput!	Refund method details including origin, amount, optional reference, and date.

Returns

Order!