Introduction

Overview Authentication Request Response

API Reference

Refunds

(ms.refunds)

Refunds allow you to return the money to the customer of the items.

Fields
EndPoints

Fields

Value Description
order_id   
Type: string
Required
This field stores the id of the order.
OID-243
rma_number   
Type: string
It stores the RMA number for the return order.
RMA2
refund_type   
Type: string
Required
This field stores the type of the refund. The value of this field can be Full and Partial.
full
items   
Type: array
Required
Array of objects containing the details of items at the time of refund.
_id
Type: string
It contains the product id.
name
Type: string
It contains the name of the product.
sku
Type: string
It contains the SKU of the product.
quantity
Type: integer
Required
It contains the weight of the product.
price
Type: string
It contains the the price of the product.
total
Type: integer
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.
1
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
Type: string
It stores the amount processed for the transaction.
payment_gateway
Type: string
It stores the payment gateway through which the transaction is processed.
status
Type: string
It stores the status of the transaction.
currency
Type: string
It stores the currency used in the transaction.
txn_id
Type: string
It stores the id 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.

Commands (Endpoints)

POST /api/1/entity/ms.refunds   
Creates a new refund
DEL /api/1/entity/ms.refunds/{resource_id}   
Deletes a refund
PUT /api/1/entity/ms.refunds/{resource_id}   
Updates an existing refund
GET /api/1/entity/ms.refunds/{resource_id}   
Retrieves a single refund
GET /api/1/entity/ms.refunds   
Retrieves a list of refunds