Skip to main content

batchRefundInput

Input for refund processing, used to submit a batch refund request.

input batchRefundInput {
  orderId: Int!
  reasonId: Int!
  fees: [batchRefundFeeInput]
  externalReference: String
  rows: [batchRefundRowInput]
}

Fields​

orderId ● Int!​

ID of original order

reasonId ● Int!​

Reason for the refund.

fees ● [batchRefundFeeInput]​

Fees of the transaction to be refunded, such as delivery fee, return fee, etc.

externalReference ● String​

External reference for the refund

rows ● [batchRefundRowInput]​

Rows to be refunded.

Example​

{
  "orderId": 10341,
  "reasonId": 2,
  "fees": [
    {
      "type": "DELIVERY",
      "amount": 10
    }
  ],
  "externalReference": "OR-2356",
  "rows": [
    {
      "orderRowId": 210033,
      "quantity": 2
    }
  ]
}