Refund

The refund node

Method	Type	Description
id	ID!
order	OrderNode
orderItem	OrderItemNode
isCash	Boolean
reason	String!
createdAt	DateTime!
pk	Int

Refund order

RequestVariablesResponse

mutation (
  $orderId: ID!
  $amount: Decimal
  $amountCurrency: String
  $reason: String
){
  createOrderRefund(
    input: {
      orderId: $orderId
      amount: $amount
      amountCurrency: $amountCurrency
      reason: $reason
    }
  ) {
    errors
    success
    refund {
      id
    }
  }
}

{
  "orderId": "19220112164",
  "reason": "Reason for refund"
}

{
    "data": {
        "createOrderRefund": {
            "success": true,
            "errors": null,
            "refund": {
              "id": "U3RvcmVOb2RlOjE5"
            }
        }
    }
}

Partial refund

RequestVariablesResponse

mutation (
  $orderId: ID!
  $amount: Decimal
  $amountCurrency: String
  $reason: String
){
  createOrderRefund(
    input: {
      orderId: $orderId
      amount: $amount
      amountCurrency: $amountCurrency
      reason: $reason
    }
  ) {
    errors
    success
    refund {
      id
    }
  }
}

{
  "orderId": "19220112164",
  "amount": "10.00",
  "amountCurrency": "USD",
  "reason": "Reason for refund"
}

{
    "data": {
        "createOrderRefund": {
            "success": true,
            "errors": null,
            "refund": {
              "id": "U3RvcmVOb2RlOjE5"
            }
        }
    }
}

Refund order items

RequestVariablesResponse

mutation (
  $orderItems: [OrderItemRefundInput]!
){
  createOrderItemsRefund(
    input: {
      orderItems: $orderItems
    }
  ) {
    errors
    success
    refunds {
      id
    }
  }
}

{
  "orderItems": [
    { "orderItemId": 45, "reason": "some reason" },
    { "orderItemId": 46 }
  ]
}

{
    "data": {
        "createOrderItemsRefund": {
            "success": true,
            "errors": null,
            "refund": [
              {
                "id": "U3RvcmVOb2RlOjE5"
              },
              {
                "id": "U8YfghVOb2HkOjB9"
              }
            ]
        }
    }
}

Cash refund

Setting isCash to true will make all the previously mentioned scenarios to cash refunds.

RequestVariablesResponse

mutation (
  $orderItems: [OrderItemRefundInput]!
  $isCash: Boolean
){
  createOrderItemsRefund(
    input: {
      orderItems: $orderItems
      isCash: $isCash
    }
  ) {
    errors
    success
    refunds {
      id
    }
  }
}

{
  "orderItems": [
    { "orderItemId": 45, "reason": "some reason" },
    { "orderItemId": 46 }
  ],
  "isCash": true
}

{
    "data": {
        "createOrderItemsRefund": {
            "success": true,
            "errors": null,
            "refund": [
              {
                "id": "U3RvcmVOb2RlOjE5"
              },
              {
                "id": "U8YfghVOb2HkOjB9"
              }
            ]
        }
    }
}