Refunds allow you to return the money to the customer of the items.
Value | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
order_id Type: string Required | This field stores the id of the order.
| ||||||||||||
rma_number Type: string | It stores the RMA number for the return order.
| ||||||||||||
refund_type Type: string Required | This field stores the type of the refund. The value of this field can be Full and Partial.
| ||||||||||||
items Type: array Required | Array of objects containing the details of items at the time of refund.
| ||||||||||||
seller_id Type: string | It stores the id of the seller of the product. | ||||||||||||
refund_shipping_charges Type: string | Enable the field, if you want to refund the shipping charges.
| ||||||||||||
rma_id Type: string | It stores the id of RMA for the refund of order. | ||||||||||||
mode Type: string Required | It stores the mode through which the amount will be refunded. | ||||||||||||
wallet Type: string Required | It stores the type of wallet when the mode of refund is wallet. The wallets can be StoreCredit or Loyalty wallet. | ||||||||||||
other Type: string Required | It stores the other offline method when the mode of refund is other. | ||||||||||||
note Type: string | A text field which takes a reason for doing the refund. | ||||||||||||
restock Type: string | Enabling the flag update the inventory. | ||||||||||||
transaction_info Type: object | It stores the details of the transaction.
| ||||||||||||
amount_refunded Type: string | It stores the amount for the refund. | ||||||||||||
created_on Type: string | It stores the date and time at which the refund process was created. |