Refund a Sales Return
HTTP Request
OAuthScope
ZohoCommerce.salesreturns.CREATE POST https://commerce.zoho.com/store/api/v1/salesreturn/{salesreturn_id}/refund
Query Parameters
| Parameter | Description |
| salesreturn_id | long: Unique ID generated by the server for the sales return. This is used as identifier |
Body Parameters
| Parameter | Description |
| salesreturn_item_id | long: Unique ID generated by the server for the sales return. This is used as identifier. |
| line_items* | list: List of items in a package. Each line item contains salesorder_item_id, item_id, and quantity. |
| amount* | double: Amount to be refunded. |
| quantity | integer: Quantity of the item to be returned. |
| is_returned_to_stock | boolean: Add product to stock. Allowed values are true and false. |
Request Example
Copiedcurl -i -L -X POST
-H "Authorization:Zoho-oauthtoken ***"
-H "X-com-zoho-store-organizationid:58927961"
-H "Content-Type:application/json"
-d
'{"amount":1,
"line_items":[
{"salesreturn_item_id":"51128000000125164",
"quantity":1,
"is_returned_to_stock":true
}
]
}'
'https://commerce.zoho.com/store/api/v1/salesreturns/51128000000125156/refund'Success Response
Copied{
"code": 0,
"message": "Refund created successfully",
"salesreturns": {
"refund_id": "51128000000125239",
"refund_date": "2019-10-01",
"amount": 1.00,
"salesreturn_number": "RET-00004",
"refund_type": "order_refund"
}
}HTTP Request
OAuthScope
ZohoCommerce.salesreturns.CREATE
POST https://commerce.zoho.com/store/api/v1/salesreturn/{salesreturn_id}/refund