Change Status
OAuthScope
ZohoCommerce.salesreturns.CREATE
HTTP Request
POST https://commerce.zoho.com/store/api/v1/salesreturns/{return_id}/status/{return_status}
Attributes
| Attribute | Description |
| salesreturn_id | long: Unique ID generated by the server for the sales return. This is used as identifier. |
| salesreturn_status | string: The current status of the sales return. |
| shipped_status | string: The current status of the package. |
| refund_status | string: The current status of the refund. |
| line_items | list: List of items in a package. Each line item contains salesorder_item_id, item_id, and quantity. |
Statuses
| Status | Description |
| approved | To approve the status of the sales return. |
| declined | To decline the status of the sales return. |
Request Example
Copiedcurl -i -L -X POST
-H "Content-Type:application/json"
-H "Authorization:Zoho-oauthtoken ***"
-H "X-com-zoho-store-organizationid:58927961"
'https://commerce.zoho.com/store/api/v1/salesreturns/51128000000125025/status/declined'Success Response
Copied{
"code": 0,
"message": "Status Changed Successfully",
"salesreturn":{
"salesreturn_id": "51128000000125025",
"salesreturn_number": "RET-00003",
"reason": "asdasdsad",
"date": "2019-09-30",
"total": 10,
"refunded_amount": 0,
"salesreturn_status": "declined",
"salesreturn_type": "return_refund",
"return_type": "return_refund",
"refund_status": "",
"receive_status": "",
"discount": 0,
"line_items":[
{
"item_id": "51128000000102130",
"line_item_id": "51128000000125033",
"salesorder_item_id": "51128000000118035",
…}
],
"salesreturnreceives":[],
"creditnotes":[],
"salesorders":[
{
"salesorder_id": "51128000000118027",
"salesorder_number": "SO-00009",
"salesorder_order_status": "",
"date": "2019-09-30",
…}
],
"salesorder_id": "51128000000118027",
"salesorder_number": "SO-00009"
}Show full
Show less
Failure Response
Copied{
"code": 1002,
"message": "Resource does not exist."
}